iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nrt::exception::BadParameter Class Reference

#include <nrt/Core/Model/ParameterExceptions.H>

Exception that Parameter callbacks should throw if they reject the candidate new value.

Definition at line 50 of file ParameterExceptions.H.

Inheritance diagram for nrt::exception::BadParameter:
nrt::exception::Exception

Public Member Functions

 BadParameter (std::string const &explanation_) throw ()
 Constructor. More...
 
virtual ~BadParameter () throw ()
 Destructor.
 
- Public Member Functions inherited from nrt::exception::Exception
 Exception () throw ()
 Constructor with a default non-specific error message.
 
 Exception (char const *msg) throw ()
 Constructor with a given error message. More...
 
 Exception (Exception const &e) throw ()
 Copy constructor.
 
virtual ~Exception () throw ()
 Virtual destructor for safe inheritance.
 
Exceptionoperator= (Exception const &e) throw ()
 Assignment.
 
char const * what () const throw ()
 Return a C string describing the error. More...
 

Additional Inherited Members

- Protected Attributes inherited from nrt::exception::Exception
char const * whatptr
 Pointer to a message, returned by what()
 

Constructor & Destructor Documentation

nrt::exception::BadParameter::BadParameter ( std::string const &  explanation_)
throw (
)

Constructor.

Provide here an explanation of why your callback is rejecting the candidate new parameter value. No need to explain which value, what callback, which parameter, etc as all this will be added automatically by a wrapper around your callback, which will rethrow your BadParameter as a more verbose ParameterException for end users to catch.


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