DC_DummyConditionalPunctualAction Class Reference

#include <DC_DummyConditionalPunctualAction.h>

Inheritance diagram for DC_DummyConditionalPunctualAction:

List of all members.

Detailed Description

Dummy conditional punctual action that does not perform any action and always returns "action successful".

A setter method allows the return value of the execution check to be set by the user. This punctual action is used for testing purposes.

Author:: Roberto Totaro

Version:: 1.0

Definition at line 26 of file DC_DummyConditionalPunctualAction.h.

Public Member Functions

DC_DummyConditionalPunctualAction (void)

Instantiate a dummy conditional punctual action.

void setExecutionFlag (bool newState)

Set the return value of canExecute.

Protected Member Functions

virtual bool canExecute (void)

Perform a dummy execution test.

virtual TD_ActionOutcome doConditionalAction (void)

This method does not do anything.

Constructor & Destructor Documentation

DC_DummyConditionalPunctualAction::DC_DummyConditionalPunctualAction ( void )

Instantiate a dummy conditional punctual action.

Definition at line 15 of file DC_DummyConditionalPunctualAction.cpp.

Member Function Documentation

bool DC_DummyConditionalPunctualAction::canExecute ( void ) [protected, virtual]

Perform a dummy execution test.
The result of the test can be forced by calling setExecutionFlag.
See also:
ConditionalPunctualAction#setExecutionFlag
ConditionalPunctualAction::doAction
PunctualAction::execute

Returns:
returns the value of executionFlag

Implements ConditionalPunctualAction.
Definition at line 24 of file DC_DummyConditionalPunctualAction.cpp.

TD_ActionOutcome DC_DummyConditionalPunctualAction::doConditionalAction ( void ) [protected, virtual]

This method does not do anything.

See also:
ConditionalPunctualAction::doAction
PunctualAction::execute

Returns:
always returns an ACTION_SUCCESS code

Implements ConditionalPunctualAction.
Definition at line 28 of file DC_DummyConditionalPunctualAction.cpp.

void DC_DummyConditionalPunctualAction::setExecutionFlag ( bool newState )

Set the return value of canExecute.
This method was implemented only for testing purposes.
See also:
ConditionalPunctualAction::canExecute

Parameters:

newState the new value of executionFlag

Definition at line 20 of file DC_DummyConditionalPunctualAction.cpp.

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


Public Member Functions
	DC_DummyConditionalPunctualAction (void)
	Instantiate a dummy conditional punctual action.
void	setExecutionFlag (bool newState)
	Set the return value of `canExecute`.
Protected Member Functions
virtual bool	canExecute (void)
	Perform a dummy execution test.
virtual TD_ActionOutcome	doConditionalAction (void)
	This method does not do anything.