sdf::v11::ElementPrivate Class Reference

#include <Element.hh>

Public Attributes
Param_V	attributes
bool	copyChildren
	True if element's children should be copied. More...
std::string	description
	Element description. More...
ElementPtr_V	elementDescriptions
ElementPtr_V	elements
ElementPtr	includeElement
	The element that was used to load this entity. More...
std::string	includeFilename
	name of the include file that was used to create this element More...
std::string	name
	Element name. More...
std::string	originalVersion
	Spec version that this was originally parsed from. More...
ElementWeakPtr	parent
	Element's parent. More...
std::string	path
	Path to file where this element came from. More...
std::string	referenceSDF
	Name of reference sdf. More...
std::string	required
	True if element is required. More...
ParamPtr	value

Member Data Documentation

attributes

Param_V sdf::v11::ElementPrivate::attributes

copyChildren

bool sdf::v11::ElementPrivate::copyChildren

True if element's children should be copied.

description

std::string sdf::v11::ElementPrivate::description

Element description.

elementDescriptions

ElementPtr_V sdf::v11::ElementPrivate::elementDescriptions

elements

ElementPtr_V sdf::v11::ElementPrivate::elements

includeElement

ElementPtr sdf::v11::ElementPrivate::includeElement

The element that was used to load this entity.

For example, given the following SDFormat: <sdf version="1.8"> <world name="default"> <uri>model_uri</uri> <pose>1 2 3 0 0 0</pose> </world> </sdf> The ElementPtr associated with the model loaded from model_uri will have the includeElement set to <uri>model_uri</uri> <pose>1 2 3 0 0 0</pose>

This can be used to retrieve additional information available under the tag after the entity has been loaded. An example use case for this is when saving a loaded world back to SDFormat.

includeFilename

std::string sdf::v11::ElementPrivate::includeFilename

name of the include file that was used to create this element

name

std::string sdf::v11::ElementPrivate::name

Element name.

originalVersion

std::string sdf::v11::ElementPrivate::originalVersion

Spec version that this was originally parsed from.

parent

ElementWeakPtr sdf::v11::ElementPrivate::parent

Element's parent.

path

std::string sdf::v11::ElementPrivate::path

Path to file where this element came from.

referenceSDF

std::string sdf::v11::ElementPrivate::referenceSDF

Name of reference sdf.

required

std::string sdf::v11::ElementPrivate::required

True if element is required.

value

ParamPtr sdf::v11::ElementPrivate::value

---

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

• Element.hh