Fawkes API Fawkes Development Version
|
SlotValue representation for JSON transfer. More...
#include <SlotValue.h>
Public Member Functions | |
SlotValue () | |
Constructor. More... | |
SlotValue (const std::string &json) | |
Constructor from JSON. More... | |
SlotValue (const rapidjson::Value &v) | |
Constructor from JSON. More... | |
virtual | ~SlotValue () |
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 > | 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< bool > | is_multifield () const |
Get is-multifield value. More... | |
void | set_is_multifield (const bool &is_multifield) |
Set is-multifield value. More... | |
std::vector< std::string > | values () const |
Get values value. More... | |
void | set_values (const std::vector< std::string > &values) |
Set values value. More... | |
void | addto_values (const std::string &&values) |
Add element to values array. More... | |
void | addto_values (const std::string &values) |
Add element to values array. More... | |
Static Public Member Functions | |
static std::string | api_version () |
Get version of implemented API. More... | |
SlotValue representation for JSON transfer.
Definition at line 26 of file SlotValue.h.
SlotValue::SlotValue | ( | ) |
Constructor.
Definition at line 23 of file SlotValue.cpp.
SlotValue::SlotValue | ( | const std::string & | json | ) |
Constructor from JSON.
json | JSON string to initialize from |
Definition at line 27 of file SlotValue.cpp.
References from_json().
SlotValue::SlotValue | ( | const rapidjson::Value & | v | ) |
Constructor from JSON.
v | RapidJSON value object to initialize from. |
Definition at line 32 of file SlotValue.cpp.
References from_json_value().
|
virtual |
Destructor.
Definition at line 37 of file SlotValue.cpp.
|
inline |
Add element to values array.
values | new value |
Definition at line 160 of file SlotValue.h.
References values().
|
inline |
Add element to values array.
The move-semantics version (std::move) should be preferred.
values | new value |
Definition at line 170 of file SlotValue.h.
References values().
|
inlinestatic |
Get version of implemented API.
Definition at line 48 of file SlotValue.h.
|
virtual |
Retrieve data from JSON string.
json | JSON representation suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 94 of file SlotValue.cpp.
References from_json_value().
Referenced by SlotValue().
|
virtual |
Retrieve data from JSON string.
v | RapidJSON value suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 103 of file SlotValue.cpp.
Referenced by from_json(), Fact::from_json_value(), and SlotValue().
|
inline |
Get is-multifield value.
Definition at line 126 of file SlotValue.h.
Referenced by set_is_multifield().
|
inline |
Get name value.
Definition at line 92 of file SlotValue.h.
Referenced by set_name().
|
inline |
Set is-multifield value.
is_multifield | new value |
Definition at line 135 of file SlotValue.h.
References is_multifield().
|
inline |
Set name value.
name | new value |
Definition at line 101 of file SlotValue.h.
References name().
|
inline |
Set type value.
type | new value |
Definition at line 118 of file SlotValue.h.
References type().
|
inline |
Set values value.
values | new value |
Definition at line 152 of file SlotValue.h.
References values().
|
virtual |
Render object to JSON.
pretty | true to enable pretty printing (readable spacing) |
Definition at line 42 of file SlotValue.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 61 of file SlotValue.cpp.
Referenced by to_json().
|
inline |
Get type value.
Definition at line 109 of file SlotValue.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 126 of file SlotValue.cpp.
|
inline |
Get values value.
Definition at line 143 of file SlotValue.h.
Referenced by addto_values(), and set_values().