gazebo::common::Exception Class Reference

Class for generating exceptions. More...

#include <common/common.hh>

Inheritance diagram for gazebo::common::Exception:

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

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

Detailed Description

Class for generating exceptions.

Constructor & Destructor Documentation

gazebo::common::Exception::Exception

(

)

Constructor.

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

Default constructor.

Parameters

[in]	_file	File name
[in]	_line	Line number where the error occurred
[in]	_msg	Error message

virtual gazebo::common::Exception::~Exception ( )

virtual

Destructor.

Member Function Documentation

std::string gazebo::common::Exception::GetErrorFile

(

)

const

Return the error function.

Returns

The error function name

std::string gazebo::common::Exception::GetErrorStr

(

)

const

Return the error string.

Returns

The error string

void gazebo::common::Exception::Print

(

)

const

Print the exception to std out.

Friends And Related Function Documentation

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

friend

stream insertion operator for Gazebo Error

Parameters

[in]	_out	the output stream
[in]	_err	the exception

---

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

• Exception.hh