DC_NestedFsmActivator Class Reference

#include <DC_NestedFsmActivator.h>

Inheritance diagram for DC_NestedFsmActivator:

List of all members.

Detailed Description

FsmState that activates an FSM.

This FsmState is useful to implement "nested FSM" where one outer FSM controls one or more "inner" FSMs. In this case, to each FsmState of the outer FSM, one of the inner FSMs is associated. The task of the FsmStates is activate their associated FSMs. This class can be used to implement one of these FsmStates.

A DC_NestedFsmActivator is configured with one parameter: the target FSM. The target FSM is the FSM that the FsmState controls and must periodically activate. The continuation action of an DC_NestedFsmActivator consists in activating the target FSM.

The initialization action of the DC_NestedFsmActivator is implemented to reset the target FSM.

All other actions and checks associated to the DC_NestedFsmActivator have their default implementations as defined in the base class FsmState.

See also:: CC_FSM

Author:: Alessandro Pasetti (P&P Software GmbH)

Version:: 1.0

Definition at line 40 of file DC_NestedFsmActivator.h.

Public Member Functions

DC_NestedFsmActivator (void)

Set the class identifier.

void setTargetFsm (CC_FSM *pTargetFsm)

Set the target FSM.

CC_FSM * getTargetFsm (void)

Get the target FSM.

virtual void doContinue (void)

Activate the target FSM.

virtual void doInit (void)

Reset the target FSM.

virtual bool isObjectConfigured (void)

Perform a class-specific configuration check: verify that the target FSM has been loaded.

Constructor & Destructor Documentation

DC_NestedFsmActivator::DC_NestedFsmActivator ( void )

Set the class identifier.

Definition at line 17 of file DC_NestedFsmActivator.cpp.

Member Function Documentation

void DC_NestedFsmActivator::doContinue ( void ) [virtual]

Activate the target FSM.

See also:
FsmState::doContinue

Implements FsmState.
Definition at line 32 of file DC_NestedFsmActivator.cpp.

void DC_NestedFsmActivator::doInit ( void ) [virtual]

Reset the target FSM.

See also:
FsmState::doInit

Reimplemented from FsmState.
Definition at line 37 of file DC_NestedFsmActivator.cpp.

CC_FSM * DC_NestedFsmActivator::getTargetFsm ( void )

Get the target FSM.

See also:
doContinue

Definition at line 27 of file DC_NestedFsmActivator.cpp.

bool DC_NestedFsmActivator::isObjectConfigured ( void ) [virtual]

Perform a class-specific configuration check: verify that the target FSM has been loaded.

Returns:
true if the object is configured, false otherwise.

Reimplemented from CC_RootObject.
Reimplemented in DC_NestedFsmActivatorWithEndState, and DC_NestedFsmActivatorWithExitCheck.
Definition at line 42 of file DC_NestedFsmActivator.cpp.

void DC_NestedFsmActivator::setTargetFsm ( CC_FSM * pTargetFsm )

Set the target FSM.

See also:
doContinue

Definition at line 22 of file DC_NestedFsmActivator.cpp.

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


Public Member Functions
	DC_NestedFsmActivator (void)
	Set the class identifier.
void	setTargetFsm (CC_FSM *pTargetFsm)
	Set the target FSM.
CC_FSM *	getTargetFsm (void)
	Get the target FSM.
virtual void	doContinue (void)
	Activate the target FSM.
virtual void	doInit (void)
	Reset the target FSM.
virtual bool	isObjectConfigured (void)
	Perform a class-specific configuration check: verify that the target FSM has been loaded.