Fawkes API
Fawkes Development Version
|
DomainEffect representation for JSON transfer. More...
#include <DomainEffect.h>
Public Member Functions | |
DomainEffect () | |
Constructor. More... | |
DomainEffect (const std::string &json) | |
Constructor from JSON. More... | |
DomainEffect (const rapidjson::Value &v) | |
Constructor from JSON. More... | |
virtual | ~DomainEffect () |
Destructor. 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 > | name () const |
Get name value. More... | |
void | set_name (const std::string &name) |
Set name value. More... | |
std::optional< std::string > | type () const |
Get type value. More... | |
void | set_type (const std::string &type) |
Set type value. More... | |
std::optional< std::string > | predicate () const |
Get predicate value. More... | |
void | set_predicate (const std::string &predicate) |
Set predicate value. More... | |
std::vector< std::string > | param_names () const |
Get param-names value. More... | |
void | set_param_names (const std::vector< std::string > ¶m_names) |
Set param-names value. More... | |
void | addto_param_names (const std::string &¶m_names) |
Add element to param-names array. More... | |
void | addto_param_names (const std::string ¶m_names) |
Add element to param-names array. More... | |
std::vector< std::string > | param_values () const |
Get param-values value. More... | |
void | set_param_values (const std::vector< std::string > ¶m_values) |
Set param-values value. More... | |
void | addto_param_values (const std::string &¶m_values) |
Add element to param-values array. More... | |
void | addto_param_values (const std::string ¶m_values) |
Add element to param-values array. More... | |
std::vector< std::string > | param_constants () const |
Get param-constants value. More... | |
void | set_param_constants (const std::vector< std::string > ¶m_constants) |
Set param-constants value. More... | |
void | addto_param_constants (const std::string &¶m_constants) |
Add element to param-constants array. More... | |
void | addto_param_constants (const std::string ¶m_constants) |
Add element to param-constants array. More... | |
Static Public Member Functions | |
static std::string | api_version () |
Get version of implemented API. More... | |
DomainEffect representation for JSON transfer.
Definition at line 27 of file DomainEffect.h.
DomainEffect::DomainEffect | ( | ) |
Constructor.
Definition at line 24 of file DomainEffect.cpp.
DomainEffect::DomainEffect | ( | const std::string & | json | ) |
Constructor from JSON.
json | JSON string to initialize from |
Definition at line 28 of file DomainEffect.cpp.
References from_json().
DomainEffect::DomainEffect | ( | const rapidjson::Value & | v | ) |
Constructor from JSON.
v | RapidJSON value object to initialize from. |
Definition at line 33 of file DomainEffect.cpp.
References from_json_value().
|
virtual |
Destructor.
Definition at line 38 of file DomainEffect.cpp.
|
inline |
Add element to param-constants array.
param_constants | new value |
Definition at line 264 of file DomainEffect.h.
References param_constants().
|
inline |
Add element to param-constants array.
The move-semantics version (std::move) should be preferred.
param_constants | new value |
Definition at line 274 of file DomainEffect.h.
References param_constants().
|
inline |
Add element to param-names array.
param_names | new value |
Definition at line 194 of file DomainEffect.h.
References param_names().
|
inline |
Add element to param-names array.
The move-semantics version (std::move) should be preferred.
param_names | new value |
Definition at line 204 of file DomainEffect.h.
References param_names().
|
inline |
Add element to param-values array.
param_values | new value |
Definition at line 229 of file DomainEffect.h.
References param_values().
|
inline |
Add element to param-values array.
The move-semantics version (std::move) should be preferred.
param_values | new value |
Definition at line 239 of file DomainEffect.h.
References param_values().
|
inlinestatic |
Get version of implemented API.
Definition at line 48 of file DomainEffect.h.
|
inline |
Get apiVersion value.
Definition at line 109 of file DomainEffect.h.
Referenced by set_apiVersion().
|
virtual |
Retrieve data from JSON string.
json | JSON representation suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 121 of file DomainEffect.cpp.
References from_json_value().
Referenced by DomainEffect().
|
virtual |
Retrieve data from JSON string.
v | RapidJSON value suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 130 of file DomainEffect.cpp.
Referenced by DomainEffect(), from_json(), and PlanAction::from_json_value().
|
inline |
Get kind value.
Definition at line 92 of file DomainEffect.h.
Referenced by set_kind().
|
inline |
Get name value.
Definition at line 126 of file DomainEffect.h.
Referenced by set_name().
|
inline |
Get param-constants value.
Definition at line 247 of file DomainEffect.h.
Referenced by addto_param_constants(), and set_param_constants().
|
inline |
Get param-names value.
Definition at line 177 of file DomainEffect.h.
Referenced by addto_param_names(), and set_param_names().
|
inline |
Get param-values value.
Definition at line 212 of file DomainEffect.h.
Referenced by addto_param_values(), and set_param_values().
|
inline |
Get predicate value.
Definition at line 160 of file DomainEffect.h.
Referenced by set_predicate().
|
inline |
Set apiVersion value.
apiVersion | new value |
Definition at line 118 of file DomainEffect.h.
References apiVersion().
|
inline |
Set kind value.
kind | new value |
Definition at line 101 of file DomainEffect.h.
References kind().
|
inline |
Set name value.
name | new value |
Definition at line 135 of file DomainEffect.h.
References name().
|
inline |
Set param-constants value.
param_constants | new value |
Definition at line 256 of file DomainEffect.h.
References param_constants().
|
inline |
Set param-names value.
param_names | new value |
Definition at line 186 of file DomainEffect.h.
References param_names().
|
inline |
Set param-values value.
param_values | new value |
Definition at line 221 of file DomainEffect.h.
References param_values().
|
inline |
Set predicate value.
predicate | new value |
Definition at line 169 of file DomainEffect.h.
References predicate().
|
inline |
Set type value.
type | new value |
Definition at line 152 of file DomainEffect.h.
References type().
|
virtual |
Render object to JSON.
pretty | true to enable pretty printing (readable spacing) |
Definition at line 43 of file DomainEffect.cpp.
References to_json_value().
|
virtual |
Render object to JSON.
d | RapidJSON document to retrieve allocator from |
v | RapidJSON value to add data to |
Definition at line 62 of file DomainEffect.cpp.
Referenced by to_json().
|
inline |
Get type value.
Definition at line 143 of file DomainEffect.h.
Referenced by set_type().
|
virtual |
Validate if all required fields have been set.
subcall | true if this is called from another class, e.g., a sub-class or array holder. Will modify the kind of exception thrown. |
std::vector<std::string> | thrown if required information is missing and subcall is set to true. Contains a list of missing fields. |
std::runtime_error | informative message describing the missing fields |
Definition at line 177 of file DomainEffect.cpp.