Fawkes API  Fawkes Development Version
DomainOperator Class Reference

DomainOperator representation for JSON transfer. More...

#include <DomainOperator.h>

Public Member Functions

 DomainOperator ()
 Constructor. More...
 
 DomainOperator (const std::string &json)
 Constructor from JSON. More...
 
 DomainOperator (const rapidjson::Value &v)
 Constructor from JSON. More...
 
virtual ~DomainOperator ()
 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< bool > wait_sensed () const
 Get wait-sensed value. More...
 
void set_wait_sensed (const bool &wait_sensed)
 Set wait-sensed value. More...
 
std::vector< std::shared_ptr< DomainOperatorParameter > > parameters () const
 Get parameters value. More...
 
void set_parameters (const std::vector< std::shared_ptr< DomainOperatorParameter >> &parameters)
 Set parameters value. More...
 
void addto_parameters (const std::shared_ptr< DomainOperatorParameter > &&parameters)
 Add element to parameters array. More...
 
void addto_parameters (const std::shared_ptr< DomainOperatorParameter > &parameters)
 Add element to parameters array. More...
 
void addto_parameters (const DomainOperatorParameter &&parameters)
 Add element to parameters array. More...
 

Static Public Member Functions

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

Detailed Description

DomainOperator representation for JSON transfer.

Definition at line 28 of file DomainOperator.h.

Constructor & Destructor Documentation

◆ DomainOperator() [1/3]

DomainOperator::DomainOperator ( )

Constructor.

Definition at line 23 of file DomainOperator.cpp.

◆ DomainOperator() [2/3]

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

Constructor from JSON.

Parameters
jsonJSON string to initialize from

Definition at line 27 of file DomainOperator.cpp.

References from_json().

◆ DomainOperator() [3/3]

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

Constructor from JSON.

Parameters
vRapidJSON value object to initialize from.

Definition at line 32 of file DomainOperator.cpp.

References from_json_value().

◆ ~DomainOperator()

DomainOperator::~DomainOperator ( )
virtual

Destructor.

Definition at line 37 of file DomainOperator.cpp.

Member Function Documentation

◆ addto_parameters() [1/3]

void DomainOperator::addto_parameters ( const std::shared_ptr< DomainOperatorParameter > &&  parameters)
inline

Add element to parameters array.

Parameters
parametersnew value

Definition at line 179 of file DomainOperator.h.

References parameters().

◆ addto_parameters() [2/3]

void DomainOperator::addto_parameters ( const std::shared_ptr< DomainOperatorParameter > &  parameters)
inline

Add element to parameters array.

The move-semantics version (std::move) should be preferred.

Parameters
parametersnew value

Definition at line 189 of file DomainOperator.h.

References parameters().

◆ addto_parameters() [3/3]

void DomainOperator::addto_parameters ( const DomainOperatorParameter &&  parameters)
inline

Add element to parameters array.

Parameters
parametersnew value

Definition at line 197 of file DomainOperator.h.

References parameters().

◆ api_version()

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

Get version of implemented API.

Returns
string representation of version

Definition at line 50 of file DomainOperator.h.

◆ apiVersion()

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

Get apiVersion value.

Returns
apiVersion value

Definition at line 111 of file DomainOperator.h.

Referenced by set_apiVersion().

◆ from_json()

void DomainOperator::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 99 of file DomainOperator.cpp.

References from_json_value().

Referenced by DomainOperator().

◆ from_json_value()

void DomainOperator::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 108 of file DomainOperator.cpp.

References DomainOperatorParameter::from_json_value().

Referenced by DomainOperator(), and from_json().

◆ kind()

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

Get kind value.

Returns
kind value

Definition at line 94 of file DomainOperator.h.

Referenced by set_kind().

◆ name()

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

Get name value.

Returns
name value

Definition at line 128 of file DomainOperator.h.

Referenced by set_name().

◆ parameters()

std::vector<std::shared_ptr<DomainOperatorParameter> > DomainOperator::parameters ( ) const
inline

Get parameters value.

Returns
parameters value

Definition at line 162 of file DomainOperator.h.

Referenced by addto_parameters(), and set_parameters().

◆ set_apiVersion()

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

Set apiVersion value.

Parameters
apiVersionnew value

Definition at line 120 of file DomainOperator.h.

References apiVersion().

◆ set_kind()

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

Set kind value.

Parameters
kindnew value

Definition at line 103 of file DomainOperator.h.

References kind().

◆ set_name()

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

Set name value.

Parameters
namenew value

Definition at line 137 of file DomainOperator.h.

References name().

◆ set_parameters()

void DomainOperator::set_parameters ( const std::vector< std::shared_ptr< DomainOperatorParameter >> &  parameters)
inline

Set parameters value.

Parameters
parametersnew value

Definition at line 171 of file DomainOperator.h.

References parameters().

◆ set_wait_sensed()

void DomainOperator::set_wait_sensed ( const bool &  wait_sensed)
inline

Set wait-sensed value.

Parameters
wait_sensednew value

Definition at line 154 of file DomainOperator.h.

References wait_sensed().

◆ to_json()

std::string DomainOperator::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 42 of file DomainOperator.cpp.

References to_json_value().

◆ to_json_value()

void DomainOperator::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 61 of file DomainOperator.cpp.

Referenced by to_json().

◆ validate()

void DomainOperator::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 136 of file DomainOperator.cpp.

◆ wait_sensed()

std::optional<bool> DomainOperator::wait_sensed ( ) const
inline

Get wait-sensed value.

Returns
wait-sensed value

Definition at line 145 of file DomainOperator.h.

Referenced by set_wait_sensed().


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