hsds::Exception Class Reference

Exception class for HSDS libraries. More...

#include <exception.hpp>

Inheritance diagram for hsds::Exception:

Public Member Functions
	Exception (const std::string &message, const char *filename, const char *func, uint32_t line)
	Constructor. More...
	~Exception () throw ()
	Destructor. More...
const char *	what () const throw ()
	Returns exception message as null terminated character sequence. More...
const char *	getFileName () const
	Returns file name of the exception occurred. More...
const char *	getFunctionName () const
	Returns function name of the exception occurred. More...
const int	getLineNumber () const
	Returns line number of the exception occurred. More...

Friends
std::ostream &	operator<< (std::ostream &os, hsds::Exception &e)

Detailed Description

Exception class for HSDS libraries.

Definition at line 49 of file exception.hpp.

Constructor & Destructor Documentation

hsds::Exception::Exception ( const std::string &  message, const char *  filename, const char *  func, uint32_t  line  )

inline

Constructor.

Parameters

[in]	message	Description message of the exception
[in]	filename	Name of file that exception occurred
[in]	func	Name of function that exception occurred
[in]	line	Number of line that exception occurred

Definition at line 60 of file exception.hpp.

hsds::Exception::~Exception ( ) throw ()

inline

Destructor.

Definition at line 68 of file exception.hpp.

Member Function Documentation

const char* hsds::Exception::getFileName ( ) const

inline

Returns file name of the exception occurred.

Returns

File name

Definition at line 86 of file exception.hpp.

const char* hsds::Exception::getFunctionName ( ) const

inline

Returns function name of the exception occurred.

Returns

Function name

Definition at line 95 of file exception.hpp.

const int hsds::Exception::getLineNumber ( ) const

inline

Returns line number of the exception occurred.

Returns

Line number

Definition at line 104 of file exception.hpp.

const char* hsds::Exception::what ( ) const throw ()

inline

Returns exception message as null terminated character sequence.

Returns

Exception message

Definition at line 77 of file exception.hpp.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, hsds::Exception &  e  )

friend

Definition at line 117 of file exception.hpp.

---

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

• include/hsds/exception.hpp