NullOperationState Class Reference

#include <OperationState.hh>

Inheritance diagram for NullOperationState:

Collaboration diagram for NullOperationState:

Public Member Functions
virtual const char *	name ()
virtual bool	isAvailable (const OperationContext &context) const
virtual void	advanceClock (OperationContext &context)
Public Member Functions inherited from OperationState
	OperationState ()
virtual	~OperationState ()

Static Public Member Functions
static NullOperationState *	instance ()

Static Private Attributes
static NullOperationState *	instance_ = NULL

Detailed Description

Singleton class that is used to represent a null value for operation state.

Definition at line 63 of file OperationState.hh.

Member Function Documentation

advanceClock()

void NullOperationState::advanceClock ( OperationContext &  context )

virtual

Prints an error message and aborts the program.

Returns

Never returns.

Reimplemented from OperationState.

Definition at line 114 of file OperationState.cc.

                                                  {
    abortWithError(NULL_ERROR_MESSAGE);
}

References abortWithError, and NULL_ERROR_MESSAGE.

instance()

static NullOperationState * NullOperationState::instance ( )

static

isAvailable()

bool NullOperationState::isAvailable ( const OperationContext &  context ) const

virtual

Prints an error message and aborts the program.

Returns

Never returns.

Reimplemented from OperationState.

Definition at line 103 of file OperationState.cc.

                                                             {
    abortWithError(NULL_ERROR_MESSAGE);
    return false;
}

References abortWithError, and NULL_ERROR_MESSAGE.

name()

const char * NullOperationState::name ( )

virtual

Returns the name of the state instance, in this case an empty string.

Returns

Empty string.

Implements OperationState.

Definition at line 93 of file OperationState.cc.

                         {
    return "";
}

Member Data Documentation

instance_

NullOperationState * NullOperationState::instance_ = NULL

staticprivate

Definition at line 72 of file OperationState.hh.

---

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

• OperationState.hh
• OperationState.cc