Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | Private Member Functions | Friends | List of all members
dynamicgraph::sot::ExceptionAbstract Class Reference

#include <exception-abstract.hh>

Inheritance diagram for dynamicgraph::sot::ExceptionAbstract:
Inheritance graph
[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

 ExceptionAbstract (const int &code, const std::string &msg="")
 
int getCode (void)
 
virtual const std::string & getExceptionName (void) const
 
const char * getMessage (void)
 
const std::string & getStringMessage (void)
 
const char * what () const throw ()
 
virtual ~ExceptionAbstract (void) throw ()
 

Static Public Attributes

static const std::string EXCEPTION_NAME = "Abstract"
 

Protected Attributes

int code
 
std::string message
 

Private Member Functions

 ExceptionAbstract (void)
 

Friends

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

Detailed Description

Definition at line 36 of file exception-abstract.hh.

Member Enumeration Documentation

◆ ExceptionEnum

Enumerator
ABSTRACT 
SIGNAL 
TASK 
FEATURE 
FACTORY 
DYNAMIC 
TRACES 
TOOLS 
PATTERN_GENERATOR 

Definition at line 38 of file exception-abstract.hh.

Constructor & Destructor Documentation

◆ ExceptionAbstract() [1/2]

dynamicgraph::sot::ExceptionAbstract::ExceptionAbstract ( void  )
private

forbid the empty constructor (private).

◆ ExceptionAbstract() [2/2]

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

◆ ~ExceptionAbstract()

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

Definition at line 69 of file exception-abstract.hh.

Member Function Documentation

◆ getCode()

int ExceptionAbstract::getCode ( void  )

Access to the error code.

Definition at line 42 of file exception-abstract.cpp.

◆ getExceptionName()

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

Definition at line 51 of file exception-abstract.hh.

◆ getMessage()

const char * ExceptionAbstract::getMessage ( void  )

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

Definition at line 34 of file exception-abstract.cpp.

◆ getStringMessage()

const string & ExceptionAbstract::getStringMessage ( void  )

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

Definition at line 38 of file exception-abstract.cpp.

◆ what()

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

Definition at line 44 of file exception-abstract.cpp.

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

Definition at line 58 of file exception-abstract.hh.

◆ EXCEPTION_NAME

const std::string ExceptionAbstract::EXCEPTION_NAME = "Abstract"
static

Definition at line 50 of file exception-abstract.hh.

◆ message

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

Error message (can be empty).

Definition at line 61 of file exception-abstract.hh.


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


sot-core
Author(s): Olivier Stasse, ostasse@laas.fr
autogenerated on Wed Jun 21 2023 02:51:27