NEST  2.6.0,not_revisioned_source_dir@0
Public Member Functions | Private Attributes | List of all members
nest::TimeMultipleRequired Class Reference

Exception to be thrown if a Time object should be a multiple of another. More...

#include <exceptions.h>

Inheritance diagram for nest::TimeMultipleRequired:
nest::KernelException SLIException

Public Member Functions

 TimeMultipleRequired (const std::string &model, const Name &name_a, const Time &value_a, const Name &name_b, const Time &value_b)
 
 ~TimeMultipleRequired () throw ()
 
std::string message ()
 Returns a diagnostic message or empty string. More...
 
- Public Member Functions inherited from nest::KernelException
 KernelException ()
 
 KernelException (char const *const what)
 
virtual ~KernelException () throw ()
 
- Public Member Functions inherited from SLIException
 SLIException (char const *const what)
 
virtual ~SLIException () throw ()
 
virtual const char * what () const throw ()
 Returns the SLI error name, used by raiseerror. More...
 

Private Attributes

const std::string model_
 
const Name prop_a_
 
const Time val_a_
 
const Name prop_b_
 
const Time val_b_
 

Detailed Description

Exception to be thrown if a Time object should be a multiple of another.

See also
StepMultipleRequired

Constructor & Destructor Documentation

nest::TimeMultipleRequired::TimeMultipleRequired ( const std::string &  model,
const Name name_a,
const Time value_a,
const Name name_b,
const Time value_b 
)
inline
Note
model should be passed from get_name() to ensure that names of copied models are reported correctly.
Parameters
modelname of model causing problem
name_aname of dividend
value_avalue of dividend
name_bname of divisor
value_bvalue of divisor
nest::TimeMultipleRequired::~TimeMultipleRequired ( )
throw (
)
inline

Member Function Documentation

std::string nest::TimeMultipleRequired::message ( )
virtual

Returns a diagnostic message or empty string.

This function is not const, because it may clear internal data fields.

Reimplemented from nest::KernelException.

Member Data Documentation

const std::string nest::TimeMultipleRequired::model_
private
const Name nest::TimeMultipleRequired::prop_a_
private
const Name nest::TimeMultipleRequired::prop_b_
private
const Time nest::TimeMultipleRequired::val_a_
private
const Time nest::TimeMultipleRequired::val_b_
private

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