Fawkes API Fawkes Development Version
PDDLFormula Class Reference

PDDLFormula representation for JSON transfer. More...

#include <PDDLFormula.h>

Public Member Functions

 PDDLFormula ()
 Constructor. More...
 
 PDDLFormula (const std::string &json)
 Constructor from JSON. More...
 
 PDDLFormula (const rapidjson::Value &v)
 Constructor from JSON. More...
 
virtual ~PDDLFormula ()
 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 > part_of () const
 Get part-of value. More...
 
void set_part_of (const std::string &part_of)
 Set part-of value. More...
 

Static Public Member Functions

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

Detailed Description

PDDLFormula representation for JSON transfer.

Definition at line 27 of file PDDLFormula.h.

Constructor & Destructor Documentation

◆ PDDLFormula() [1/3]

PDDLFormula::PDDLFormula ( )

Constructor.

Definition at line 24 of file PDDLFormula.cpp.

◆ PDDLFormula() [2/3]

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

Constructor from JSON.

Parameters
jsonJSON string to initialize from

Definition at line 28 of file PDDLFormula.cpp.

References from_json().

◆ PDDLFormula() [3/3]

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

Constructor from JSON.

Parameters
vRapidJSON value object to initialize from.

Definition at line 33 of file PDDLFormula.cpp.

References from_json_value().

◆ ~PDDLFormula()

PDDLFormula::~PDDLFormula ( )
virtual

Destructor.

Definition at line 38 of file PDDLFormula.cpp.

Member Function Documentation

◆ api_version()

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

Get version of implemented API.

Returns
string representation of version

Definition at line 48 of file PDDLFormula.h.

◆ apiVersion()

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

Get apiVersion value.

Returns
apiVersion value

Definition at line 109 of file PDDLFormula.h.

Referenced by set_apiVersion().

◆ from_json()

void PDDLFormula::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 97 of file PDDLFormula.cpp.

References from_json_value().

Referenced by PDDLFormula().

◆ from_json_value()

void PDDLFormula::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 106 of file PDDLFormula.cpp.

Referenced by from_json(), and PDDLFormula().

◆ id()

std::optional< std::string > PDDLFormula::id ( ) const
inline

Get id value.

Returns
id value

Definition at line 126 of file PDDLFormula.h.

Referenced by set_id().

◆ kind()

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

Get kind value.

Returns
kind value

Definition at line 92 of file PDDLFormula.h.

Referenced by set_kind().

◆ part_of()

std::optional< std::string > PDDLFormula::part_of ( ) const
inline

Get part-of value.

Returns
part-of value

Definition at line 160 of file PDDLFormula.h.

Referenced by set_part_of().

◆ set_apiVersion()

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

Set apiVersion value.

Parameters
apiVersionnew value

Definition at line 118 of file PDDLFormula.h.

References apiVersion().

◆ set_id()

void PDDLFormula::set_id ( const std::string &  id)
inline

Set id value.

Parameters
idnew value

Definition at line 135 of file PDDLFormula.h.

References id().

◆ set_kind()

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

Set kind value.

Parameters
kindnew value

Definition at line 101 of file PDDLFormula.h.

References kind().

◆ set_part_of()

void PDDLFormula::set_part_of ( const std::string &  part_of)
inline

Set part-of value.

Parameters
part_ofnew value

Definition at line 169 of file PDDLFormula.h.

References part_of().

◆ set_type()

void PDDLFormula::set_type ( const std::string &  type)
inline

Set type value.

Parameters
typenew value

Definition at line 152 of file PDDLFormula.h.

References type().

◆ to_json()

std::string PDDLFormula::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 PDDLFormula.cpp.

References to_json_value().

◆ to_json_value()

void PDDLFormula::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 PDDLFormula.cpp.

Referenced by to_json().

◆ type()

std::optional< std::string > PDDLFormula::type ( ) const
inline

Get type value.

Returns
type value

Definition at line 143 of file PDDLFormula.h.

Referenced by set_type().

◆ validate()

void PDDLFormula::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 126 of file PDDLFormula.cpp.


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