svt_fsm_state Class Reference

Inheritance diagram for class svt_fsm_state:

List of all members.


Detailed Description

Base class for user-defined FSM states. Must be extended to specify the behavior of a state within a FSM. The 'FSM' parameter is the type of the parent FSM containing this state. The 'NAME' parameter is the name of the state.



Public Member Functions

function svt_fsm  get_fsm ( )
function string  get_name ( )
virtual function string  get_xml_name ( )
function void  set_fsm ( svt_fsm fsm )

Class Parameters

type  FSM = int; 
string  NAME = "state"; 

Public Attributes

FSM  p_fsm 


Member Function Documentation

  function svt_fsm
 svt_fsm_state::get_fsm

 (   ) 


 Superseded functions 
 svt_fsm_state_base :: get_fsm 

  function string
 svt_fsm_state::get_name

 (   ) 


 Superseded functions 
 svt_fsm_state_base :: get_name 

 virtual function string
 svt_fsm_state::get_xml_name

 (   ) 


Returns a name that can be used to represent the state's object type in the XML output. By default uses the class name.

Return values - Name to be used for the object type in XML output.


 Superseded functions 
 svt_fsm_state_base :: get_xml_name 

  function void
 svt_fsm_state::set_fsm

 (  svt_fsm fsm  ) 


 Superseded functions 
 svt_fsm_state_base :: set_fsm 


Class Parameters Documentation

 type  attribute
 svt_fsm_state::FSM = int

 string  attribute
 svt_fsm_state::NAME = "state"


Member Attribute Documentation

 FSM  attribute
 svt_fsm_state::p_fsm


Reference to the parent FSM