17#ifndef SDF_ELEMENT_HH_
18#define SDF_ELEMENT_HH_
30#include "sdf/sdf_config.h"
38#pragma warning(disable: 4251)
46 inline namespace SDF_VERSION_NAMESPACE {
74 public std::enable_shared_from_this<Element>
101 public:
void SetName(
const std::string &_name);
166 bool _includeDefaultElements,
167 bool _includeDefaultAttributes,
177 int _spacing,
int &_index)
const;
185 int _spacing,
int &_index)
const;
192 const std::string &_prefix,
205 const std::string &_prefix,
206 bool _includeDefaultElements,
207 bool _includeDefaultAttributes,
218 const std::string &_type,
219 const std::string &_defaultvalue,
221 const std::string &_description =
"");
230 const std::string &_defaultValue,
bool _required,
231 const std::string &_description =
"");
243 const std::string &_defaultValue,
bool _required,
244 const std::string &_minValue,
245 const std::string &_maxValue,
246 const std::string &_description =
"");
310 public: std::any
GetAny(
const std::string &_key =
"")
const;
318 public:
template<
typename T>
319 T Get(
const std::string &_key =
"")
const;
327 public:
template<
typename T>
328 std::pair<T, bool> Get(
const std::string &_key,
329 const T &_defaultValue)
const;
337 public:
template<
typename T>
338 bool Get(
const std::string &_key,
340 const T &_defaultValue)
const;
345 public:
template<
typename T>
346 bool Set(
const T &_value);
395 const std::string &_type,
396 const std::vector<std::string> &_ignoreElements)
const;
405 public: std::map<std::string, std::size_t>
419 const std::string &_type,
420 const std::vector<std::string> &_ignoreElements)
const;
574 private:
void ToString(
const std::string &_prefix,
575 bool _includeDefaultElements,
576 bool _includeDefaultAttributes,
578 std::ostringstream &_out)
const;
586 private:
void PrintValuesImpl(
const std::string &_prefix,
587 bool _includeDefaultElements,
588 bool _includeDefaultAttributes,
590 std::ostringstream &_out)
const;
600 private:
ParamPtr CreateParam(
const std::string &_key,
601 const std::string &_type,
602 const std::string &_defaultValue,
604 const std::string &_description =
"");
608 private: std::unique_ptr<ElementPrivate> dataPtr;
685 T Element::Get(
const std::string &_key)
const
689 std::pair<T, bool> ret = this->Get<T>(_key, result);
696 bool Element::Get(
const std::string &_key,
698 const T &_defaultValue)
const
700 std::pair<T, bool> ret = this->Get<T>(_key, _defaultValue);
707 std::pair<T, bool> Element::Get(
const std::string &_key,
708 const T &_defaultValue)
const
710 std::pair<T, bool> result(_defaultValue,
true);
712 if (_key.empty() && this->dataPtr->value)
714 this->dataPtr->value->Get<T>(result.first);
716 else if (!_key.empty())
718 ParamPtr param = this->GetAttribute(_key);
721 param->Get(result.first);
723 else if (this->HasElement(_key))
725 result.first = this->GetElementImpl(_key)->Get<T>();
727 else if (this->HasElementDescription(_key))
729 result.first = this->GetElementDescription(_key)->Get<T>();
733 result.second =
false;
738 result.second =
false;
746 bool Element::Set(
const T &_value)
748 if (this->dataPtr->value)
750 this->dataPtr->value->Set(_value);
Definition Element.hh:614
bool explicitlySetInFile
True if the element was set in the SDF file.
Definition Element.hh:674
std::string path
Path to file where this element came from.
Definition Element.hh:668
ElementPtr_V elementDescriptions
Definition Element.hh:640
std::string originalVersion
Spec version that this was originally parsed from.
Definition Element.hh:671
std::string description
Element description.
Definition Element.hh:622
std::string name
Element name.
Definition Element.hh:616
std::string required
True if element is required.
Definition Element.hh:619
std::string xmlPath
XML path of this element.
Definition Element.hh:680
bool copyChildren
True if element's children should be copied.
Definition Element.hh:625
std::optional< int > lineNumber
Line number in file where this element came from.
Definition Element.hh:677
ElementPtr includeElement
The element that was used to load this entity.
Definition Element.hh:662
ElementWeakPtr parent
Element's parent.
Definition Element.hh:628
Param_V attributes
Definition Element.hh:631
std::string referenceSDF
Name of reference sdf.
Definition Element.hh:665
ParamPtr value
Definition Element.hh:634
ElementPtr_V elements
Definition Element.hh:637
SDF Element class.
Definition Element.hh:75
ElementPtr GetElementDescription(const std::string &_key) const
Get an element description using a key.
bool HasUniqueChildNames(const std::string &_type, const std::vector< std::string > &_ignoreElements) const
Checks whether any child elements of the specified element type, except those listed in _ignoreElemen...
void RemoveChild(ElementPtr _child)
Remove a child element.
const std::string & XmlPath() const
Get the XML path of this element.
bool HasElementDescription(const std::string &_name) const
Return true if an element description exists.
std::optional< int > LineNumber() const
Get the line number of this element within the SDF document.
ElementPtr FindElement(const std::string &_name)
Return a pointer to the child element with the provided name.
ElementPtr GetElement(const std::string &_name)
Return a pointer to the child element with the provided name.
ElementConstPtr FindElement(const std::string &_name) const
Return a pointer to the child element with the provided name.
void PrintDescription(const std::string &_prefix) const
Output Element's description to stdout.
const std::string & GetName() const
Get the Element's name.
ParamPtr GetAttribute(unsigned int _index) const
Get an attribute using an index.
void SetRequired(const std::string &_req)
Set the requirement type.
bool GetAttributeSet(const std::string &_key) const
Return true if the attribute was set (i.e.
bool HasAttribute(const std::string &_key) const
Return true if an attribute exists.
void RemoveFromParent()
Remove this element from its parent.
std::string ReferenceSDF() const
Get the name of the reference SDF element.
bool HasElement(const std::string &_name) const
Return true if the named element exists.
void PrintDocRightPane(std::string &_html, int _spacing, int &_index) const
Helper function for SDF::PrintDoc.
bool GetExplicitlySetInFile() const
Return if the element was been explicitly set in the file.
void SetDescription(const std::string &_desc)
Set a text description for the element.
void PrintValues(std::string _prefix, const PrintConfig &_config=PrintConfig()) const
Output Element's values to stdout.
void SetParent(const ElementPtr _parent)
Set the parent of this Element.
std::map< std::string, std::size_t > CountNamedElements(const std::string &_type, const std::vector< std::string > &_ignoreElements) const
Count the number of child elements of the specified element type that have the same name attribute va...
std::set< std::string > GetElementTypeNames() const
Get set of child element type names.
bool HasUniqueChildNames(const std::string &_type="") const
Checks whether any child elements of the specified element type have identical name attribute values ...
void SetXmlPath(const std::string &_path)
Private data pointer.
ElementPtr GetFirstElement() const
Get the first child element.
std::string ToString(const std::string &_prefix, const PrintConfig &_config=PrintConfig()) const
Convert the element values to a string representation.
void SetReferenceSDF(const std::string &_value)
Set reference SDF element.
std::string ToString(const std::string &_prefix, bool _includeDefaultElements, bool _includeDefaultAttributes, const PrintConfig &_config=PrintConfig()) const
Convert the element values to a string representation.
void PrintValues(const std::string &_prefix, bool _includeDefaultElements, bool _includeDefaultAttributes, const PrintConfig &_config=PrintConfig()) const
Output Element's values to stdout.
const std::string & OriginalVersion() const
Get the spec version that this was originally parsed from.
ParamPtr GetValue() const
Get the param of the elements value return A Param pointer to the value of this element.
void AddElementDescription(ElementPtr _elem)
Add a new element description.
ElementPtr AddElement(const std::string &_name)
Add a named element.
ElementPtr GetElementImpl(const std::string &_name) const
Get a pointer to the named element.
void Update()
Call the Update() callback on each element, as well as the embedded Param.
void SetOriginalVersion(const std::string &_version)
Set the spec version that this was originally parsed from.
void Clear()
Remove all child elements and reset file path and original version.
sdf::ElementPtr GetIncludeElement() const
Get the element that was used to load this element.
const Param_V & GetAttributes() const
Get all the attribute params.
std::string GetDescription() const
Get a text description of the element.
void SetFilePath(const std::string &_path)
Set the path to the SDF document where this element came from.
void AddAttribute(const std::string &_key, const std::string &_type, const std::string &_defaultvalue, bool _required, const std::string &_description="")
Add an attribute value.
ElementPtr GetElementDescription(unsigned int _index) const
Get an element description using an index.
const std::string & GetRequired() const
Get the requirement string.
size_t GetAttributeCount() const
Get the number of attributes.
void AddValue(const std::string &_type, const std::string &_defaultValue, bool _required, const std::string &_minValue, const std::string &_maxValue, const std::string &_description="")
Add a value to this Element.
static std::vector< std::string > NameUniquenessExceptions()
List of elements to which exceptions are made when checking for name uniqueness.
ElementPtr GetNextElement(const std::string &_name="") const
Get the next sibling of this element.
std::map< std::string, std::size_t > CountNamedElements(const std::string &_type="") const
Count the number of child elements of the specified element type that have the same name attribute va...
void RemoveAllAttributes()
Removes all attributes.
void SetLineNumber(int _lineNumber)
Set the line number of this element within the SDF document.
void SetCopyChildren(bool _value)
Set whether this element should copy its child elements during parsing.
bool GetCopyChildren() const
Return true if this Element's child elements should be copied during parsing.
const std::string & FilePath() const
Get the path to the SDF document where this element came from.
void AddValue(const std::string &_type, const std::string &_defaultValue, bool _required, const std::string &_description="")
Add a value to this Element.
ElementPtr GetParent() const
Get a pointer to this Element's parent.
void RemoveAttribute(const std::string &_key)
Remove an attribute.
std::any GetAny(const std::string &_key="") const
Get the element value/attribute as a std::any.
void InsertElement(ElementPtr _elem)
Add an element object.
ParamPtr GetAttribute(const std::string &_key) const
Get the param of an attribute.
size_t GetElementDescriptionCount() const
Get the number of element descriptions.
void Reset()
Call reset on each element and element description before deleting all of them.
ElementPtr Clone() const
Create a copy of this Element.
virtual ~Element()
Destructor.
void ClearElements()
Remove all child elements.
void SetExplicitlySetInFile(const bool _value)
Set if the element and children where set or default in the original file.
void PrintDocLeftPane(std::string &_html, int _spacing, int &_index) const
Helper function for SDF::PrintDoc.
void Copy(const ElementPtr _elem)
Copy values from an Element.
void SetIncludeElement(sdf::ElementPtr _includeElem)
Set the element that was used to load this element.
void SetName(const std::string &_name)
Set the name of the Element.
This class contains configuration options for printing elements.
Definition PrintConfig.hh:32
std::weak_ptr< Element > ElementWeakPtr
Definition Element.hh:62
std::vector< ElementPtr > ElementPtr_V
Definition Element.hh:66
std::shared_ptr< Element > ElementPtr
Definition Element.hh:54
std::shared_ptr< const Element > ElementConstPtr
Definition Element.hh:58
std::vector< ParamPtr > Param_V
Definition Param.hh:69
std::shared_ptr< Param > ParamPtr
Definition Param.hh:65
namespace for Simulation Description Format parser
Definition Actor.hh:34
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition system_util.hh:41