Element.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2015 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef SDF_ELEMENT_HH_
18 #define SDF_ELEMENT_HH_
19 
20 #include <any>
21 #include <map>
22 #include <memory>
23 #include <set>
24 #include <string>
25 #include <utility>
26 #include <vector>
27 
28 #include "sdf/Param.hh"
29 #include "sdf/sdf_config.h"
30 #include "sdf/system_util.hh"
31 #include "sdf/Types.hh"
32 
33 #ifdef _WIN32
34 // Disable warning C4251 which is triggered by
35 // std::enable_shared_from_this
36 #pragma warning(push)
37 #pragma warning(disable: 4251)
38 #endif
39 
42 namespace sdf
43 {
44  // Inline bracket to help doxygen filtering.
45  inline namespace SDF_VERSION_NAMESPACE {
46  //
47 
48  class ElementPrivate;
50 
53  typedef std::shared_ptr<Element> ElementPtr;
54 
57  typedef std::weak_ptr<Element> ElementWeakPtr;
58 
61  typedef std::vector<ElementPtr> ElementPtr_V;
62 
65 
69  public std::enable_shared_from_this<Element>
70  {
72  public: Element();
73 
75  public: virtual ~Element();
76 
79  public: ElementPtr Clone() const;
80 
83  public: void Copy(const ElementPtr _elem);
84 
88  public: ElementPtr GetParent() const;
89 
92  public: void SetParent(const ElementPtr _parent);
93 
96  public: void SetName(const std::string &_name);
97 
100  public: const std::string &GetName() const;
101 
108  public: void SetRequired(const std::string &_req);
109 
113  public: const std::string &GetRequired() const;
114 
118  public: void SetCopyChildren(bool _value);
119 
123  public: bool GetCopyChildren() const;
124 
127  public: void SetReferenceSDF(const std::string &_value);
128 
131  public: std::string ReferenceSDF() const;
132 
135  public: void PrintDescription(const std::string &_prefix) const;
136 
139  public: void PrintValues(std::string _prefix) const;
140 
147  public: void PrintDocLeftPane(std::string &_html,
148  int _spacing, int &_index) const;
149 
155  public: void PrintDocRightPane(std::string &_html,
156  int _spacing, int &_index) const;
157 
161  public: std::string ToString(const std::string &_prefix) const;
162 
170  public: void AddAttribute(const std::string &_key,
171  const std::string &_type,
172  const std::string &_defaultvalue,
173  bool _required,
174  const std::string &_description="");
175 
182  public: void AddValue(const std::string &_type,
183  const std::string &_defaultValue, bool _required,
184  const std::string &_description="");
185 
189  public: ParamPtr GetAttribute(const std::string &_key) const;
190 
193  public: size_t GetAttributeCount() const;
194 
198  public: ParamPtr GetAttribute(unsigned int _index) const;
199 
202  public: size_t GetElementDescriptionCount() const;
203 
207  public: ElementPtr GetElementDescription(unsigned int _index) const;
208 
212  public: ElementPtr GetElementDescription(const std::string &_key) const;
213 
217  public: bool HasElementDescription(const std::string &_name) const;
218 
222  public: bool HasAttribute(const std::string &_key) const;
223 
227  public: bool GetAttributeSet(const std::string &_key) const;
228 
231  public: ParamPtr GetValue() const;
232 
237  public: std::any GetAny(const std::string &_key = "") const;
238 
245  public: template<typename T>
246  T Get(const std::string &_key = "") const;
247 
254  public: template<typename T>
255  std::pair<T, bool> Get(const std::string &_key,
256  const T &_defaultValue) const;
257 
264  public: template<typename T>
265  bool Get(const std::string &_key,
266  T &_param,
267  const T &_defaultValue) const;
268 
272  public: template<typename T>
273  bool Set(const T &_value);
274 
278  public: bool HasElement(const std::string &_name) const;
279 
283  public: ElementPtr GetFirstElement() const;
284 
296  public: ElementPtr GetNextElement(const std::string &_name = "") const;
297 
300  public: std::set<std::string> GetElementTypeNames() const;
301 
309  public: bool HasUniqueChildNames(const std::string &_type = "") const;
310 
318  public: std::map<std::string, std::size_t>
319  CountNamedElements(const std::string &_type = "") const;
320 
330  public: ElementPtr GetElement(const std::string &_name);
331 
335  public: ElementPtr AddElement(const std::string &_name);
336 
339  public: void InsertElement(ElementPtr _elem);
340 
342  public: void RemoveFromParent();
343 
346  public: void RemoveChild(ElementPtr _child);
347 
349  public: void ClearElements();
350 
353  public: void Update();
354 
358  public: void Reset();
359 
362  public: void SetInclude(const std::string &_filename);
363 
366  public: std::string GetInclude() const;
367 
370  public: void SetFilePath(const std::string &_path);
371 
374  public: const std::string &FilePath() const;
375 
378  public: std::string GetDescription() const;
379 
382  public: void SetDescription(const std::string &_desc);
383 
386  public: void AddElementDescription(ElementPtr _elem);
387 
391  public: ElementPtr GetElementImpl(const std::string &_name) const;
392 
396  private: void ToString(const std::string &_prefix,
397  std::ostringstream &_out) const;
398 
402  private: void PrintValuesImpl(const std::string &_prefix,
403  std::ostringstream &_out) const;
404 
413  private: ParamPtr CreateParam(const std::string &_key,
414  const std::string &_type,
415  const std::string &_defaultValue,
416  bool _required,
417  const std::string &_description="");
418 
419 
421  private: std::unique_ptr<ElementPrivate> dataPtr;
422  };
423 
427  {
429  public: std::string name;
430 
432  public: std::string required;
433 
435  public: std::string description;
436 
438  public: bool copyChildren;
439 
441  public: ElementWeakPtr parent;
442 
443  // Attributes of this element
445 
446  // Value of this element
447  public: ParamPtr value;
448 
449  // The existing child elements
450  public: ElementPtr_V elements;
451 
452  // The possible child elements
453  public: ElementPtr_V elementDescriptions;
454 
456  public: std::string includeFilename;
457 
459  public: std::string referenceSDF;
460 
462  public: std::string path;
463  };
464 
466  template<typename T>
467  T Element::Get(const std::string &_key) const
468  {
469  T result = T();
470 
471  std::pair<T, bool> ret = this->Get<T>(_key, result);
472 
473  return ret.first;
474  }
475 
477  template<typename T>
478  bool Element::Get(const std::string &_key,
479  T &_param,
480  const T &_defaultValue) const
481  {
482  std::pair<T, bool> ret = this->Get<T>(_key, _defaultValue);
483  _param = ret.first;
484  return ret.second;
485  }
486 
488  template<typename T>
489  std::pair<T, bool> Element::Get(const std::string &_key,
490  const T &_defaultValue) const
491  {
492  std::pair<T, bool> result(_defaultValue, true);
493 
494  if (_key.empty() && this->dataPtr->value)
495  {
496  this->dataPtr->value->Get<T>(result.first);
497  }
498  else if (!_key.empty())
499  {
500  ParamPtr param = this->GetAttribute(_key);
501  if (param)
502  {
503  param->Get(result.first);
504  }
505  else if (this->HasElement(_key))
506  {
507  result.first = this->GetElementImpl(_key)->Get<T>();
508  }
509  else if (this->HasElementDescription(_key))
510  {
511  result.first = this->GetElementDescription(_key)->Get<T>();
512  }
513  else
514  {
515  result.second = false;
516  }
517  }
518  else
519  {
520  result.second = false;
521  }
522 
523  return result;
524  }
525 
527  template<typename T>
528  bool Element::Set(const T &_value)
529  {
530  if (this->dataPtr->value)
531  {
532  this->dataPtr->value->Set(_value);
533  return true;
534  }
535  return false;
536  }
538  }
539 }
540 
541 #ifdef _WIN32
542 #pragma warning(pop)
543 #endif
544 
545 #endif
Param_V attributes
Definition: Element.hh:444
ElementPtr_V elementDescriptions
Definition: Element.hh:453
std::string includeFilename
name of the include file that was used to create this element
Definition: Element.hh:456
ElementPtr_V elements
Definition: Element.hh:450
bool copyChildren
True if element&#39;s children should be copied.
Definition: Element.hh:438
Definition: Element.hh:426
std::weak_ptr< Element > ElementWeakPtr
Definition: Element.hh:57
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
SDF Element class.
Definition: Element.hh:68
std::string referenceSDF
Name of reference sdf.
Definition: Element.hh:459
ParamPtr value
Definition: Element.hh:447
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
std::string path
Path to file where this element came from.
Definition: Element.hh:462
std::string description
Element description.
Definition: Element.hh:435
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
std::string name
Element name.
Definition: Element.hh:429
std::shared_ptr< Param > ParamPtr
Definition: Param.hh:57
std::vector< ElementPtr > ElementPtr_V
Definition: Element.hh:61
namespace for Simulation Description Format parser
Definition: Actor.hh:32
std::vector< ParamPtr > Param_V
Definition: Param.hh:61
ElementWeakPtr parent
Element&#39;s parent.
Definition: Element.hh:441
std::string required
True if element is required.
Definition: Element.hh:432