Classes | |
class | sdf::v9::AssertionInternalError |
Class for generating Exceptions which come from sdf assertions. They include information about the assertion expression violated, function where problem appeared and assertion debug message. More... | |
class | sdf::v9::Console |
Message, error, warning, and logging functionality. More... | |
class | sdf::v9::ConsolePrivate |
class | sdf::v9::Console::ConsoleStream |
An ostream-like class that we'll use for logging. More... | |
class | sdf::v9::Element |
SDF Element class. More... | |
class | sdf::v9::ElementPrivate |
class | sdf::v9::Exception |
Class for generating exceptions. More... | |
class | sdf::v9::InternalError |
Class for generating Internal Gazebo Errors: those errors which should never happend and represent programming bugs. More... | |
class | sdf::v9::SDF |
Base SDF class. More... | |
Macros | |
#define | sdfdbg (sdf::Console::Instance()->Log("Dbg", __FILE__, __LINE__)) |
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::v9::ConsolePtr |
Functions | |
sdf::v9::ConsolePrivate::ConsolePrivate () | |
Constructor. More... | |
sdf::v9::Console::ConsoleStream::ConsoleStream (std::ostream *_stream) | |
Constructor. More... | |
virtual | sdf::v9::Console::~Console () |
Destructor. More... | |
SDFORMAT_VISIBLE void | sdf::v9::addURIPath (const std::string &_uri, const std::string &_path) |
Associate paths to a URI. More... | |
static void | sdf::v9::Console::Clear () |
Clear out the current console to make room for a new one. More... | |
ConsoleStream & | sdf::v9::Console::ColorMsg (const std::string &lbl, const std::string &file, unsigned int line, int color) |
Use this to output a colored message to the terminal. More... | |
SDFORMAT_VISIBLE std::string | sdf::v9::findFile (const std::string &_filename, bool _searchLocalPath=true, bool _useCallback=false) |
Find the absolute path of a file. More... | |
template<typename T > | |
std::pair< T, bool > | sdf::v9::Element::Get (const std::string &_key, const T &_defaultValue) const |
Get the value of a key. More... | |
template<typename T > | |
bool | sdf::v9::Element::Get (const std::string &_key, T &_param, const T &_defaultValue) const |
Get the value of a key. More... | |
template<typename T > | |
T | sdf::v9::Element::Get (const std::string &_key="") const |
Get the value of a key. More... | |
ConsoleStream & | sdf::v9::Console::GetLogStream () |
Get the current log stream object. More... | |
ConsoleStream & | sdf::v9::Console::GetMsgStream () |
Get the current message stream object. More... | |
std::ostream * | sdf::v9::Console::ConsoleStream::GetStream () |
Get the current stream object. More... | |
static ConsolePtr | sdf::v9::Console::Instance () |
Return an instance to this class. More... | |
ConsoleStream & | sdf::v9::Console::Log (const std::string &lbl, const std::string &file, unsigned int line) |
Use this to output a message to a log file. More... | |
template<class T > | |
ConsoleStream & | sdf::v9::Console::ConsoleStream::operator<< (const T &_rhs) |
Redirect whatever is passed in to both our ostream (if non-NULL) and the log file (if open). More... | |
void | sdf::v9::Console::ConsoleStream::Prefix (const std::string &_lbl, const std::string &_file, unsigned int _line, int _color) |
Print a prefix to both terminal and log file. More... | |
template<typename T > | |
bool | sdf::v9::Element::Set (const T &_value) |
Set the value of this element. More... | |
SDFORMAT_VISIBLE void | sdf::v9::setFindCallback (std::function< std::string(const std::string &)> _cb) |
Set the callback to use when SDF can't find a file. More... | |
void | sdf::v9::Console::SetQuiet (bool _q) |
Set quiet output. More... | |
void | sdf::v9::Console::ConsoleStream::SetStream (std::ostream *_stream) |
Set the stream object. More... | |
Variables | |
std::ofstream | sdf::v9::ConsolePrivate::logFileStream |
logfile stream More... | |
Console::ConsoleStream | sdf::v9::ConsolePrivate::logStream |
log stream More... | |
Console::ConsoleStream | sdf::v9::ConsolePrivate::msgStream |
message stream More... | |
#define sdfdbg (sdf::Console::Instance()->Log("Dbg", __FILE__, __LINE__)) |
Output a debug message.
#define sdferr |
Output an error message.
#define sdfmsg |
Output a message.
#define sdfthrow | ( | msg | ) |
This macro logs an error to the throw stream and throws an exception that contains the file name and line number.
#define sdfwarn |
Output a warning message.
typedef std::shared_ptr<Console> sdf::v9::ConsolePtr |
|
inline |
Constructor.
|
inlineexplicit |
Constructor.
[in] | _stream | Pointer to an output stream operator. Can be NULL/nullptr. |
|
virtual |
Destructor.
SDFORMAT_VISIBLE void sdf::v9::addURIPath | ( | const std::string & | _uri, |
const std::string & | _path | ||
) |
Associate paths to a URI.
Example paramters: "model://", "/usr/share/models:~/.gazebo/models"
[in] | _uri | URI that will be mapped to _path |
[in] | _path | Colon separated set of paths. |
|
static |
Clear out the current console to make room for a new one.
ConsoleStream& sdf::v9::Console::ColorMsg | ( | const std::string & | lbl, |
const std::string & | file, | ||
unsigned int | line, | ||
int | color | ||
) |
Use this to output a colored message to the terminal.
[in] | _lbl | Text label |
[in] | _file | File containing the error |
[in] | _line | Line containing the error |
[in] | _color | Color to make the label |
SDFORMAT_VISIBLE std::string sdf::v9::findFile | ( | const std::string & | _filename, |
bool | _searchLocalPath = true , |
||
bool | _useCallback = false |
||
) |
Find the absolute path of a file.
[in] | _filename | Name of the file to find. |
[in] | _searchLocalPath | True to search for the file in the current working directory. |
[in] | _useCallback | True to find a file based on a registered callback if the file is not found via the normal mechanism. |
std::pair< T, bool > sdf::v9::Element::Get | ( | const std::string & | _key, |
const T & | _defaultValue | ||
) | const |
Get the value of a key.
[in] | _key | the name of a child attribute or element. |
[in] | _defaultValue | a default value to use if _key is not found. |
bool sdf::v9::Element::Get | ( | const std::string & | _key, |
T & | _param, | ||
const T & | _defaultValue | ||
) | const |
Get the value of a key.
[in] | _key | the name of a child attribute or element. |
[out] | _param | the parameter output |
[in] | _defaultValue | a default value to use if _key is not found. |
T sdf::v9::Element::Get | ( | const std::string & | _key = "" | ) | const |
Get the value of a key.
This function assumes the _key exists.
[in] | _key | the name of a child attribute or element. |
ConsoleStream& sdf::v9::Console::GetLogStream | ( | ) |
Get the current log stream object.
This can be useful for redirecting the output, for example, to a std::stringstream for testing.
ConsoleStream& sdf::v9::Console::GetMsgStream | ( | ) |
Get the current message stream object.
This can be useful for redirecting the output, for example, to a std::stringstream for testing.
std::ostream* sdf::v9::Console::ConsoleStream::GetStream | ( | ) |
Get the current stream object.
|
static |
Return an instance to this class.
ConsoleStream& sdf::v9::Console::Log | ( | const std::string & | lbl, |
const std::string & | file, | ||
unsigned int | line | ||
) |
Use this to output a message to a log file.
ConsoleStream& sdf::v9::Console::ConsoleStream::operator<< | ( | const T & | _rhs | ) |
Redirect whatever is passed in to both our ostream (if non-NULL) and the log file (if open).
[in] | _rhs | Content to be logged. |
void sdf::v9::Console::ConsoleStream::Prefix | ( | const std::string & | _lbl, |
const std::string & | _file, | ||
unsigned int | _line, | ||
int | _color | ||
) |
Print a prefix to both terminal and log file.
[in] | _lbl | Text label |
[in] | _file | File containing the error |
[in] | _line | Line containing the error |
[in] | _color | Color to make the label. Used only on terminal. |
bool sdf::v9::Element::Set | ( | const T & | _value | ) |
Set the value of this element.
[in] | _value | the value to set. |
SDFORMAT_VISIBLE void sdf::v9::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.
[in] | _cb | The callback function. |
void sdf::v9::Console::SetQuiet | ( | bool | _q | ) |
Set quiet output.
[in] | q | True to prevent warning |
void sdf::v9::Console::ConsoleStream::SetStream | ( | std::ostream * | _stream | ) |
Set the stream object.
[in] | _stream | Pointer to an output stream. This can be useful for redirecting the output, for example, to a std::stringstream for testing. |
std::ofstream sdf::v9::ConsolePrivate::logFileStream |
logfile stream
Console::ConsoleStream sdf::v9::ConsolePrivate::logStream |
log stream
Console::ConsoleStream sdf::v9::ConsolePrivate::msgStream |
message stream