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

SkillInfo representation for JSON transfer. More...

#include <SkillInfo.h>

Public Member Functions

 SkillInfo ()
 Constructor. More...
 
 SkillInfo (const std::string &json)
 Constructor from JSON. More...
 
 SkillInfo (const rapidjson::Value &v)
 Constructor from JSON. More...
 
virtual ~SkillInfo ()
 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...
 

Static Public Member Functions

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

Detailed Description

SkillInfo representation for JSON transfer.

Definition at line 27 of file SkillInfo.h.

Constructor & Destructor Documentation

◆ SkillInfo() [1/3]

SkillInfo::SkillInfo ( )

Constructor.

Definition at line 24 of file SkillInfo.cpp.

◆ SkillInfo() [2/3]

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

Constructor from JSON.

Parameters
jsonJSON string to initialize from

Definition at line 28 of file SkillInfo.cpp.

References from_json().

◆ SkillInfo() [3/3]

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

Constructor from JSON.

Parameters
vRapidJSON value object to initialize from.

Definition at line 33 of file SkillInfo.cpp.

References from_json_value().

◆ ~SkillInfo()

SkillInfo::~SkillInfo ( )
virtual

Destructor.

Definition at line 38 of file SkillInfo.cpp.

Member Function Documentation

◆ api_version()

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

Get version of implemented API.

Returns
string representation of version

Definition at line 49 of file SkillInfo.h.

◆ apiVersion()

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

Get apiVersion value.

Returns
apiVersion value

Definition at line 110 of file SkillInfo.h.

Referenced by set_apiVersion().

◆ from_json()

void SkillInfo::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 87 of file SkillInfo.cpp.

References from_json_value().

Referenced by SkillInfo().

◆ from_json_value()

void SkillInfo::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 96 of file SkillInfo.cpp.

Referenced by from_json(), and SkillInfo().

◆ kind()

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

Get kind value.

Returns
kind value

Definition at line 93 of file SkillInfo.h.

Referenced by set_kind().

◆ name()

std::optional<std::string> SkillInfo::name ( ) const
inline

Get name value.

Returns
name value

Definition at line 127 of file SkillInfo.h.

Referenced by set_name().

◆ set_apiVersion()

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

Set apiVersion value.

Parameters
apiVersionnew value

Definition at line 119 of file SkillInfo.h.

References apiVersion().

◆ set_kind()

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

Set kind value.

Parameters
kindnew value

Definition at line 102 of file SkillInfo.h.

References kind().

◆ set_name()

void SkillInfo::set_name ( const std::string &  name)
inline

Set name value.

Parameters
namenew value

Definition at line 136 of file SkillInfo.h.

References name().

◆ to_json()

std::string SkillInfo::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 43 of file SkillInfo.cpp.

References to_json_value().

◆ to_json_value()

void SkillInfo::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 62 of file SkillInfo.cpp.

Referenced by to_json().

◆ validate()

void SkillInfo::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 110 of file SkillInfo.cpp.

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