All Classes Namespaces Files Functions Variables Typedefs Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
sdf::SDF Class Reference

Base SDF class. More...

#include <SDFImpl.hh>

Public Member Functions

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

Static Public Member Functions

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 ( )
sdf::SDF::~SDF ( )

Destructor.

Member Function Documentation

void sdf::SDF::PrintDescription ( )
void sdf::SDF::PrintDoc ( )
void sdf::SDF::PrintValues ( )
void sdf::SDF::PrintWiki ( )
ElementPtr sdf::SDF::Root ( ) const

Get a pointer to the root element.

Returns
Pointer to the root element
void sdf::SDF::Root ( const ElementPtr  _root)

Set the root pointer.

Parameters
[in]_rootRoot element
void sdf::SDF::SetFromString ( const std::string &  _sdfData)

Set SDF values from a string.

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

Get the version.

Returns
The version as a string
static void sdf::SDF::Version ( const std::string &  _version)
static

Set the version string.

Parameters
[in]_versionSDF version string.
static 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
void sdf::SDF::Write ( const std::string &  _filename)

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