#include <sdf/sdf.hh>

Inheritance diagram for sdf::Element:

Public Member Functions
	Element ()
	Constructor. More...

virtual	~Element ()
	Destructor. More...

void	AddAttribute (const std::string &_key, const std::string &_type, const std::string &_defaultvalue, bool _required, const std::string &_description="")
	Add an attribute value. More...

ElementPtr	AddElement (const std::string &_name)
	Add a named element. More...

void	AddElementDescription (ElementPtr _elem)
	Add a new element description. More...

void	AddValue (const std::string &_type, const std::string &_defaultValue, bool _required, const std::string &_description="")
	Add a value to this Element. More...

void	ClearElements ()
	Remove all child elements. More...

ElementPtr	Clone () const
	Create a copy of this Element. More...

void	Copy (const ElementPtr _elem)
	Copy values from an Element. More...

template<typename T >
T	Get (const std::string &_key="") const
	Get the value of a key. More...

template<typename T >
std::pair< T, bool >	Get (const std::string &_key, const T &_defaultValue) const
	Get the value of a key. More...

template<typename T >
bool	Get (const std::string &_key, T &_param, const T &_defaultValue) const
	Get the value of a key. More...

boost::any	GetAny (const std::string &_key="") const
	Get the element value/attribute as a boost::any. More...

ParamPtr	GetAttribute (const std::string &_key) const
	Get the param of an attribute. More...

ParamPtr	GetAttribute (unsigned int _index) const
	Get an attribute using an index. More...

size_t	GetAttributeCount () const
	Get the number of attributes. More...

bool	GetAttributeSet (const std::string &_key) const
	Return true if the attribute was set (i.e. More...

bool	GetCopyChildren () const
	Return true if this Element's child elements should be copied during parsing. More...

std::string	GetDescription () const
	Get a text description of the element. More...

ElementPtr	GetElement (const std::string &_name)
	Return a pointer to the child element with the provided name. More...

ElementPtr	GetElementDescription (unsigned int _index) const
	Get an element description using an index. More...

ElementPtr	GetElementDescription (const std::string &_key) const
	Get an element description using a key. More...

size_t	GetElementDescriptionCount () const
	Get the number of element descriptions. More...

ElementPtr	GetElementImpl (const std::string &_name) const
	Get a pointer to the named element. More...

ElementPtr	GetFirstElement () const
	Get the first child element. More...

std::string	GetInclude () const
	Get the include filename. More...

const std::string &	GetName () const
	Get the Element's name. More...

ElementPtr	GetNextElement (const std::string &_name="") const
	Get the next sibling of this element. More...

ElementPtr	GetParent () const
	Get a pointer to this Element's parent. More...

const std::string &	GetRequired () const
	Get the requirement string. More...

ParamPtr	GetValue () const
	Get the param of the elements value return A Param pointer to the value of this element. More...

bool	HasAttribute (const std::string &_key) const
	Return true if an attribute exists. More...

bool	HasElement (const std::string &_name) const
	Return true if the named element exists. More...

bool	HasElementDescription (const std::string &_name) const
	Return true if an element description exists. More...

void	InsertElement (ElementPtr _elem)
	Add an element object. More...

void	PrintDescription (const std::string &_prefix) const
	Output Element's description to stdout. More...

void	PrintDocLeftPane (std::string &_html, int _spacing, int &_index) const
	Helper function for SDF::PrintDoc. More...

void	PrintDocRightPane (std::string &_html, int _spacing, int &_index) const
	Helper function for SDF::PrintDoc. More...

void	PrintValues (std::string _prefix) const
	Output Element's values to stdout. More...

std::string	ReferenceSDF () const
	Get the name of the reference SDF element. More...

void	RemoveChild (ElementPtr _child)
	Remove a child element. More...

void	RemoveFromParent ()
	Remove this element from its parent. More...

void	Reset ()
	Call reset on each element and element description before deleting all of them. More...

template<typename T >
bool	Set (const T &_value)
	Set the value of this element. More...

void	SetCopyChildren (bool _value)
	Set whether this element should copy its child elements during parsing. More...

void	SetDescription (const std::string &_desc)
	Set a text description for the element. More...

void	SetInclude (const std::string &_filename)
	Set the include filename to the passed in filename. More...

void	SetName (const std::string &_name)
	Set the name of the Element. More...

void	SetParent (const ElementPtr _parent)
	Set the parent of this Element. More...

void	SetReferenceSDF (const std::string &_value)
	Set reference SDF element. More...

void	SetRequired (const std::string &_req)
	Set the requirement type. More...

std::string	ToString (const std::string &_prefix) const
	Convert the element values to a string representation. More...

void	Update ()
	Call the Update() callback on each element, as well as the embedded Param. More...

Detailed Description

SDF Element class.

Constructor & Destructor Documentation

sdf::Element::Element ( )

Constructor.

virtual sdf::Element::~Element ( )

virtual

Destructor.

Member Function Documentation

void sdf::Element::AddAttribute	(	const std::string &	_key,
		const std::string &	_type,
		const std::string &	_defaultvalue,
		bool	_required,
		const std::string &	_description = `""`
	)

Add an attribute value.

Parameters

[in]	_key	Key value.
[in]	_type	Type of data the attribute will hold.
[in]	_defaultValue	Default value for the attribute.
[in]	_required	Requirement string. Element::SetRequired.
[in]	_description	A text description of the attribute.

Exceptions

sdf::AssertionInternalError if an invalid type is given.

ElementPtr sdf::Element::AddElement ( const std::string & _name )

Add a named element.

Parameters

[in] _name the name of the element to add.

Returns: A pointer to the newly created Element object.

void sdf::Element::AddElementDescription ( ElementPtr _elem )

Add a new element description.

Parameters

[in] _elem the Element object to add to the descriptions.

void sdf::Element::AddValue	(	const std::string &	_type,
		const std::string &	_defaultValue,
		bool	_required,
		const std::string &	_description = `""`
	)

Add a value to this Element.

Parameters

[in]	_type	Type of data the attribute will hold.
[in]	_defaultValue	Default value for the attribute.
[in]	_required	Requirement string. Element::SetRequired.
[in]	_description	A text description of the attribute.

Exceptions

sdf::AssertionInternalError if an invalid type is given.

void sdf::Element::ClearElements ( )

Remove all child elements.

ElementPtr sdf::Element::Clone ( ) const

Create a copy of this Element.

Returns: A copy of this Element.

void sdf::Element::Copy ( const ElementPtr _elem )

Copy values from an Element.

Parameters

[in] _elem Element to copy value from.

boost::any sdf::Element::GetAny ( const std::string & _key = "" ) const

Get the element value/attribute as a boost::any.

Parameters

[in] _key The key of the attribute. If empty, get the value of the element. Defaults to empty.

Returns: The element as a boost::any.

ParamPtr sdf::Element::GetAttribute ( const std::string & _key ) const

Get the param of an attribute.

Parameters

[in] _key the name of the attribute.

Returns: The parameter attribute value. NULL if the key is invalid.

Referenced by Get().

ParamPtr sdf::Element::GetAttribute ( unsigned int _index ) const

Get an attribute using an index.

Parameters

[in] _index the index of the attribute to get.

Returns: A Param pointer to the attribute.

size_t sdf::Element::GetAttributeCount ( ) const

Get the number of attributes.

Returns: The number of attributes.

bool sdf::Element::GetAttributeSet ( const std::string & _key ) const

Return true if the attribute was set (i.e.

not default value)

Parameters

[in] _key the key to use to find the attribute.

Returns: True if the attribute is set, false otherwise.

bool sdf::Element::GetCopyChildren ( ) const

Return true if this Element's child elements should be copied during parsing.

Returns: True to copy child elements during parsing.

std::string sdf::Element::GetDescription ( ) const

Get a text description of the element.

Returns: The text description of the element.

ElementPtr sdf::Element::GetElement ( const std::string & _name )

Return a pointer to the child element with the provided name.

A new child element, with the provided name, is added to this element if there is no existing child element.

Remarks: If there are multiple elements with the given tag, it returns the first one.

Parameters

[in] _name Name of the child element to retreive.

Returns: Pointer to the existing child element, or a new child element if an existing child element did not exist.

ElementPtr sdf::Element::GetElementDescription ( unsigned int _index ) const

Get an element description using an index.

Parameters

[in] _index the index of the element description to get.

Returns: An Element pointer to the found element.

Referenced by Get().

ElementPtr sdf::Element::GetElementDescription ( const std::string & _key ) const

Get an element description using a key.

Parameters

[in] _key the key to use to find the element.

Returns: An Element pointer to the found element.

size_t sdf::Element::GetElementDescriptionCount ( ) const

Get the number of element descriptions.

Returns: The number of element descriptions.

ElementPtr sdf::Element::GetElementImpl ( const std::string & _name ) const

Get a pointer to the named element.

Parameters

[in] _name the name of the element to look for.

Returns: A pointer to the named element if found, nullptr otherwise.

Referenced by Get().

ElementPtr sdf::Element::GetFirstElement ( ) const

Get the first child element.

Returns: A smart pointer to the first child of this element, or sdf::ElementPtr(nullptr) if there are no children.

std::string sdf::Element::GetInclude ( ) const

Get the include filename.

Returns: The include filename.

const std::string& sdf::Element::GetName ( ) const

Get the Element's name.

Returns: The name of this Element.

ElementPtr sdf::Element::GetNextElement ( const std::string & _name = "" ) const

Get the next sibling of this element.

Parameters

[in] _name if given then filter siblings by their xml tag.

Remarks: This function does not alter or store any state Repeated calls to "GetNextElement()" with the same string will always return a pointer to the same element.

Returns: A pointer to the next element if it exists, sdf::ElementPtr(nullptr) otherwise.

This can be used in combination with GetFirstElement() to walk the SDF tree. First call parent->GetFirstElement() to get the first child. Call child = child->GetNextElement() to iterate through the children.

ElementPtr sdf::Element::GetParent ( ) const

Get a pointer to this Element's parent.

Returns: Pointer to this Element's parent, NULL if there is no parent.

const std::string& sdf::Element::GetRequired ( ) const

Get the requirement string.

Returns: The requirement string.

See Also: Element::SetRequired

ParamPtr sdf::Element::GetValue ( ) const

Get the param of the elements value return A Param pointer to the value of this element.

bool sdf::Element::HasAttribute ( const std::string & _key ) const

Return true if an attribute exists.

Parameters

[in] _key the key to use to find the attribute.

Returns: True if the attribute exists, false otherwise.

bool sdf::Element::HasElement ( const std::string & _name ) const

Return true if the named element exists.

Parameters

[in] _name the name of the element to look for.

Returns: True if the named element was found, false otherwise.

Referenced by Get().

bool sdf::Element::HasElementDescription ( const std::string & _name ) const

Return true if an element description exists.

Parameters

[in] _name the name of the element to find.

Returns: True if the element description exists, false otherwise.

Referenced by Get().

void sdf::Element::InsertElement ( ElementPtr _elem )

Add an element object.

Parameters

[in] _elem the element object to add.

void sdf::Element::PrintDescription ( const std::string & _prefix ) const

Output Element's description to stdout.

Parameters

[in] _prefix String value to prefix to the output.

void sdf::Element::PrintDocLeftPane	(	std::string &	_html,
		int	_spacing,
		int &	_index
	)		const

Helper function for SDF::PrintDoc.

This generates the SDF html documentation.

Parameters

[out]	_html	Accumulated HTML for output.
[in]	_spacing	Amount of spacing for this element.
[in]	_index	Unique index for this element.

void sdf::Element::PrintDocRightPane	(	std::string &	_html,
		int	_spacing,
		int &	_index
	)		const

Helper function for SDF::PrintDoc.

This generates the SDF html documentation.

Parameters

[out]	_html	Accumulated HTML for output.
[in]	_spacing	Amount of spacing for this element.

void sdf::Element::PrintValues ( std::string _prefix ) const

Output Element's values to stdout.

Parameters

[in] _prefix String value to prefix to the output.

std::string sdf::Element::ReferenceSDF ( ) const

Get the name of the reference SDF element.

Returns: Name of the reference SDF element.

void sdf::Element::RemoveChild ( ElementPtr _child )

Remove a child element.

Parameters

[in] _child Pointer to the child to remove.

void sdf::Element::RemoveFromParent ( )

Remove this element from its parent.

void sdf::Element::Reset ( )

Call reset on each element and element description before deleting all of them.

Also clear out the embedded Param.

void sdf::Element::SetCopyChildren ( bool _value )

Set whether this element should copy its child elements during parsing.

Parameters

[in] _value True to copy Element's children.

void sdf::Element::SetDescription ( const std::string & _desc )

Set a text description for the element.

Parameters

[in] _desc the text description to set for the element.

void sdf::Element::SetInclude ( const std::string & _filename )

Set the include filename to the passed in filename.

Parameters

[in] _filename the filename to set the include filename to.

void sdf::Element::SetName ( const std::string & _name )

Set the name of the Element.

Parameters

[in] _name The new name for this Element.

void sdf::Element::SetParent ( const ElementPtr _parent )

Set the parent of this Element.

Parameters

[in] _parent Paren for this element.

void sdf::Element::SetReferenceSDF ( const std::string & _value )

Set reference SDF element.

Parameters

[in] _value Name of the reference sdf element.

void sdf::Element::SetRequired ( const std::string & _req )

Set the requirement type.

Parameters

[in] _req Requirement type for this element: 0: Not required. 1: Exactly one element is required. +: One or more elements are required. *: Zero or more elements are required.

std::string sdf::Element::ToString ( const std::string & _prefix ) const

Convert the element values to a string representation.

Parameters

[in] _prefix String value to prefix to the output.

Returns: The string representation.

void sdf::Element::Update ( )

Call the Update() callback on each element, as well as the embedded Param.

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

Element.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation