dynamicgraph::ExceptionAbstract Class Reference

Abstract root class for all dynamic-graph exceptions. More...

#include <dynamic-graph/exception-abstract.h>

Inheritance diagram for dynamicgraph::ExceptionAbstract:
Collaboration diagram for dynamicgraph::ExceptionAbstract:

List of all members.

Classes

class  Param
 Class owned by exceptions to store error locations. More...

Public Types

enum  ExceptionEnum {
  ABSTRACT = 0,
  SIGNAL = 100,
  FACTORY = 200,
  TRACES = 300,
  TOOLS = 700
}
 Categories error code. More...

Public Member Functions

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

Static Public Attributes

static const std::string EXCEPTION_NAME

Protected Attributes

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

Friends

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

Detailed Description

Abstract root class for all dynamic-graph exceptions.


Member Enumeration Documentation

Categories error code.

Each value matches categories used by a subclass of ExceptionAbstract.

This is the programmer responsibility to make sure there is enough room between two categories error code.

Enumerator:
ABSTRACT 
SIGNAL 
FACTORY 
TRACES 
TOOLS 

Constructor & Destructor Documentation

dynamicgraph::ExceptionAbstract::ExceptionAbstract ( const int &  code,
const std::string &  msg = "" 
) [explicit]
virtual dynamicgraph::ExceptionAbstract::~ExceptionAbstract ( ) throw () [inline, virtual]

Member Function Documentation

int dynamicgraph::ExceptionAbstract::getCode ( ) const

Access to the error code.

virtual const std::string& dynamicgraph::ExceptionAbstract::getExceptionName ( ) const [inline, virtual]
const char* dynamicgraph::ExceptionAbstract::getMessage ( ) const

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

Cannot be NULL.

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

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

virtual const char* dynamicgraph::ExceptionAbstract::what ( ) const throw () [inline, virtual]

Friends And Related Function Documentation

DYNAMIC_GRAPH_DLLAPI friend std::ostream& operator<< ( std::ostream &  os,
const ExceptionAbstract err 
) [friend]

Print the error structure.


Member Data Documentation

Error code.

See also:
ErrorCodeEnum

Error message (can be empty).