StatesTC Class Reference

Inheritance diagram for StatesTC:

Public Member Functions
bool	breakUpdateHook ()
void	cleanupHook ()
bool	configureHook ()
void	errorHook ()
void	exceptionHook ()
void	resetFlags ()
bool	startHook ()
	StatesTC ()
void	stopHook ()
void	updateHook ()
Public Attributes
bool	didbreakUH
bool	didcleanup
bool	didconfig
bool	diderror
bool	didexcept
bool	didstart
bool	didstop
bool	didupdate
bool	do_block
bool	do_breakUH
bool	do_checks
bool	do_error
bool	do_fatal
bool	do_stop
bool	do_throw
bool	do_throw2
bool	do_throw3
bool	do_trigger
int	updatecount
bool	validconfig
bool	validstart

Detailed Description

Definition at line 40 of file taskstates_test.cpp.

Constructor & Destructor Documentation

StatesTC::StatesTC ( ) [inline]

Definition at line 44 of file taskstates_test.cpp.

Member Function Documentation

bool StatesTC::breakUpdateHook ( ) [inline, virtual]

Implement this function if your code might block for long times inside the updateHook() function. Insert in this hook the code to wake up that code or signal it otherwise that updateHook() is requested to return (for example by setting a flag). The method returns false by default.

Returns:: true if well received and updateHook() will soon return. False otherwise.

Reimplemented from RTT::base::TaskCore.

Definition at line 146 of file taskstates_test.cpp.

void StatesTC::cleanupHook ( ) [inline, virtual]

Implement this method such that it contains the code which will be executed when cleanup() is called. The default implementation is an empty function.

Reimplemented from RTT::base::TaskCore.

Definition at line 105 of file taskstates_test.cpp.

bool StatesTC::configureHook ( ) [inline, virtual]

Implement this method such that it contains the code which will be executed when configure() is called. The default implementation is an empty function which returns true.

Return values:

	true	to indicate that configuration succeeded and the Stopped state may be entered.
	false	to indicate that configuration failed and the Preoperational state is entered.

Reimplemented from RTT::base::TaskCore.

Definition at line 79 of file taskstates_test.cpp.

void StatesTC::errorHook ( ) [inline, virtual]

Implement this method to contain code that must be executed in the RunTimeError state, instead of updateHook(). This allows you to specify the behaviour in an erroneous component. errorHook() is called as long as the component is not recover()'ed. After recover()'ed, the updateHook() is called again.

Reimplemented from RTT::base::TaskCore.

Definition at line 151 of file taskstates_test.cpp.

void StatesTC::exceptionHook ( ) [inline, virtual]

Implement this method to contain code that must be executed when transitioning to the Exception state. This allows you to specify the last actions in an erroneous component, after stopHook() and cleanupHook() were called.

See also:: recover() to leave the Exception state.

Reimplemented from RTT::base::TaskCore.

Definition at line 113 of file taskstates_test.cpp.

void StatesTC::resetFlags ( ) [inline]

Definition at line 65 of file taskstates_test.cpp.

bool StatesTC::startHook ( ) [inline, virtual]

Implement this method such that it contains the code which will be executed when start() is called. The default implementation is an empty function which returns true.

Return values:

	true	to indicate that the component may run and the Running state may be entered.
	false	to indicate that the component may not run and the Stopped state is entered.

Reimplemented from RTT::base::TaskCore.

Definition at line 88 of file taskstates_test.cpp.

void StatesTC::stopHook ( ) [inline, virtual]

Implement this method such that it contains the code which will be executed when stop() is called. The default implementation is an empty function.

Reimplemented from RTT::base::TaskCore.

Definition at line 97 of file taskstates_test.cpp.

void StatesTC::updateHook ( ) [inline, virtual]

Function where the user must insert his 'application' code. When the ExecutionEngine's Activity is a periodic, this function is called by the ExecutionEngine in each periodic step after all messages are processed. When it is executed by a non periodic activity, this function is called after a message is received and executed. It should not loop forever, since no commands or events are processed when this function executes. The default implementation is an empty function.

Reimplemented from RTT::base::TaskCore.

Definition at line 123 of file taskstates_test.cpp.