Fawkes API  Fawkes Development Version
Public Member Functions | Static Public Member Functions | List of all members
TransformsGraph Class Reference

TransformsGraph representation for JSON transfer. More...

#include <TransformsGraph.h>

Public Member Functions

 TransformsGraph ()
 Constructor. More...
 
 TransformsGraph (const std::string &json)
 Constructor from JSON. More...
 
 TransformsGraph (const rapidjson::Value &v)
 Constructor from JSON. More...
 
virtual std::string to_json (bool pretty=false) const
 Render object to JSON. More...
 
virtual void to_json_value (rapidjson::Document &d, rapidjson::Value &v) const
 Render object to JSON. More...
 
virtual void from_json (const std::string &json)
 Retrieve data from JSON string. More...
 
virtual void from_json_value (const rapidjson::Value &v)
 Retrieve data from JSON string. More...
 
virtual void validate (bool subcall=false) const
 Validate if all required fields have been set. More...
 
std::optional< std::string > kind () const
 Get kind value. More...
 
void set_kind (const std::string &kind)
 Set kind value. More...
 
std::optional< std::string > apiVersion () const
 Get apiVersion value. More...
 
void set_apiVersion (const std::string &apiVersion)
 Set apiVersion value. More...
 
std::optional< std::string > dotgraph () const
 Get dotgraph value. More...
 
void set_dotgraph (const std::string &dotgraph)
 Set dotgraph value. More...
 

Static Public Member Functions

static std::string api_version ()
 Get version of implemented API. More...
 

Detailed Description

TransformsGraph representation for JSON transfer.

Definition at line 26 of file TransformsGraph.h.

Constructor & Destructor Documentation

◆ TransformsGraph() [1/3]

TransformsGraph::TransformsGraph ( )

Constructor.

Definition at line 23 of file TransformsGraph.cpp.

◆ TransformsGraph() [2/3]

TransformsGraph::TransformsGraph ( const std::string &  json)

Constructor from JSON.

Parameters
jsonJSON string to initialize from

Definition at line 27 of file TransformsGraph.cpp.

References from_json().

◆ TransformsGraph() [3/3]

TransformsGraph::TransformsGraph ( const rapidjson::Value &  v)

Constructor from JSON.

Parameters
vRapidJSON value object to initialize from.

Definition at line 32 of file TransformsGraph.cpp.

References from_json_value().

Member Function Documentation

◆ api_version()

static std::string TransformsGraph::api_version ( )
inlinestatic

Get version of implemented API.

Returns
string representation of version

Definition at line 45 of file TransformsGraph.h.

◆ apiVersion()

std::optional<std::string> TransformsGraph::apiVersion ( ) const
inline

Get apiVersion value.

Returns
apiVersion value

Definition at line 106 of file TransformsGraph.h.

Referenced by set_apiVersion().

◆ dotgraph()

std::optional<std::string> TransformsGraph::dotgraph ( ) const
inline

Get dotgraph value.

Returns
dotgraph value

Definition at line 123 of file TransformsGraph.h.

Referenced by set_dotgraph().

◆ from_json()

void TransformsGraph::from_json ( const std::string &  json)
virtual

Retrieve data from JSON string.

Parameters
jsonJSON representation suitable for this object. Will allow partial assignment and not validate automaticaly.
See also
validate()

Definition at line 82 of file TransformsGraph.cpp.

References from_json_value().

Referenced by TransformsGraph().

◆ from_json_value()

void TransformsGraph::from_json_value ( const rapidjson::Value &  v)
virtual

Retrieve data from JSON string.

Parameters
vRapidJSON value suitable for this object. Will allow partial assignment and not validate automaticaly.
See also
validate()

Definition at line 91 of file TransformsGraph.cpp.

Referenced by from_json(), and TransformsGraph().

◆ kind()

std::optional<std::string> TransformsGraph::kind ( ) const
inline

Get kind value.

Returns
kind value

Definition at line 89 of file TransformsGraph.h.

Referenced by set_kind().

◆ set_apiVersion()

void TransformsGraph::set_apiVersion ( const std::string &  apiVersion)
inline

Set apiVersion value.

Parameters
apiVersionnew value

Definition at line 115 of file TransformsGraph.h.

References apiVersion().

◆ set_dotgraph()

void TransformsGraph::set_dotgraph ( const std::string &  dotgraph)
inline

Set dotgraph value.

Parameters
dotgraphnew value

Definition at line 132 of file TransformsGraph.h.

References dotgraph().

◆ set_kind()

void TransformsGraph::set_kind ( const std::string &  kind)
inline

Set kind value.

Parameters
kindnew value

Definition at line 98 of file TransformsGraph.h.

References kind().

◆ to_json()

std::string TransformsGraph::to_json ( bool  pretty = false) const
virtual

Render object to JSON.

Parameters
prettytrue to enable pretty printing (readable spacing)
Returns
JSON string

Definition at line 38 of file TransformsGraph.cpp.

References to_json_value().

◆ to_json_value()

void TransformsGraph::to_json_value ( rapidjson::Document &  d,
rapidjson::Value &  v 
) const
virtual

Render object to JSON.

Parameters
dRapidJSON document to retrieve allocator from
vRapidJSON value to add data to

Definition at line 57 of file TransformsGraph.cpp.

Referenced by to_json().

◆ validate()

void TransformsGraph::validate ( bool  subcall = false) const
virtual

Validate if all required fields have been set.

Parameters
subcalltrue if this is called from another class, e.g., a sub-class or array holder. Will modify the kind of exception thrown.
Exceptions
std::vector<std::string>thrown if required information is missing and subcall is set to true. Contains a list of missing fields.
std::runtime_errorinformative message describing the missing fields

Definition at line 105 of file TransformsGraph.cpp.

The documentation for this class was generated from the following files: