Base SDF class.
More...
#include <SDFImpl.hh>
◆ SDF()
◆ ~SDF()
◆ Clear()
void sdf::v12::SDF::Clear |
( |
| ) |
|
Clear the data in this object.
◆ EmbeddedSpec()
static const std::string& sdf::v12::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::v12::SDF::FilePath |
( |
| ) |
const |
Get the path to the SDF document on disk.
- Returns
- The full path to the SDF document.
◆ OriginalVersion()
const std::string& sdf::v12::SDF::OriginalVersion |
( |
| ) |
const |
Get the spec version that this was originally parsed from.
- Returns
- Spec version string.
◆ PrintDescription()
void sdf::v12::SDF::PrintDescription |
( |
| ) |
|
◆ PrintDoc()
void sdf::v12::SDF::PrintDoc |
( |
| ) |
|
◆ PrintValues()
Output SDF's values to stdout.
- Parameters
-
[in] | _config | Configuration for printing the values. |
◆ Root() [1/2]
Get a pointer to the root element.
- Returns
- Pointer to the root element
◆ Root() [2/2]
void sdf::v12::SDF::Root |
( |
const ElementPtr |
_root | ) |
|
Set the root pointer.
- Parameters
-
◆ SetFilePath()
void sdf::v12::SDF::SetFilePath |
( |
const std::string & |
_path | ) |
|
Set the path on disk.
- Parameters
-
◆ SetFromString()
void sdf::v12::SDF::SetFromString |
( |
const std::string & |
_sdfData | ) |
|
Set SDF values from a string.
◆ SetOriginalVersion()
void sdf::v12::SDF::SetOriginalVersion |
( |
const std::string & |
_version | ) |
|
Set the spec version that this was originally parsed from.
- Parameters
-
[in] | _version | Spec version string. |
◆ ToString()
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::v12::SDF::Version |
( |
| ) |
|
|
static |
Get the version.
- Returns
- The version as a string
◆ Version() [2/2]
static void sdf::v12::SDF::Version |
( |
const std::string & |
_version | ) |
|
|
static |
Set the version string.
- Parameters
-
[in] | _version | SDF version string. |
◆ WrapInRoot()
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::v12::SDF::Write |
( |
const std::string & |
_filename | ) |
|
The documentation for this class was generated from the following file: