Public Member Functions | Public Attributes
Element Class Reference

SDF Element class. More...

#include <SDF.hh>

List of all members.

Public Member Functions

boost::shared_ptr< ElementClone () const
void Copy (const ElementPtr &_elem)
 Copy values from an Element.
ElementPtr GetParent () const
void SetParent (const ElementPtr &_parent)
std::string GetLinkName () const
 Get the name of the parent link.
std::string GetModelName () const
 Get the name of the parent model.
std::string GetWorldName () const
 Get the name of the parent world.
void SetName (const std::string &_name)
const std::string & GetName () const
void SetRequired (const std::string &_req)
const std::string & GetRequired () const
void SetCopyChildren (bool _value)
bool GetCopyChildren () const
void PrintDescription (std::string _prefix)
void PrintValues (std::string _prefix)
std::string ToString (const std::string &_prefix) const
void AddAttribute (const std::string &_key, const std::string &_type, const std::string &_defaultvalue, bool _required)
void AddValue (const std::string &_type, const std::string &_defaultValue, bool _required)
ParamPtr GetAttribute (const std::string &_key)
 Get the param of an attribute.
bool HasAttribute (const std::string &_key)
ParamPtr GetValue ()
 Get the param of the elements value.
bool GetValueBool (const std::string &_key="")
int GetValueInt (const std::string &_key="")
float GetValueFloat (const std::string &_key="")
double GetValueDouble (const std::string &_key="")
unsigned int GetValueUInt (const std::string &_key="")
char GetValueChar (const std::string &_key="")
std::string GetValueString (const std::string &_key="")
gazebo::math::Vector3 GetValueVector3 (const std::string &_key="")
gazebo::math::Quaternion GetValueQuaternion (const std::string &_key="")
gazebo::math::Pose GetValuePose (const std::string &_key="")
gazebo::common::Color GetValueColor (const std::string &_key="")
bool HasElement (const std::string &_name) const
ElementPtr GetElement (const std::string &_name) const
ElementPtr GetFirstElement () const
ElementPtr GetNextElement (const std::string &_name) const
ElementPtr GetNextElement () const
ElementPtr GetOrCreateElement (const std::string &_name)
ElementPtr AddElement (const std::string &_name)
void InsertElement (ElementPtr _elem)
void ClearElements ()
void Update ()
void Reset ()

Public Attributes

Param_V attributes
ParamPtr value
ElementPtr_V elements
ElementPtr_V elementDescriptions

Detailed Description

SDF Element class.


Member Function Documentation

ParamPtr GetAttribute ( const std::string &  _key)

Get the param of an attribute.

Parameters:
_keythe name of the attribute
std::string GetLinkName ( ) const

Get the name of the parent link.

Returns:
Name of parent link, or empty string if no parent link exists.
std::string GetModelName ( ) const

Get the name of the parent model.

Returns:
Name of parent model, or empty string if no parent model exists.
std::string GetWorldName ( ) const

Get the name of the parent world.

Returns:
Name of parent world, or empty string if no parent world exists.

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