sdf Namespace Reference

namespace for Simulation Description Format parser More...

Classes
class	Converter
	Convert from one version of SDF to another. More...
class	Element
	SDF Element class. More...
class	Param
	A parameter class. More...
class	ParamT
	Templatized parameter class. More...
class	Plugin
class	SDF
	Base SDF class. More...

Typedefs
typedef boost::shared_ptr < Element >	ElementPtr
typedef std::vector< ElementPtr >	ElementPtr_V
typedef std::vector< ParamPtr >	Param_V
typedef boost::shared_ptr< Param >	ParamPtr
typedef boost::shared_ptr< SDF >	SDFPtr

Functions
void	addNestedModel (ElementPtr _sdf, ElementPtr _includeSDF)
void	addURIPath (const std::string &_uri, const std::string &_path)
	A function that is used in the external SDF library.
void	copyChildren (ElementPtr _sdf, TiXmlElement *_xml)
bool	init (SDFPtr _sdf)
	Init based on the installed sdf_format.xml file.
bool	initDoc (TiXmlDocument *_xmlDoc, SDFPtr _sdf)
bool	initDoc (TiXmlDocument *_xmlDoc, ElementPtr _sdf)
bool	initFile (const std::string &_filename, SDFPtr _sdf)
bool	initFile (const std::string &_filename, ElementPtr _sdf)
bool	initString (const std::string &_xmlString, SDFPtr _sdf)
bool	initXml (TiXmlElement *_xml, ElementPtr _sdf)
bool	readDoc (TiXmlDocument *_xmlDoc, SDFPtr _sdf, const std::string &_source)
	Populate the SDF values from a TinyXML document.
bool	readDoc (TiXmlDocument *_xmlDoc, ElementPtr _sdf, const std::string &_source)
bool	readFile (const std::string &_filename, SDFPtr _sdf)
	Populate the SDF values from a file.
bool	readString (const std::string &_xmlString, SDFPtr _sdf)
	Populate the SDF values from a string.
bool	readString (const std::string &_xmlString, ElementPtr _sdf)
bool	readXml (TiXmlElement *_xml, ElementPtr _sdf)
void	setFindCallback (boost::function< std::string(const std::string &)> _cb)
	A function that is used in the external SDF library.

Detailed Description

namespace for Simulation Description Format parser

Typedef Documentation

typedef boost::shared_ptr<Element> sdf::ElementPtr

typedef std::vector< ElementPtr > sdf::ElementPtr_V

typedef std::vector< ParamPtr > sdf::Param_V

typedef boost::shared_ptr< Param > sdf::ParamPtr

typedef boost::shared_ptr<SDF> sdf::SDFPtr

Function Documentation

void sdf::addNestedModel	(	ElementPtr	_sdf,
		ElementPtr	_includeSDF
	)

void sdf::addURIPath	(	const std::string &	_uri,
		const std::string &	_path
	)

A function that is used in the external SDF library.

This is here to make the build work if the external SDF library is not present.

void sdf::copyChildren	(	ElementPtr	_sdf,
		TiXmlElement *	_xml
	)

bool sdf::init

(

SDFPtr

_sdf

)

Init based on the installed sdf_format.xml file.

bool sdf::initDoc	(	TiXmlDocument *	_xmlDoc,
		SDFPtr	_sdf
	)

bool sdf::initDoc	(	TiXmlDocument *	_xmlDoc,
		ElementPtr	_sdf
	)

bool sdf::initFile	(	const std::string &	_filename,
		SDFPtr	_sdf
	)

bool sdf::initFile	(	const std::string &	_filename,
		ElementPtr	_sdf
	)

bool sdf::initString	(	const std::string &	_xmlString,
		SDFPtr	_sdf
	)

bool sdf::initXml	(	TiXmlElement *	_xml,
		ElementPtr	_sdf
	)

bool sdf::readDoc	(	TiXmlDocument *	_xmlDoc,
		SDFPtr	_sdf,
		const std::string &	_source
	)

Populate the SDF values from a TinyXML document.

bool sdf::readDoc	(	TiXmlDocument *	_xmlDoc,
		ElementPtr	_sdf,
		const std::string &	_source
	)

bool sdf::readFile	(	const std::string &	_filename,
		SDFPtr	_sdf
	)

Populate the SDF values from a file.

bool sdf::readString	(	const std::string &	_xmlString,
		SDFPtr	_sdf
	)

Populate the SDF values from a string.

bool sdf::readString	(	const std::string &	_xmlString,
		ElementPtr	_sdf
	)

bool sdf::readXml	(	TiXmlElement *	_xml,
		ElementPtr	_sdf
	)

void sdf::setFindCallback

(

boost::function< std::string(const std::string &)>

_cb

)

A function that is used in the external SDF library.

This is here to make the build work if the external SDF library is not present.