All Classes Namespaces Files Functions Variables Typedefs Friends Macros Groups Pages
Classes | Macros | Typedefs | Functions
SDF

Classes

class  sdf::AssertionInternalError
 Class for generating Exceptions which come from sdf assertions. More...
 
class  sdf::Console
 Message, error, warning, and logging functionality. More...
 
class  sdf::ConsolePrivate
 
class  sdf::Element
 SDF Element class. More...
 
class  sdf::ElementPrivate
 
class  sdf::Exception
 Class for generating exceptions. More...
 
class  sdf::InternalError
 Class for generating Internal Gazebo Errors: those errors which should never happend and represent programming bugs. More...
 
class  sdf::SDF
 Base SDF class. More...
 

Macros

#define sdfdbg
 Output a debug message. More...
 
#define sdferr
 Output an error message. More...
 
#define sdfmsg
 Output a message. More...
 
#define sdfthrow(msg)
 This macro logs an error to the throw stream and throws an exception that contains the file name and line number. More...
 
#define sdfwarn
 Output a warning message. More...
 

Typedefs

typedef std::shared_ptr< Console > sdf::ConsolePtr
 

Functions

SDFORMAT_VISIBLE void sdf::addURIPath (const std::string &_uri, const std::string &_path)
 Associate paths to a URI. More...
 
SDFORMAT_VISIBLE std::string sdf::findFile (const std::string &_filename, bool _searchLocalPath=true, bool _useCallback=false)
 Find the absolute path of a file. More...
 
template<typename T >
sdf::Element::Get (const std::string &_key="")
 
template<class T >
Console::ConsoleStream & sdf::Console::ConsoleStream::operator<< (const T &_rhs)
 
template<typename T >
bool sdf::Element::Set (const T &_value)
 
SDFORMAT_VISIBLE void sdf::setFindCallback (std::function< std::string(const std::string &)> _cb)
 Set the callback to use when SDF can't find a file. More...
 

Detailed Description

Macro Definition Documentation

#define sdfdbg
Value:
(sdf::Console::Instance()->Log("Dbg", \
__FILE__, __LINE__))
static ConsolePtr Instance()
Return an instance to this class.

Output a debug message.

#define sdferr
Value:
(sdf::Console::Instance()->ColorMsg("Error", \
__FILE__, __LINE__, 31))
static ConsolePtr Instance()
Return an instance to this class.

Output an error message.

Referenced by sdf::Param::Get(), sdf::Element::Get(), sdf::Param::GetDefault(), and sdf::Param::Set().

#define sdfmsg
Value:
(sdf::Console::Instance()->ColorMsg("Msg", \
__FILE__, __LINE__, 32))
static ConsolePtr Instance()
Return an instance to this class.

Output a message.

#define sdfthrow (   msg)
Value:
{std::ostringstream throwStream;\
throwStream << msg << std::endl << std::flush;\
throw sdf::Exception(__FILE__, __LINE__, throwStream.str()); }
Class for generating exceptions.
Definition: Exception.hh:43

This macro logs an error to the throw stream and throws an exception that contains the file name and line number.

#define sdfwarn
Value:
(sdf::Console::Instance()->ColorMsg("Warning", \
__FILE__, __LINE__, 33))
static ConsolePtr Instance()
Return an instance to this class.

Output a warning message.

Typedef Documentation

typedef std::shared_ptr<Console> sdf::ConsolePtr

Function Documentation

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

Associate paths to a URI.

Example paramters: "model://", "/usr/share/models:~/.gazebo/models"

Parameters
[in]_uriURI that will be mapped to _path
[in]_pathColon separated set of paths.
SDFORMAT_VISIBLE std::string sdf::findFile ( const std::string &  _filename,
bool  _searchLocalPath = true,
bool  _useCallback = false 
)

Find the absolute path of a file.

Parameters
[in]_filenameName of the file to find.
[in]_searchLocalPathTrue to search for the file in the current working directory.
[in]_useCallbackTrue to find a file based on a registered callback if the file is not found via the normal mechanism.
template<typename T >
T sdf::Element::Get ( const std::string &  _key = "")
template<class T >
Console::ConsoleStream& sdf::Console::ConsoleStream::operator<< ( const T &  _rhs)
template<typename T >
bool sdf::Element::Set ( const T &  _value)
SDFORMAT_VISIBLE void sdf::setFindCallback ( std::function< std::string(const std::string &)>  _cb)

Set the callback to use when SDF can't find a file.

The callback should return a complete path to the requested file, or and empty string if the file was not found in the callback.

Parameters
[in]_cbThe callback function.