SVT svt_fsm Class Member List

This is the complete list of members for class svt_fsm, including all inherited members.


 svt_fsm   function void  abort ( )  Terminate the FSM. This will cause the run method to return. 
 svt_fsm   function void  append_callback ( svt_fsm_callback cb )   
 svt_fsm  virtual  function void  build ( )  The FSM states are created in extensions of this method, using the `svt_fsm_create_state macro. 
 svt_fsm  protected svt_fsm_callback  callbacks [$]  
 svt_fsm   function bit  callback_client_exists ( )   
 svt_fsm  int  callback_client_exists_cache = -1; Cached callback_client_exists return value used to accelerate callback processing.  
 svt_fsm   function svt_fsm  create_fsm ( svt_type_factory_override_base typ, string name )  Create a sub-FSM instance of the specified type using the local factory. Should not be called directly. Rather, the `svt_fsm_create_fsm macro should be used instead. 
 svt_fsm   function void  exception ( svt_fsm_exception except )  Should be called whenever an error is detected by the FSM implementation Calls all registered instances of the svt_fsm_callback :: exception method. 
 svt_fsm  virtual  function int  get_inst_id ( )  Method returns unique numeric instance identifier for the FSM. 
 svt_fsm  virtual  function string  get_name ( )   
 svt_fsm  virtual  function string  get_uid ( )  This method can be used to obtain a unique identifier for a data object.  
 svt_fsm  virtual  function string  get_xml_name ( )  This method provides a name which can be used to establish a channel associated with this FSM in the XML output. If there are multiple FSMs this is needed to differentiate this FSM from the other FSMs in the XML file. As such it needs to be unique across the set of FSMs that will be included in the XML file.  
 svt_fsm   function void  goto_cb_exec ( svt_fsm_state_base from_state, svt_fsm_state_base to_state )  Function encapsulating actions that occur at the transition from current to next state, including calling the 'goto' callback. 
 svt_fsm  protected virtual  function bit  is_viable_next_fsm_state ( svt_fsm_state_base test_next )  Method which checks whether the provided fsm state can be reached directly from the current fsm state.  
 svt_fsm  vmm_log  log  
 svt_fsm   function svt_fsm_state_base  m_create_state ( svt_type_factory_override_base typ )  Create a state of the specified type using the factory. Should not be called directly. Rather, the `svt_fsm_create_state macro should be used instead. 
 svt_fsm   function void  m_init ( )  Initialize the FSM and it's states. Called automatically when run is called. 
 svt_fsm  static protected int  m_inst_count  
 svt_fsm   function void  new ( string name = "" )   
 svt_fsm   function void  override_fsm ( svt_type_factory_override_base orig, svt_type_factory_override_base over )  Override the type of a sub-FSM for this FSM instance only. Must be called before the state that creates the sub-FSM is started. 
 svt_fsm   function void  override_state ( svt_type_factory_override_base orig, svt_type_factory_override_base over )  Override a state type with another state type for this FSM instance only. Must be called before build is called. 
 svt_fsm   function void  prepend_callback ( svt_fsm_callback cb )   
 svt_fsm  virtual  function void  print ( )  Print a description of the FSM and its current state. 
 svt_fsm   task  run ( )  Start and run the FSM until it is aborted. 
 svt_fsm   function void  save_current_state_to_xml ( )  Function that can force the current state to get an end time and be forced out to XML. 
 svt_fsm  protected  function void  set_done_state ( svt_fsm_state_base state )  Define the final state of the FSM (optional). Should be called in an extension of build or run. The final state should be a dead-end state. 
 svt_fsm   function void  set_name ( string name )  Set the name of the FSM instance 
 svt_fsm  protected  function void  set_reset_state ( svt_fsm_state_base state )  Define the reset state of the FSM (required if the start state is a dead-end state). Requires that wait_for_reset be implemented. Should be called in an extension of build or run
 svt_fsm  protected  function void  set_start_state ( svt_fsm_state_base state )  Define the start state of the FSM (required). Should be called in an extension of build or run. The start state is one of the state that can be a dead-end state. 
 svt_fsm  virtual  function void  set_xml_writer ( svt_xml_writer xml_writer )  Set the XML Writer, used to generate XML output at state transitions.  
 svt_fsm   function void  unregister_callback ( svt_fsm_callback cb )   
 svt_fsm  protected virtual  task  wait_for_reset ( )  Must be implemented if a reset state is defined. Automatically invoked by the run task, it must return only once the reset condition has been detected. The implementation must not call super.wait_for_reset
 svt_fsm   task  wait_for_state_transition ( output svt_fsm_state_base to_state )  Wait for the FSM to transition state and return the state it just transitioned to. Returns NULL if the FSM was aborted.