Debug functions


Functions

void setDbgParam (StateMachine *stateMachine, unsigned short int verboseFlag)
 This set a verbose flag that activate or deactivate some debug output.
void rmDbgParam (StateMachine *stateMachine, unsigned short int verboseFlag)
 This unset a verbose flag that activate or deactivate some debug output.
void displayStateMachine1 (StateMachine *stateMachine)
 Display the state machine.
void displayStateMachine2 (StateMachine *stateMachine)
 Display the state machine.
short int isConnected (State *from, State *to)
 Test if a transition exist between the given states.
void displayCurrStateName (StateMachine *stateMachine)
 Display the name of the current state.

Function Documentation

void displayCurrStateName ( StateMachine stateMachine  ) 

Display the name of the current state.

Parameters:
stateMachine The state machine to be tested.
You do not need to activate any debug level to use this function. However if the debug has been deactivated in the makefile a call to this function won't have any effect.

void displayStateMachine1 ( StateMachine stateMachine  ) 

Display the state machine.

Parameters:
stateMachine The state machine to be displayed.
You do not need to activate any debug level to use this function. However if the debug has been deactivated in the makefile a call to this function won't have any effect.
See also:
void displayStateMachine2(StateMachine* stateMachine)

void displayStateMachine2 ( StateMachine stateMachine  ) 

Display the state machine.

Parameters:
stateMachine The state machine to be displayed.
You do not need to activate any debug level to use this function. However if the debug has been deactivated in the makefile a call to this function won't have any effect.
See also:
void displayStateMachine1(StateMachine* stateMachine)

short int isConnected ( State from,
State to 
)

Test if a transition exist between the given states.

Parameters:
from The source node.
to The target node.
Returns:
0 if no connections exists, else it returns the event ID that can trigger the transition.

void rmDbgParam ( StateMachine stateMachine,
unsigned short int  verboseFlag 
)

This unset a verbose flag that activate or deactivate some debug output.

Parameters:
stateMachine The state machine to act on.
verboseFlag To see available verbose flags see enum DBG_DISP_ENUM.
See also:
void setDbgParam(StateMachine* stateMachine, unsigned short int verboseFlag)

void setDbgParam ( StateMachine stateMachine,
unsigned short int  verboseFlag 
)

This set a verbose flag that activate or deactivate some debug output.

Parameters:
stateMachine The state machine to act on.
verboseFlag To see available verbose flags see enum DBG_DISP_ENUM.
See also:
void rmDbgParam(StateMachine* stateMachine, unsigned short int verboseFlag)


Generated on Sat Sep 18 15:39:57 2010 for Easy C State Machine by  doxygen 1.5.8