DC_ManoeuvrePunctualAction Class Reference

#include <DC_ManoeuvrePunctualAction.h>

Inheritance diagram for DC_ManoeuvrePunctualAction:

List of all members.

Detailed Description

Punctual action that launches a manoeuvre.

The action associated to this punctual action consists in loading manoeuvre in the manoeuvre manager. The manoeuvre to be loaded is a configuration parameter. This punctual action is useful to model an action that consists in triggering other actions that extend over time and which therefore cannot be directly executed by the punctual action component itself. In such a case, the actions that extend over a time interval can be encoded in a manoeuvre component.

See also:: Manoeuvre

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

Version:: 1.0

Definition at line 31 of file DC_ManoeuvrePunctualAction.h.

Public Member Functions

DC_ManoeuvrePunctualAction (void)

Instantiate a punctual action.

void setManoeuvreManager (CC_ManoeuvreManager *pManMan)

Setter method for the manoeuvre manager into which the target manoeuvre is to be loaded.

CC_ManoeuvreManager * getManoeuvreManager (void) const

Getter method for the manoeuvre manager.

void setManoeuvre (Manoeuvre *pMan)

Setter method for the manoeuvre to be loaded into the manoeuvre manager.

Manoeuvre * getManoeuvre (void) const

Getter method for the manoeuvre.

virtual bool isObjectConfigured (void)

Perform a class-specific configuration check: verify that the manoeuvre and manoeuvre manager have been loaded.

Protected Member Functions

virtual TD_ActionOutcome doAction (void)

Load the manoeuvre in the manoeuvre manager.

Constructor & Destructor Documentation

DC_ManoeuvrePunctualAction::DC_ManoeuvrePunctualAction ( void )

Instantiate a punctual action.
The call identifier is set. The manoeuvre manager and the manoeuvre are initialized to illegal values to signify that the component is not yet configured.
Definition at line 17 of file DC_ManoeuvrePunctualAction.cpp.

Member Function Documentation

TD_ActionOutcome DC_ManoeuvrePunctualAction::doAction ( void ) [protected, virtual]

Load the manoeuvre in the manoeuvre manager.
This method always return "action successfully executed". Note that reporting of possible failures related to the loading or execution of the manoeuvre should be the responsibility of the manoeuvre manager.
See also:
PunctualAction::execute
TD_ActionOutcome

Returns:
always returns ACTION_SUCCESS

Implements PunctualAction.
Definition at line 23 of file DC_ManoeuvrePunctualAction.cpp.

Manoeuvre * DC_ManoeuvrePunctualAction::getManoeuvre ( void ) const

Getter method for the manoeuvre.

See also:
doAction

Returns:
pManMan the manoeuvre manager

Definition at line 45 of file DC_ManoeuvrePunctualAction.cpp.

CC_ManoeuvreManager * DC_ManoeuvrePunctualAction::getManoeuvreManager ( void ) const

Getter method for the manoeuvre manager.

See also:
setManoeuvreManager

Returns:
pManMan the manoeuvre manager

Definition at line 36 of file DC_ManoeuvrePunctualAction.cpp.

bool DC_ManoeuvrePunctualAction::isObjectConfigured ( void ) [virtual]

Perform a class-specific configuration check: verify that the manoeuvre and manoeuvre manager have been loaded.

Returns:
true if the object is configured, false otherwise

Reimplemented from CC_RootObject.
Definition at line 49 of file DC_ManoeuvrePunctualAction.cpp.

void DC_ManoeuvrePunctualAction::setManoeuvre ( Manoeuvre * pMan )

Setter method for the manoeuvre to be loaded into the manoeuvre manager.

See also:
doAction

Parameters:

pMan the manoeuvre

Definition at line 40 of file DC_ManoeuvrePunctualAction.cpp.

void DC_ManoeuvrePunctualAction::setManoeuvreManager ( CC_ManoeuvreManager * pManMan )

Setter method for the manoeuvre manager into which the target manoeuvre is to be loaded.

See also:
doAction

Parameters:

pManMan the manoeuvre manager

Definition at line 31 of file DC_ManoeuvrePunctualAction.cpp.

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


Public Member Functions
	DC_ManoeuvrePunctualAction (void)
	Instantiate a punctual action.
void	setManoeuvreManager (CC_ManoeuvreManager *pManMan)
	Setter method for the manoeuvre manager into which the target manoeuvre is to be loaded.
CC_ManoeuvreManager *	getManoeuvreManager (void) const
	Getter method for the manoeuvre manager.
void	setManoeuvre (Manoeuvre *pMan)
	Setter method for the manoeuvre to be loaded into the manoeuvre manager.
Manoeuvre *	getManoeuvre (void) const
	Getter method for the manoeuvre.
virtual bool	isObjectConfigured (void)
	Perform a class-specific configuration check: verify that the manoeuvre and manoeuvre manager have been loaded.
Protected Member Functions
virtual TD_ActionOutcome	doAction (void)
	Load the manoeuvre in the manoeuvre manager.