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.

ovm_report_object	function void	avm_report_error ( string id, string message, int verbosity = OVM_LOW, string filename = "", int line = 0 )

ovm_report_object	function void	avm_report_fatal ( string id, string message, int verbosity = OVM_NONE, string filename = "", int line = 0 )

ovm_report_object	function void	avm_report_message ( string id, string message, int verbosity = OVM_MEDIUM, string filename = "", int line = 0 )

ovm_report_object	function void	avm_report_warning ( string id, string message, int verbosity = OVM_MEDIUM, string filename = "", int line = 0 )

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	function bit	callback_client_exists ( )

svt_fsm	int	callback_client_exists_cache = -1;	Cached callback_client_exists return value used to accelerate callback processing.

ovm_object	function ovm_object	clone ( )

ovm_object	function bit	compare ( ovm_object rhs, ovm_comparer comparer = null )

ovm_object	function string	convert2string ( )

ovm_object	function void	copy ( ovm_object rhs )

ovm_object	virtual function ovm_object	create ( string name = "" )

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.

ovm_report_object	virtual function void	die ( )

ovm_object	function bit	do_compare ( ovm_object rhs, ovm_comparer comparer )

ovm_object	function void	do_copy ( ovm_object rhs )

ovm_object	function void	do_pack ( ovm_packer packer )

ovm_object	function void	do_print ( ovm_printer printer )

ovm_object	function void	do_record ( ovm_recorder recorder )

ovm_object	function string	do_sprint ( ovm_printer printer )

ovm_object	function void	do_unpack ( ovm_packer packer )

ovm_report_object	function void	dump_report_state ( )

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.


ovm_object	function string	get_full_name ( )

ovm_object	static function int	get_inst_count ( )

ovm_object	function int	get_inst_id ( )

svt_fsm	virtual function string	get_name ( )

ovm_object	function ovm_object_wrapper	get_object_type ( )

ovm_report_object	function int	get_report_action ( ovm_severity severity, string id )

ovm_report_object	function int	get_report_file_handle ( ovm_severity severity, string id )

ovm_report_object	function ovm_report_handler	get_report_handler ( )

ovm_report_object	function ovm_report_server	get_report_server ( )

ovm_report_object	function int	get_report_verbosity_level ( )

ovm_object	static function ovm_object_wrapper	get_type ( )

ovm_object	virtual function string	get_type_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.


ovm_object	static function ovm_status_container	init_status ( )

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	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.


ovm_object	static protected function void	m_delete_field_array ( )


ovm_object	protected function int	m_do_data ( string arg, inout ovm_bitstream_t lhs, input ovm_bitstream_t rhs, int what, int bits, int flag )

ovm_object	protected function int	m_do_data_object ( string arg, inout ovm_object lhs, input ovm_object rhs, int what, int flag )

ovm_object	protected function int	m_do_data_real ( string arg, inout real lhs, input real rhs, int what, int flag )

ovm_object	protected function int	m_do_data_string ( string arg, inout string lhs, input string rhs, int what, int flag )

ovm_object	protected function void	m_do_field_check ( string field )

ovm_object	protected function int	m_do_set ( string match, string arg, inout ovm_bitstream_t lhs, input int what, int flag )

ovm_object	protected function int	m_do_set_object ( string match, string arg, inout ovm_object lhsobj, input int what, int flag )

ovm_object	protected function int	m_do_set_string ( string match, string arg, inout string lhs, input int what, int flag )


ovm_object	static protected int	m_field_array [string]

ovm_object	function void	m_field_automation ( ovm_object tmp_data__, int what__, string str__ )



ovm_object	protected function string	m_get_function_type ( int what )

ovm_report_object	protected virtual function ovm_report_object	m_get_report_object ( )

ovm_object	static function ovm_status_container	m_get_status ( )

svt_fsm	function void	m_init ( )	Initialize the FSM and it's states. Called automatically when run is called.

ovm_object	static protected int	m_inst_count = 0;







ovm_object	protected function void	m_record_field_object ( string arg, ovm_object value, ovm_recorder recorder = null, int flag = OVM_DEFAULT )


ovm_report_object	ovm_report_handler	m_rh

ovm_object	static protected ovm_status_container	m_sc = init_status;








svt_fsm	function void	new ( string name = "", ovm_report_object reporter = null )

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.

ovm_report_object	function int	ovm_get_max_verbosity ( )

ovm_report_object	function int	ovm_report_enabled ( int verbosity, ovm_severity severity = OVM_INFO, string id = "" )

ovm_report_object	virtual function void	ovm_report_error ( string id, string message, int verbosity = OVM_LOW, string filename = "", int line = 0 )

ovm_report_object	virtual function void	ovm_report_fatal ( string id, string message, int verbosity = OVM_NONE, string filename = "", int line = 0 )

ovm_report_object	virtual function void	ovm_report_info ( string id, string message, int verbosity = OVM_MEDIUM, string filename = "", int line = 0 )

ovm_report_object	virtual function void	ovm_report_warning ( string id, string message, int verbosity = OVM_MEDIUM, string filename = "", int line = 0 )

ovm_object	function int	pack ( ref bit bitstream[], input ovm_packer packer )

ovm_object	function int	pack_bytes ( ref byte unsigned bytestream[], input ovm_packer packer )

ovm_object	function int	pack_ints ( ref int unsigned intstream[], input ovm_packer packer )

svt_fsm	virtual function void	print ( )	Print a description of the FSM and its current state.

ovm_object	static function void	print_field_match ( string fnc, string match )

ovm_object	static bit	print_matches = 0;

ovm_object	function void	record ( ovm_recorder recorder = null )

svt_fsm	ovm_report_object	reporter

ovm_report_object	virtual function bit	report_error_hook ( string id, string message, int verbosity, string filename, int line )

ovm_report_object	virtual function bit	report_fatal_hook ( string id, string message, int verbosity, string filename, int line )

ovm_report_object	virtual function void	report_header ( OVM_FILE file = 0 )

ovm_report_object	virtual function bit	report_hook ( string id, string message, int verbosity, string filename, int line )

ovm_report_object	virtual function bit	report_info_hook ( string id, string message, int verbosity, string filename, int line )

ovm_report_object	virtual function void	report_summarize ( OVM_FILE file = 0 )

ovm_report_object	virtual function bit	report_warning_hook ( string id, string message, int verbosity, string filename, int line )

ovm_object	function void	reseed ( )

ovm_report_object	function void	reset_report_handler ( )

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.

ovm_object	function void	set_int_local ( string field_name, ovm_bitstream_t value, bit recurse = 1 )

svt_fsm	function void	set_name ( string name )	Set the name of the FSM instance

ovm_object	function void	set_object_local ( string field_name, ovm_object value, bit clone = 1, bit recurse = 1 )

ovm_report_object	function void	set_report_default_file ( OVM_FILE file )

ovm_report_object	function void	set_report_handler ( ovm_report_handler handler )

ovm_report_object	function void	set_report_id_action ( string id, ovm_action action )

ovm_report_object	function void	set_report_id_file ( string id, OVM_FILE file )

ovm_report_object	function void	set_report_max_quit_count ( int max_count )

ovm_report_object	function void	set_report_severity_action ( ovm_severity severity, ovm_action action )

ovm_report_object	function void	set_report_severity_file ( ovm_severity severity, OVM_FILE file )

ovm_report_object	function void	set_report_severity_id_action ( ovm_severity severity, string id, ovm_action action )

ovm_report_object	function void	set_report_severity_id_file ( ovm_severity severity, string id, OVM_FILE file )

ovm_report_object	function void	set_report_verbosity_level ( int verbosity_level )

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.

ovm_object	function void	set_string_local ( string field_name, string value, bit recurse = 1 )

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.

ovm_object	function string	sprint ( ovm_printer printer = null )

ovm_object	function int	unpack ( ref bit bitstream[], input ovm_packer packer )

ovm_object	function int	unpack_bytes ( ref byte unsigned bytestream[], input ovm_packer packer )

ovm_object	function int	unpack_ints ( ref int unsigned intstream[], input ovm_packer packer )

ovm_object	static bit	use_ovm_seeding = 1;

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.