Fawkes API  Fawkes Development Version
DomainPredicate.h
1 
2 /****************************************************************************
3  * ClipsExecutive -- Schema DomainPredicate
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 /** DomainPredicate representation for JSON transfer. */
27 
28 {
29 public:
30  /** Constructor. */
32  /** Constructor from JSON.
33  * @param json JSON string to initialize from
34  */
35  DomainPredicate(const std::string &json);
36  /** Constructor from JSON.
37  * @param v RapidJSON value object to initialize from.
38  */
39  DomainPredicate(const rapidjson::Value &v);
40 
41  /** Destructor. */
42  virtual ~DomainPredicate();
43 
44  /** Get version of implemented API.
45  * @return string representation of version
46  */
47  static std::string
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: DomainPredicate
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 sensed value.
140  * @return sensed value
141  */
142  std::optional<bool>
143  sensed() const
144  {
145  return sensed_;
146  }
147 
148  /** Set sensed value.
149  * @param sensed new value
150  */
151  void
152  set_sensed(const bool &sensed)
153  {
154  sensed_ = sensed;
155  }
156  /** Get param-names value.
157  * @return param-names value
158  */
159  std::vector<std::string>
160  param_names() const
161  {
162  return param_names_;
163  }
164 
165  /** Set param-names value.
166  * @param param_names new value
167  */
168  void
169  set_param_names(const std::vector<std::string> &param_names)
170  {
171  param_names_ = param_names;
172  }
173  /** Add element to param-names array.
174  * @param param_names new value
175  */
176  void
177  addto_param_names(const std::string &&param_names)
178  {
179  param_names_.push_back(std::move(param_names));
180  }
181 
182  /** Add element to param-names array.
183  * The move-semantics version (std::move) should be preferred.
184  * @param param_names new value
185  */
186  void
187  addto_param_names(const std::string &param_names)
188  {
189  param_names_.push_back(param_names);
190  }
191  /** Get param-types value.
192  * @return param-types value
193  */
194  std::vector<std::string>
195  param_types() const
196  {
197  return param_types_;
198  }
199 
200  /** Set param-types value.
201  * @param param_types new value
202  */
203  void
204  set_param_types(const std::vector<std::string> &param_types)
205  {
206  param_types_ = param_types;
207  }
208  /** Add element to param-types array.
209  * @param param_types new value
210  */
211  void
212  addto_param_types(const std::string &&param_types)
213  {
214  param_types_.push_back(std::move(param_types));
215  }
216 
217  /** Add element to param-types array.
218  * The move-semantics version (std::move) should be preferred.
219  * @param param_types new value
220  */
221  void
222  addto_param_types(const std::string &param_types)
223  {
224  param_types_.push_back(param_types);
225  }
226 
227 private:
228  std::optional<std::string> kind_;
229  std::optional<std::string> apiVersion_;
230  std::optional<std::string> name_;
231  std::optional<bool> sensed_;
232  std::vector<std::string> param_names_;
233  std::vector<std::string> param_types_;
234 };
virtual void from_json(const std::string &json)
Retrieve data from JSON string.
virtual void to_json_value(rapidjson::Document &d, rapidjson::Value &v) const
Render object to JSON.
std::optional< bool > sensed() const
Get sensed value.
DomainPredicate()
Constructor.
virtual ~DomainPredicate()
Destructor.
void set_param_names(const std::vector< std::string > &param_names)
Set param-names value.
void set_param_types(const std::vector< std::string > &param_types)
Set param-types value.
std::vector< std::string > param_names() const
Get param-names value.
void set_apiVersion(const std::string &apiVersion)
Set apiVersion value.
void addto_param_types(const std::string &&param_types)
Add element to param-types array.
std::vector< std::string > param_types() const
Get param-types value.
virtual void from_json_value(const rapidjson::Value &v)
Retrieve data from JSON string.
void set_sensed(const bool &sensed)
Set sensed value.
virtual void validate(bool subcall=false) const
Validate if all required fields have been set.
std::optional< std::string > name() const
Get name value.
std::optional< std::string > apiVersion() const
Get apiVersion value.
void addto_param_names(const std::string &&param_names)
Add element to param-names array.
DomainPredicate representation for JSON transfer.
virtual std::string to_json(bool pretty=false) const
Render object to JSON.
std::optional< std::string > kind() const
Get kind value.
static std::string api_version()
Get version of implemented API.
void addto_param_types(const std::string &param_types)
Add element to param-types array.
void set_name(const std::string &name)
Set name value.
void addto_param_names(const std::string &param_names)
Add element to param-names array.
void set_kind(const std::string &kind)
Set kind value.