Exception Class Reference

Class for generating exceptions. More...

#include <common/common.hh>

Inherited by InternalError.

Public Member Functions

 Exception ()
 Constructor. More...
 
 Exception (const char *_file, int _line, std::string _msg)
 Default constructor. More...
 
virtual ~Exception ()
 Destructor. More...
 
std::string GetErrorFile () const
 Return the error function. More...
 
std::string GetErrorStr () const
 Return the error string. More...
 
void Print () const
 Print the exception to std out. More...
 

Friends

std::ostream & operator<< (std::ostream &_out, const gazebo::common::Exception &_err)
 stream insertion operator for Gazebo Error More...
 

Detailed Description

Class for generating exceptions.

Constructor & Destructor Documentation

◆ Exception() [1/2]

Exception ( )

Constructor.

◆ Exception() [2/2]

Exception ( const char *  _file,
int  _line,
std::string  _msg 
)

Default constructor.

Parameters
[in]_fileFile name
[in]_lineLine number where the error occurred
[in]_msgError message

◆ ~Exception()

virtual ~Exception ( )
virtual

Destructor.

Member Function Documentation

◆ GetErrorFile()

std::string GetErrorFile ( ) const

Return the error function.

Returns
The error function name

◆ GetErrorStr()

std::string GetErrorStr ( ) const

Return the error string.

Returns
The error string

◆ Print()

void Print ( ) const

Print the exception to std out.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  _out,
const gazebo::common::Exception _err 
)
friend

stream insertion operator for Gazebo Error

Parameters
[in]_outthe output stream
[in]_errthe exception

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