DC_DummyConfigurableManoeuvre Class Reference

#include <DC_DummyConfigurableManoeuvre.h>

Inheritance diagram for DC_DummyConfigurableManoeuvre:

List of all members.

Detailed Description

Dummy implementation of the Manoeuvre abstract class to be used for testing purposes.

This class implements some simple forms of manoeuvre actions and it allows the return values of the manoeuvre checks to be configured by the user.

This class associates three counters to each of the three actions (initialization action, continuation action, and termination action) that characterize a manoeuvre. The counters are initialized to zero by the constructor and are incremented by one every time the action is executed. The return value of the three checks (start check, continuation check, and termination check) associated to the manoeuvres can be set be the user. The value of the continuation check code can also be set by the user.

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

Version:: 1.0

Definition at line 36 of file DC_DummyConfigurableManoeuvre.h.

Public Member Functions

DC_DummyConfigurableManoeuvre (void)

Instantiate a dummy configurable manoeuvre object.

virtual bool canStart (void)

Return the value of the start check flag.

virtual void initialize (void)

Increment the initialization action counter by one.

virtual bool canContinue (void)

Return the value of the continuation check flag.

virtual bool isFinished (void)

Return the value of the termination check flag.

void setStartCheckStatus (bool startCheck)

Set the value of the start check.

void setContinuationCheckStatus (bool continuationCheck)

Set the value of the continuation check.

void setContinuationCheckCode (TD_CheckCode continuationCheckCode)

Set the value of the continuation check code.

virtual TD_CheckCode getContinuationCheckCode () const

Get the value of the continuation check code.

void setTerminationCheckStatus (bool terminationCheck)

Set the value of the termination check.

int getInitializationActionCounter (void)

Getter method for the initialization action counter.

int getContinuationActionCounter (void)

Getter method for the continuation action counter.

int getTerminationActionCounter (void)

Getter method for the termination action counter.

Protected Member Functions

virtual void doInternalContinue (void)

Increment the continuation action counter by one.

virtual void internalTerminate (void)

Increment the termination action counter by one.

Constructor & Destructor Documentation

DC_DummyConfigurableManoeuvre::DC_DummyConfigurableManoeuvre ( void )

Instantiate a dummy configurable manoeuvre object.
The counters are initialized to zero; the return values of the start, continuation and termination check are initialized to false; and the class identified is set.
Definition at line 16 of file DC_DummyConfigurableManoeuvre.cpp.

Member Function Documentation

bool DC_DummyConfigurableManoeuvre::canContinue ( void ) [virtual]

Return the value of the continuation check flag.
The value of the continuation check flag can be set by the user through method setCheckStatus.
See also:
#setCheckStatus

Returns:
true if the manoeuvre can continue execution

Reimplemented from Manoeuvre.
Definition at line 40 of file DC_DummyConfigurableManoeuvre.cpp.

bool DC_DummyConfigurableManoeuvre::canStart ( void ) [virtual]

Return the value of the start check flag.
The value of the start check flag can be set by the user through method setCheckStatus.
See also:
#setCheckStatus

Returns:
true if the manoeuvre is ready to start

Reimplemented from Manoeuvre.
Definition at line 30 of file DC_DummyConfigurableManoeuvre.cpp.

void DC_DummyConfigurableManoeuvre::doInternalContinue ( void ) [protected, virtual]

Increment the continuation action counter by one.

See also:
Manoeuvre::doContinue

Implements Manoeuvre.
Definition at line 45 of file DC_DummyConfigurableManoeuvre.cpp.

int DC_DummyConfigurableManoeuvre::getContinuationActionCounter ( void )

Getter method for the continuation action counter.

See also:
doInternalContinue

Returns:
the continuation action counter

Definition at line 79 of file DC_DummyConfigurableManoeuvre.cpp.

TD_CheckCode DC_DummyConfigurableManoeuvre::getContinuationCheckCode ( ) const [virtual]

Get the value of the continuation check code.
In this class, the value of the continuation check code can be set by the user.
See also:
setContinuationCheckCode

Returns:
he return value of the continuation check

Reimplemented from Manoeuvre.
Definition at line 67 of file DC_DummyConfigurableManoeuvre.cpp.

int DC_DummyConfigurableManoeuvre::getInitializationActionCounter ( void )

Getter method for the initialization action counter.

See also:
initialize

Returns:
the initialization action counter

Definition at line 75 of file DC_DummyConfigurableManoeuvre.cpp.

int DC_DummyConfigurableManoeuvre::getTerminationActionCounter ( void )

Getter method for the termination action counter.

See also:
internalTerminate

Returns:
the termination action counter

Definition at line 83 of file DC_DummyConfigurableManoeuvre.cpp.

void DC_DummyConfigurableManoeuvre::internalTerminate ( void ) [protected, virtual]

Increment the termination action counter by one.

See also:
Manoeuvre::terminate

Reimplemented from Manoeuvre.
Definition at line 26 of file DC_DummyConfigurableManoeuvre.cpp.

bool DC_DummyConfigurableManoeuvre::isFinished ( void ) [virtual]

Return the value of the termination check flag.
The value of the termination check flag can be set by the user through method setCheckStatus.
See also:
#setCheckStatus

Returns:
true if the manoeuvre has terminated execution

Implements Manoeuvre.
Definition at line 50 of file DC_DummyConfigurableManoeuvre.cpp.

void DC_DummyConfigurableManoeuvre::setContinuationCheckCode ( TD_CheckCode continuationCheckCode )

Set the value of the continuation check code.
The value set with this method is the value returned by method getContinuationCheckCode.
See also:
canContinue

Parameters:

continuationCheckCode the return value of the continuation check

Definition at line 63 of file DC_DummyConfigurableManoeuvre.cpp.

void DC_DummyConfigurableManoeuvre::setContinuationCheckStatus ( bool continuationCheck )

Set the value of the continuation check.
The value set with this method is the value returned by the continuation check method.
See also:
canContinue

Parameters:

continuationCheck the return value of the continuation check

Definition at line 59 of file DC_DummyConfigurableManoeuvre.cpp.

void DC_DummyConfigurableManoeuvre::setStartCheckStatus ( bool startCheck )

Set the value of the start check.
The value set with this method is the value returned by the start check method.
See also:
canStart

Parameters:

startCheck the return value of the start check

Definition at line 55 of file DC_DummyConfigurableManoeuvre.cpp.

void DC_DummyConfigurableManoeuvre::setTerminationCheckStatus ( bool terminationCheck )

Set the value of the termination check.
The value set with this method is the value returned by the termination check methods.
See also:
isFinished

Parameters:

terminationCheck the return value of the termination check

Definition at line 71 of file DC_DummyConfigurableManoeuvre.cpp.

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


Public Member Functions
	DC_DummyConfigurableManoeuvre (void)
	Instantiate a dummy configurable manoeuvre object.
virtual bool	canStart (void)
	Return the value of the start check flag.
virtual void	initialize (void)
	Increment the initialization action counter by one.
virtual bool	canContinue (void)
	Return the value of the continuation check flag.
virtual bool	isFinished (void)
	Return the value of the termination check flag.
void	setStartCheckStatus (bool startCheck)
	Set the value of the start check.
void	setContinuationCheckStatus (bool continuationCheck)
	Set the value of the continuation check.
void	setContinuationCheckCode (TD_CheckCode continuationCheckCode)
	Set the value of the continuation check code.
virtual TD_CheckCode	getContinuationCheckCode () const
	Get the value of the continuation check code.
void	setTerminationCheckStatus (bool terminationCheck)
	Set the value of the termination check.
int	getInitializationActionCounter (void)
	Getter method for the initialization action counter.
int	getContinuationActionCounter (void)
	Getter method for the continuation action counter.
int	getTerminationActionCounter (void)
	Getter method for the termination action counter.
Protected Member Functions
virtual void	doInternalContinue (void)
	Increment the continuation action counter by one.
virtual void	internalTerminate (void)
	Increment the termination action counter by one.