Fawkes API
Fawkes Development Version
|
Backend representation for JSON transfer. More...
#include <Backend.h>
Public Member Functions | |
Backend () | |
Constructor. More... | |
Backend (const std::string &json) | |
Constructor from JSON. More... | |
Backend (const rapidjson::Value &v) | |
Constructor from JSON. More... | |
virtual | ~Backend () |
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 > | name () const |
Get name value. More... | |
void | set_name (const std::string &name) |
Set name value. More... | |
std::optional< std::string > | url () const |
Get url value. More... | |
void | set_url (const std::string &url) |
Set url value. More... | |
std::vector< std::shared_ptr< Service > > | services () const |
Get services value. More... | |
void | set_services (const std::vector< std::shared_ptr< Service >> &services) |
Set services value. More... | |
void | addto_services (const std::shared_ptr< Service > &&services) |
Add element to services array. More... | |
void | addto_services (const std::shared_ptr< Service > &services) |
Add element to services array. More... | |
void | addto_services (const Service &&services) |
Add element to services array. More... | |
Static Public Member Functions | |
static std::string | api_version () |
Get version of implemented API. More... | |
Backend::Backend | ( | ) |
Constructor.
Definition at line 23 of file Backend.cpp.
Backend::Backend | ( | const std::string & | json | ) |
Constructor from JSON.
json | JSON string to initialize from |
Definition at line 27 of file Backend.cpp.
References from_json().
Backend::Backend | ( | const rapidjson::Value & | v | ) |
Constructor from JSON.
v | RapidJSON value object to initialize from. |
Definition at line 32 of file Backend.cpp.
References from_json_value().
|
virtual |
Destructor.
Definition at line 37 of file Backend.cpp.
|
inline |
Add element to services array.
services | new value |
Definition at line 214 of file Backend.h.
References services().
|
inline |
Add element to services array.
services | new value |
Definition at line 196 of file Backend.h.
References services().
Referenced by BackendInfoRestApi::init().
|
inline |
Add element to services array.
The move-semantics version (std::move) should be preferred.
services | new value |
Definition at line 206 of file Backend.h.
References services().
|
inlinestatic |
Get version of implemented API.
Definition at line 50 of file Backend.h.
Referenced by BackendInfoRestApi::init().
|
inline |
Get apiVersion value.
Definition at line 111 of file Backend.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 104 of file Backend.cpp.
References from_json_value().
Referenced by Backend().
|
virtual |
Retrieve data from JSON string.
v | RapidJSON value suitable for this object. Will allow partial assignment and not validate automaticaly. |
Definition at line 113 of file Backend.cpp.
References Service::from_json_value().
Referenced by Backend(), and from_json().
|
inline |
|
inline |
Get kind value.
Definition at line 94 of file Backend.h.
Referenced by set_kind().
|
inline |
Get name value.
Definition at line 145 of file Backend.h.
Referenced by set_name().
|
inline |
Get services value.
Definition at line 179 of file Backend.h.
Referenced by addto_services(), and set_services().
|
inline |
Set apiVersion value.
apiVersion | new value |
Definition at line 120 of file Backend.h.
References apiVersion().
Referenced by BackendInfoRestApi::init().
|
inline |
Set id value.
id | new value |
Definition at line 137 of file Backend.h.
References id().
Referenced by BackendInfoRestApi::init().
|
inline |
Set kind value.
kind | new value |
Definition at line 103 of file Backend.h.
References kind().
Referenced by BackendInfoRestApi::init().
|
inline |
Set name value.
name | new value |
Definition at line 154 of file Backend.h.
References name().
Referenced by BackendInfoRestApi::init().
|
inline |
Set services value.
services | new value |
Definition at line 188 of file Backend.h.
References services().
|
inline |
Set url value.
url | new value |
Definition at line 171 of file Backend.h.
References url().
Referenced by BackendInfoRestApi::init().
|
virtual |
Render object to JSON.
pretty | true to enable pretty printing (readable spacing) |
Definition at line 42 of file Backend.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 Backend.cpp.
Referenced by to_json().
|
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 |
Definition at line 144 of file Backend.cpp.