Fawkes API  Fawkes Development Version
DomainPrecondition.h
1 
2 /****************************************************************************
3  * ClipsExecutive -- Schema DomainPrecondition
4  * (auto-generated, do not modify directly)
5  *
6  * CLIPS Executive REST API.
7  * Enables access to goals, plans, and all items in the domain model.
8  *
9  * API Contact: Tim Niemueller <niemueller@kbsg.rwth-aachen.de>
10  * API Version: v1beta1
11  * API License: Apache 2.0
12  ****************************************************************************/
13 
14 #pragma once
15 
16 #define RAPIDJSON_HAS_STDSTRING 1
17 #include <rapidjson/fwd.h>
18 
19 #include <cstdint>
20 #include <memory>
21 #include <optional>
22 #include <string>
23 #include <vector>
24 
25 /** DomainPrecondition representation for JSON transfer. */
27 
28 {
29 public:
30  /** Constructor. */
32  /** Constructor from JSON.
33  * @param json JSON string to initialize from
34  */
35  DomainPrecondition(const std::string &json);
36  /** Constructor from JSON.
37  * @param v RapidJSON value object to initialize from.
38  */
39  DomainPrecondition(const rapidjson::Value &v);
40 
41  /** Destructor. */
42  virtual ~DomainPrecondition();
43 
44  /** Get version of implemented API.
45  * @return string representation of version
46  */
47  static std::string
48  api_version()
49  {
50  return "v1beta1";
51  }
52 
53  /** Render object to JSON.
54  * @param pretty true to enable pretty printing (readable spacing)
55  * @return JSON string
56  */
57  virtual std::string to_json(bool pretty = false) const;
58  /** Render object to JSON.
59  * @param d RapidJSON document to retrieve allocator from
60  * @param v RapidJSON value to add data to
61  */
62  virtual void to_json_value(rapidjson::Document &d, rapidjson::Value &v) const;
63  /** Retrieve data from JSON string.
64  * @param json JSON representation suitable for this object.
65  * Will allow partial assignment and not validate automaticaly.
66  * @see validate()
67  */
68  virtual void from_json(const std::string &json);
69  /** Retrieve data from JSON string.
70  * @param v RapidJSON value suitable for this object.
71  * Will allow partial assignment and not validate automaticaly.
72  * @see validate()
73  */
74  virtual void from_json_value(const rapidjson::Value &v);
75 
76  /** Validate if all required fields have been set.
77  * @param subcall true if this is called from another class, e.g.,
78  * a sub-class or array holder. Will modify the kind of exception thrown.
79  * @exception std::vector<std::string> thrown if required information is
80  * missing and @p subcall is set to true. Contains a list of missing fields.
81  * @exception std::runtime_error informative message describing the missing
82  * fields
83  */
84  virtual void validate(bool subcall = false) const;
85 
86  // Schema: DomainPrecondition
87 public:
88  /** Get kind value.
89  * @return kind value
90  */
91  std::optional<std::string>
92  kind() const
93  {
94  return kind_;
95  }
96 
97  /** Set kind value.
98  * @param kind new value
99  */
100  void
101  set_kind(const std::string &kind)
102  {
103  kind_ = kind;
104  }
105  /** Get apiVersion value.
106  * @return apiVersion value
107  */
108  std::optional<std::string>
109  apiVersion() const
110  {
111  return apiVersion_;
112  }
113 
114  /** Set apiVersion value.
115  * @param apiVersion new value
116  */
117  void
118  set_apiVersion(const std::string &apiVersion)
119  {
120  apiVersion_ = apiVersion;
121  }
122  /** Get name value.
123  * @return name value
124  */
125  std::optional<std::string>
126  name() const
127  {
128  return name_;
129  }
130 
131  /** Set name value.
132  * @param name new value
133  */
134  void
135  set_name(const std::string &name)
136  {
137  name_ = name;
138  }
139  /** Get type value.
140  * @return type value
141  */
142  std::optional<std::string>
143  type() const
144  {
145  return type_;
146  }
147 
148  /** Set type value.
149  * @param type new value
150  */
151  void
152  set_type(const std::string &type)
153  {
154  type_ = type;
155  }
156  /** Get grounded value.
157  * @return grounded value
158  */
159  std::optional<bool>
160  grounded() const
161  {
162  return grounded_;
163  }
164 
165  /** Set grounded value.
166  * @param grounded new value
167  */
168  void
169  set_grounded(const bool &grounded)
170  {
171  grounded_ = grounded;
172  }
173  /** Get is-satisfied value.
174  * @return is-satisfied value
175  */
176  std::optional<bool>
177  is_satisfied() const
178  {
179  return is_satisfied_;
180  }
181 
182  /** Set is-satisfied value.
183  * @param is_satisfied new value
184  */
185  void
186  set_is_satisfied(const bool &is_satisfied)
187  {
188  is_satisfied_ = is_satisfied;
189  }
190 
191 private:
192  std::optional<std::string> kind_;
193  std::optional<std::string> apiVersion_;
194  std::optional<std::string> name_;
195  std::optional<std::string> type_;
196  std::optional<bool> grounded_;
197  std::optional<bool> is_satisfied_;
198 };
DomainPrecondition::set_is_satisfied
void set_is_satisfied(const bool &is_satisfied)
Set is-satisfied value.
Definition: DomainPrecondition.h:185
DomainPrecondition::apiVersion
std::optional< std::string > apiVersion() const
Get apiVersion value.
Definition: DomainPrecondition.h:108
DomainPrecondition::validate
virtual void validate(bool subcall=false) const
Validate if all required fields have been set.
Definition: DomainPrecondition.cpp:132
DomainPrecondition::type
std::optional< std::string > type() const
Get type value.
Definition: DomainPrecondition.h:142
DomainPrecondition::is_satisfied
std::optional< bool > is_satisfied() const
Get is-satisfied value.
Definition: DomainPrecondition.h:176
DomainPrecondition::api_version
static std::string api_version()
Get version of implemented API.
Definition: DomainPrecondition.h:47
DomainPrecondition::name
std::optional< std::string > name() const
Get name value.
Definition: DomainPrecondition.h:125
DomainPrecondition::set_apiVersion
void set_apiVersion(const std::string &apiVersion)
Set apiVersion value.
Definition: DomainPrecondition.h:117
DomainPrecondition
DomainPrecondition representation for JSON transfer.
Definition: DomainPrecondition.h:25
DomainPrecondition::set_name
void set_name(const std::string &name)
Set name value.
Definition: DomainPrecondition.h:134
DomainPrecondition::set_kind
void set_kind(const std::string &kind)
Set kind value.
Definition: DomainPrecondition.h:100
DomainPrecondition::grounded
std::optional< bool > grounded() const
Get grounded value.
Definition: DomainPrecondition.h:159
DomainPrecondition::set_type
void set_type(const std::string &type)
Set type value.
Definition: DomainPrecondition.h:151
DomainPrecondition::to_json
virtual std::string to_json(bool pretty=false) const
Render object to JSON.
Definition: DomainPrecondition.cpp:41
DomainPrecondition::DomainPrecondition
DomainPrecondition()
Constructor.
Definition: DomainPrecondition.cpp:22
DomainPrecondition::to_json_value
virtual void to_json_value(rapidjson::Document &d, rapidjson::Value &v) const
Render object to JSON.
Definition: DomainPrecondition.cpp:60
DomainPrecondition::set_grounded
void set_grounded(const bool &grounded)
Set grounded value.
Definition: DomainPrecondition.h:168
DomainPrecondition::~DomainPrecondition
virtual ~DomainPrecondition()
Destructor.
Definition: DomainPrecondition.cpp:36
DomainPrecondition::from_json
virtual void from_json(const std::string &json)
Retrieve data from JSON string.
Definition: DomainPrecondition.cpp:100
DomainPrecondition::kind
std::optional< std::string > kind() const
Get kind value.
Definition: DomainPrecondition.h:91
DomainPrecondition::from_json_value
virtual void from_json_value(const rapidjson::Value &v)
Retrieve data from JSON string.
Definition: DomainPrecondition.cpp:109