Fawkes API
Fawkes Development Version
|
Goal representation for JSON transfer. More...
#include <Goal.h>
Public Member Functions | |
Goal () | |
Constructor. More... | |
Goal (const std::string &json) | |
Constructor from JSON. More... | |
Goal (const rapidjson::Value &v) | |
Constructor from JSON. More... | |
virtual | ~Goal () |
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 > | id () const |
Get id value. More... | |
void | set_id (const std::string &id) |
Set id 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 > | sub_type () const |
Get sub-type value. More... | |
void | set_sub_type (const std::string &sub_type) |
Set sub-type value. More... | |
std::optional< std::string > | _class () const |
Get class value. More... | |
void | set__class (const std::string &_class) |
Set class value. More... | |
std::optional< std::string > | mode () const |
Get mode value. More... | |
void | set_mode (const std::string &mode) |
Set mode value. More... | |
std::optional< std::string > | outcome () const |
Get outcome value. More... | |
void | set_outcome (const std::string &outcome) |
Set outcome value. More... | |
std::vector< std::string > | error () const |
Get error value. More... | |
void | set_error (const std::vector< std::string > &error) |
Set error value. More... | |
void | addto_error (const std::string &&error) |
Add element to error array. More... | |
void | addto_error (const std::string &error) |
Add element to error array. More... | |
std::optional< std::string > | message () const |
Get message value. More... | |
void | set_message (const std::string &message) |
Set message value. More... | |
std::optional< std::string > | parent () const |
Get parent value. More... | |
void | set_parent (const std::string &parent) |
Set parent value. More... | |
std::optional< int64_t > | priority () const |
Get priority value. More... | |
void | set_priority (const int64_t &priority) |
Set priority value. More... | |
std::vector< std::string > | parameters () const |
Get parameters value. More... | |
void | set_parameters (const std::vector< std::string > ¶meters) |
Set parameters value. More... | |
void | addto_parameters (const std::string &¶meters) |
Add element to parameters array. More... | |
void | addto_parameters (const std::string ¶meters) |
Add element to parameters array. More... | |
std::vector< std::string > | meta () const |
Get meta value. More... | |
void | set_meta (const std::vector< std::string > &meta) |
Set meta value. More... | |
void | addto_meta (const std::string &&meta) |
Add element to meta array. More... | |
void | addto_meta (const std::string &meta) |
Add element to meta array. More... | |
std::vector< std::string > | plans () const |
Get plans value. More... | |
void | set_plans (const std::vector< std::string > &plans) |
Set plans value. More... | |
void | addto_plans (const std::string &&plans) |
Add element to plans array. More... | |
void | addto_plans (const std::string &plans) |
Add element to plans array. More... | |
std::vector< std::string > | required_resources () const |
Get required-resources value. More... | |
void | set_required_resources (const std::vector< std::string > &required_resources) |
Set required-resources value. More... | |
void | addto_required_resources (const std::string &&required_resources) |
Add element to required-resources array. More... | |
void | addto_required_resources (const std::string &required_resources) |
Add element to required-resources array. More... | |
std::vector< std::string > | acquired_resources () const |
Get acquired-resources value. More... | |
void | set_acquired_resources (const std::vector< std::string > &acquired_resources) |
Set acquired-resources value. More... | |
void | addto_acquired_resources (const std::string &&acquired_resources) |
Add element to acquired-resources array. More... | |
void | addto_acquired_resources (const std::string &acquired_resources) |
Add element to acquired-resources array. More... | |
Static Public Member Functions | |
static std::string | api_version () |
Get version of implemented API. More... | |
Goal::Goal | ( | const std::string & | json | ) |
Constructor from JSON.
json | JSON string to initialize from |
Definition at line 26 of file Goal.cpp.
References from_json().
Goal::Goal | ( | const rapidjson::Value & | v | ) |
Constructor from JSON.
v | RapidJSON value object to initialize from. |
Definition at line 31 of file Goal.cpp.
References from_json_value().
|
inline |
Get class value.
Definition at line 176 of file Goal.h.
Referenced by set__class().
|
inline |
Get acquired-resources value.
Definition at line 453 of file Goal.h.
Referenced by addto_acquired_resources(), and set_acquired_resources().
|
inline |
Add element to acquired-resources array.
acquired_resources | new value |
Definition at line 470 of file Goal.h.
References acquired_resources().
|
inline |
Add element to acquired-resources array.
The move-semantics version (std::move) should be preferred.
acquired_resources | new value |
Definition at line 480 of file Goal.h.
References acquired_resources().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Add element to parameters array.
parameters | new value |
Definition at line 330 of file Goal.h.
References parameters().
|
inline |
Add element to parameters array.
The move-semantics version (std::move) should be preferred.
parameters | new value |
Definition at line 340 of file Goal.h.
References parameters().
|
inline |
|
inline |
|
inline |
Add element to required-resources array.
required_resources | new value |
Definition at line 435 of file Goal.h.
References required_resources().
|
inline |
Add element to required-resources array.
The move-semantics version (std::move) should be preferred.
required_resources | new value |
Definition at line 445 of file Goal.h.
References required_resources().
|
inlinestatic |
|
inline |
Get apiVersion value.
Definition at line 108 of file Goal.h.
Referenced by set_apiVersion().
|
inline |
Get error value.
Definition at line 227 of file Goal.h.
Referenced by addto_error(), and set_error().
|
virtual |
Retrieve data from JSON string.
json | JSON representation suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 173 of file Goal.cpp.
References from_json_value().
Referenced by Goal().
|
virtual |
Retrieve data from JSON string.
v | RapidJSON value suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 182 of file Goal.cpp.
Referenced by from_json(), and Goal().
|
inline |
|
inline |
|
inline |
Get message value.
Definition at line 262 of file Goal.h.
Referenced by set_message().
|
inline |
Get meta value.
Definition at line 348 of file Goal.h.
Referenced by addto_meta(), and set_meta().
|
inline |
|
inline |
Get outcome value.
Definition at line 210 of file Goal.h.
Referenced by set_outcome().
|
inline |
Get parameters value.
Definition at line 313 of file Goal.h.
Referenced by addto_parameters(), and set_parameters().
|
inline |
Get parent value.
Definition at line 279 of file Goal.h.
Referenced by set_parent().
|
inline |
Get plans value.
Definition at line 383 of file Goal.h.
Referenced by addto_plans(), and set_plans().
|
inline |
Get priority value.
Definition at line 296 of file Goal.h.
Referenced by set_priority().
|
inline |
Get required-resources value.
Definition at line 418 of file Goal.h.
Referenced by addto_required_resources(), and set_required_resources().
|
inline |
|
inline |
Set acquired-resources value.
acquired_resources | new value |
Definition at line 462 of file Goal.h.
References acquired_resources().
|
inline |
Set apiVersion value.
apiVersion | new value |
Definition at line 117 of file Goal.h.
References apiVersion().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Set parameters value.
parameters | new value |
Definition at line 322 of file Goal.h.
References parameters().
|
inline |
|
inline |
|
inline |
Set priority value.
priority | new value |
Definition at line 305 of file Goal.h.
References priority().
|
inline |
Set required-resources value.
required_resources | new value |
Definition at line 427 of file Goal.h.
References required_resources().
|
inline |
Set sub-type value.
sub_type | new value |
Definition at line 168 of file Goal.h.
References sub_type().
|
inline |
|
inline |
Get sub-type value.
Definition at line 159 of file Goal.h.
Referenced by set_sub_type().
|
virtual |
Render object to JSON.
pretty | true to enable pretty printing (readable spacing) |
Definition at line 41 of file Goal.cpp.
References to_json_value().
|
virtual |
|
inline |
|
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 |