Loading...
Searching...
No Matches
sdf::SDF Class Reference

Base SDF class. More...

#include <SDFImpl.hh>

Public Member Functions

 SDF ()
 ~SDF ()
 Destructor.
void PrintDescription ()
void PrintDoc ()
void PrintValues ()
ElementPtr Root () const
 Get a pointer to the root element.
void Root (const ElementPtr _root)
 Set the root pointer.
void SetFromString (const std::string &_sdfData)
 Set SDF values from a string.
std::string ToString () const
void Write (const std::string &_filename)

Static Public Member Functions

static std::string Version ()
 Get the version.
static void Version (const std::string &_version)
 Set the version string.
static ElementPtr WrapInRoot (const ElementPtr &_sdf)
 wraps the SDF element into a root element with the version info.

Detailed Description

Base SDF class.

Constructor & Destructor Documentation

◆ SDF()

sdf::SDF::SDF ( )

◆ ~SDF()

sdf::SDF::~SDF ( )

Destructor.

Member Function Documentation

◆ PrintDescription()

void sdf::SDF::PrintDescription ( )

◆ PrintDoc()

void sdf::SDF::PrintDoc ( )

◆ PrintValues()

void sdf::SDF::PrintValues ( )

◆ Root() [1/2]

ElementPtr sdf::SDF::Root ( ) const

Get a pointer to the root element.

Returns
Pointer to the root element

◆ Root() [2/2]

void sdf::SDF::Root ( const ElementPtr _root)

Set the root pointer.

Parameters
[in]_rootRoot element

◆ SetFromString()

void sdf::SDF::SetFromString ( const std::string & _sdfData)

Set SDF values from a string.

◆ ToString()

std::string sdf::SDF::ToString ( ) const

◆ Version() [1/2]

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

Get the version.

Returns
The version as a string

◆ Version() [2/2]

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

Set the version string.

Parameters
[in]_versionSDF version string.

◆ WrapInRoot()

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

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

Parameters
[in]_sdfthe sdf element. Will be cloned by this function.
Returns
a wrapped clone of the SDF element

◆ Write()

void sdf::SDF::Write ( const std::string & _filename)

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