Simpact Cyan
Population based event driven simulation using mNRM
Public Member Functions | Protected Member Functions | List of all members
errut::ErrorBase Class Reference

Base class which allows an error message to be set. More...

#include <errorbase.h>

Inheritance diagram for errut::ErrorBase:
Inheritance graph
[legend]

Public Member Functions

 ErrorBase ()
 Creates an instance without an explicit object name. More...
 
 ErrorBase (const std::string &objName)
 Creates an instance with the object name set to objName. More...
 
std::string getObjectName () const
 Returns the stored object name. More...
 
std::string getErrorString () const
 Returns the currently stored error message. More...
 

Protected Member Functions

void setErrorString (const std::string &str) const
 Derived classes can use this member function to store an error message. More...
 

Detailed Description

Base class which allows an error message to be set.

Base class which allows an error message to be set. Optionally, an object name can be stored at creation time.

Constructor & Destructor Documentation

errut::ErrorBase::ErrorBase ( )
inline

Creates an instance without an explicit object name.

errut::ErrorBase::ErrorBase ( const std::string &  objName)
inline

Creates an instance with the object name set to objName.

Member Function Documentation

std::string errut::ErrorBase::getErrorString ( ) const
inline

Returns the currently stored error message.

std::string errut::ErrorBase::getObjectName ( ) const
inline

Returns the stored object name.

void errut::ErrorBase::setErrorString ( const std::string &  str) const
inlineprotected

Derived classes can use this member function to store an error message.


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