CStateCollection Class Reference
Interface for a state
collection. More...
#include <cstate.h>
Inheritance diagram for CStateCollection:
List of all
members.
Detailed Description
Interface for a state collection.
From a state collection you can retrieve the specific state you
want. A state collection has one general state (usually the model
state) and many other states comining from state modifiers. This
interface only provides functions to gather states from the
collection. The only thing you need is to call getState with the
specific state properties object. Therefore state properties object
pointer serves as the "ID" of the state in the collection, so it
doesn't work to transfer a properties object with just the same
properties but which is another instance. If the getState method is
called without parameter, the "general" state is calculated.
Implementations of CStateCollections are CStateCollectionImpl and
CState itself. The
CState class can be seen
as state collection only containing the CState object itself. This implentation
was choosen in order to provide more generality for many
functions.
Constructor & Destructor Documentation
|
CStateCollection::CStateCollection
|
( |
|
) |
[inline] |
|
| virtual
CStateCollection::~CStateCollection
|
( |
|
) |
[inline,
virtual] |
|
Member Function Documentation
| virtual CState* CStateCollection::getState
|
( |
|
) |
[pure
virtual] |
|
| virtual bool
CStateCollection::isMember
|
( |
CStateProperties *
|
stateModifier |
) |
[pure
virtual] |
|
| |
Checks wether there exists a state with the specified state
properties in the collection.
Implemented in CState, and CStateCollectionImpl.
|
| virtual bool
CStateCollection::isResetState
|
( |
|
) |
[inline,
virtual] |
|
| virtual void
CStateCollection::setResetState
|
( |
bool |
reset |
) |
[inline,
virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following
file:
|