dynamicgraph::sot::ExceptionAbstract Class Reference

#include <sot/core/exception-abstract.hh>

Inheritance diagram for dynamicgraph::sot::ExceptionAbstract:
[legend]

Public Types

enum  ExceptionEnum {
  ABSTRACT = 0,
  SIGNAL = 100,
  TASK = 200,
  FEATURE = 300,
  FACTORY = 400,
  DYNAMIC = 500,
  TRACES = 600,
  TOOLS = 700,
  PATTERN_GENERATOR = 800
}
 

Public Member Functions

virtual const std::string & getExceptionName (void) const
 
 ExceptionAbstract (const int &code, const std::string &msg="")
 
virtual ~ExceptionAbstract (void) throw ()
 
int getCode (void)
 Access to the error code. More...
 
const std::string & getStringMessage (void)
 Reference access to the error message (can be empty). More...
 
const char * getMessage (void)
 Access to the pointer on the array of char related to the error string. More...
 
const char * what () const throw ()
 

Static Public Attributes

static const std::string EXCEPTION_NAME
 

Protected Attributes

int code
 Error code. More...
 
std::string message
 Error message (can be empty). More...
 

Friends

SOT_CORE_EXPORT friend std::ostream & operator<< (std::ostream &os, const ExceptionAbstract &err)
 Print the error structure. More...
 

Member Enumeration Documentation

◆ ExceptionEnum

Enumerator
ABSTRACT 
SIGNAL 
TASK 
FEATURE 
FACTORY 
DYNAMIC 
TRACES 
TOOLS 
PATTERN_GENERATOR 

Constructor & Destructor Documentation

◆ ExceptionAbstract()

dynamicgraph::sot::ExceptionAbstract::ExceptionAbstract ( const int &  code,
const std::string &  msg = "" 
)

◆ ~ExceptionAbstract()

virtual dynamicgraph::sot::ExceptionAbstract::~ExceptionAbstract ( void  )
throw (
)
inlinevirtual

Member Function Documentation

◆ getCode()

int dynamicgraph::sot::ExceptionAbstract::getCode ( void  )

Access to the error code.

◆ getExceptionName()

virtual const std::string& dynamicgraph::sot::ExceptionAbstract::getExceptionName ( void  ) const
inlinevirtual

◆ getMessage()

const char* dynamicgraph::sot::ExceptionAbstract::getMessage ( void  )

Access to the pointer on the array of char related to the error string.

Cannot be NULL.

◆ getStringMessage()

const std::string& dynamicgraph::sot::ExceptionAbstract::getStringMessage ( void  )

Reference access to the error message (can be empty).

◆ what()

const char* dynamicgraph::sot::ExceptionAbstract::what ( ) const
throw (
)

Friends And Related Function Documentation

◆ operator<<

SOT_CORE_EXPORT friend std::ostream& operator<< ( std::ostream &  os,
const ExceptionAbstract err 
)
friend

Print the error structure.

Member Data Documentation

◆ code

int dynamicgraph::sot::ExceptionAbstract::code
protected

Error code.

See also
ErrorCodeEnum

◆ EXCEPTION_NAME

const std::string dynamicgraph::sot::ExceptionAbstract::EXCEPTION_NAME
static

◆ message

std::string dynamicgraph::sot::ExceptionAbstract::message
protected

Error message (can be empty).