sdf::SDF_VERSION_NAMESPACE::SDF Class Reference

Base SDF class. More...

#include <SDFImpl.hh>

Public Member Functions
	SDF ()
	~SDF ()
	Destructor. More...
void	Clear ()
	Clear the data in this object. More...
std::string	FilePath () const
	Get the path to the SDF document on disk. More...
	GZ_DEPRECATED (13) void Root(const ElementPtr _root)
	Set the root pointer. More...
const std::string &	OriginalVersion () const
	Get the spec version that this was originally parsed from. More...
void	PrintDescription ()
void	PrintDoc ()
void	PrintValues (const PrintConfig &_config=PrintConfig())
	Output SDF's values to stdout. More...
ElementPtr	Root () const
	Get a pointer to the root element. More...
void	SetFilePath (const std::string &_path)
	Set the path on disk. More...
void	SetFromString (const std::string &_sdfData)
	Set SDF values from a string. More...
void	SetOriginalVersion (const std::string &_version)
	Set the spec version that this was originally parsed from. More...
void	SetRoot (const ElementPtr _root)
	Set the root pointer. More...
std::string	ToString (const PrintConfig &_config=PrintConfig()) const
	Convert the SDF values to a string representation. More...
void	Write (const std::string &_filename)

Static Public Member Functions
static const std::string &	EmbeddedSpec (const std::string &_filename, const bool _quiet)
	Get a string representation of an SDF specification file. More...
static std::string	Version ()
	Get the version. More...
static void	Version (const std::string &_version)
	Set the version string. More...
static ElementPtr	WrapInRoot (const ElementPtr &_sdf)
	wraps the SDF element into a root element with the version info. More...

Detailed Description

Base SDF class.

Constructor & Destructor Documentation

SDF()

sdf::SDF_VERSION_NAMESPACE::SDF::SDF

(

)

~SDF()

sdf::SDF_VERSION_NAMESPACE::SDF::~SDF

(

)

Destructor.

Member Function Documentation

Clear()

void sdf::SDF_VERSION_NAMESPACE::SDF::Clear

(

)

Clear the data in this object.

EmbeddedSpec()

static const std::string& sdf::SDF_VERSION_NAMESPACE::SDF::EmbeddedSpec ( const std::string &  _filename, const bool  _quiet  )

static

Get a string representation of an SDF specification file.

This function uses a built-in version of a .sdf file located in the sdf directory. The parser.cc code uses this function, which avoids touching the filesystem.

Most people should not use this function.

Parameters

[in]	_filename	Base name of the SDF specification file to load. For example "root.sdf" or "world.sdf".
[in]	_quiet	True to suppress console messages.

Returns

A string that contains the contents of the specified _filename. An empty string is returned if the _filename could not be found.

FilePath()

std::string sdf::SDF_VERSION_NAMESPACE::SDF::FilePath

(

)

const

Get the path to the SDF document on disk.

Returns

The full path to the SDF document.

GZ_DEPRECATED()

sdf::SDF_VERSION_NAMESPACE::SDF::GZ_DEPRECATED

(

13

)

const

Set the root pointer.

Parameters

[in]

_root

Root element

Deprecated:

Use SetRoot

OriginalVersion()

const std::string& sdf::SDF_VERSION_NAMESPACE::SDF::OriginalVersion

(

)

const

Get the spec version that this was originally parsed from.

Returns

Spec version string.

PrintDescription()

void sdf::SDF_VERSION_NAMESPACE::SDF::PrintDescription

(

)

PrintDoc()

void sdf::SDF_VERSION_NAMESPACE::SDF::PrintDoc

(

)

PrintValues()

void sdf::SDF_VERSION_NAMESPACE::SDF::PrintValues

(

const PrintConfig &

_config = PrintConfig()

)

Output SDF's values to stdout.

Parameters

[in]

_config

Configuration for printing the values.

Root()

ElementPtr sdf::SDF_VERSION_NAMESPACE::SDF::Root

(

)

const

Get a pointer to the root element.

Returns

Pointer to the root element

SetFilePath()

void sdf::SDF_VERSION_NAMESPACE::SDF::SetFilePath

(

const std::string &

_path

)

Set the path on disk.

Parameters

[in]

_path

Path on disk.

SetFromString()

void sdf::SDF_VERSION_NAMESPACE::SDF::SetFromString

(

const std::string &

_sdfData

)

Set SDF values from a string.

SetOriginalVersion()

void sdf::SDF_VERSION_NAMESPACE::SDF::SetOriginalVersion

(

const std::string &

_version

)

Set the spec version that this was originally parsed from.

Parameters

[in]

_version

Spec version string.

SetRoot()

void sdf::SDF_VERSION_NAMESPACE::SDF::SetRoot

(

const ElementPtr

_root

)

Set the root pointer.

Parameters

[in]

_root

Root element

ToString()

std::string sdf::SDF_VERSION_NAMESPACE::SDF::ToString

(

const PrintConfig &

_config = PrintConfig()

)

const

Convert the SDF values to a string representation.

Parameters

[in]

_config

Configuration for printing the values.

Returns

The string representation.

Version() [1/2]

static std::string sdf::SDF_VERSION_NAMESPACE::SDF::Version ( )

static

Get the version.

Returns

The version as a string

Version() [2/2]

static void sdf::SDF_VERSION_NAMESPACE::SDF::Version ( const std::string &  _version )

static

Set the version string.

Parameters

[in]

_version

SDF version string.

WrapInRoot()

static ElementPtr sdf::SDF_VERSION_NAMESPACE::SDF::WrapInRoot ( const ElementPtr &  _sdf )

static

wraps the SDF element into a root element with the version info.

Parameters

[in]

_sdf

the sdf element. Will be cloned by this function.

Returns

a wrapped clone of the SDF element

Write()

void sdf::SDF_VERSION_NAMESPACE::SDF::Write

(

const std::string &

_filename

)

---

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

• SDFImpl.hh