svt_report_catcher Class Reference

function void
svt_report_catcher::append

( )

virtual function action_e
svt_report_catcher::catch

( )

Function: catch

This is the method that is called for each registered report catcher. There are no arguments to this function. The interface methods can be used to access information about the current message being processed.

Superseding functions
	svt_dropping_response_report_catcher :: catch
	svt_err_catcher :: catch
	svt_err_check_report_catcher :: catch

function void
svt_report_catcher::delete

( )

static function void
svt_report_catcher::delete_all

( )

function ovm_action
svt_report_catcher::get_action

( )

Function: get_action

Returns the of the message that is currently being processed. If the action was modified by a previously executed report object (which re-threw the message), then the returned action is the modified value.

function ovm_report_object
svt_report_catcher::get_client

( )

Function: get_client

Returns the that has generated the message that is currently being processes.

function string
svt_report_catcher::get_fname

( )

Function: get_fname

Returns the file name of the message.

function string
svt_report_catcher::get_id

( )

Function: get_id

Returns the string id of the message that is currently being processed. If the id was modified by a previously executed report object (which re-threw the message), then the returned id is the modified value.

function int
svt_report_catcher::get_line

( )

Function: get_line

Returns the line number of the message.

function string
svt_report_catcher::get_message

( )

Function: get_message

Returns the string message of the message that is currently being processed. If the message was modified by a previously executed report object (which re-threw the message), then the returned message is the modified value.

function ovm_severity
svt_report_catcher::get_severity

( )

Function: get_severity

Returns the of the message that is currently being processed. If the severity was modified by a previously executed report object (which re-threw the message), then the returned severity is the modified value.

function int
svt_report_catcher::get_verbosity

( )

Function: get_verbosity

Returns the verbosity of the message that is currently being processed. If the verbosity was modified by a previously executed report object (which re-threw the message), then the returned verbosity is the modified value.

protected function void
svt_report_catcher::issue

( )

Function: issue Immediately issues the message which is currently being processed. This is useful if the message is being ~CAUGHT~ but should still be emitted.

Issuing a message will update the report_server stats, possibly multiple times if the message is not ~CAUGHT~.

function void
svt_report_catcher::new

( string name )

Superseded functions
	ovm_object :: new
Superseding functions
	svt_dropping_response_report_catcher :: new
	svt_err_catcher :: new
	svt_err_check_report_catcher :: new

protected function void
svt_report_catcher::ovm_report_error

( string id , string message , int verbosity , string fname = "", int line = 0 )

Function: ovm_report_error

Issues a error message using the current messages report object. This message will bypass any message catching callbacks.

protected function void
svt_report_catcher::ovm_report_fatal

( string id , string message , int verbosity , string fname = "", int line = 0 )

Function: ovm_report_fatal

Issues a fatal message using the current messages report object. This message will bypass any message catching callbacks.

protected function void
svt_report_catcher::ovm_report_info

( string id , string message , int verbosity , string fname = "", int line = 0 )

Function: ovm_report_info

Issues a info message using the current messages report object. This message will bypass any message catching callbacks.

protected function void
svt_report_catcher::ovm_report_warning

( string id , string message , int verbosity , string fname = "", int line = 0 )

Function: ovm_report_warning

Issues a warning message using the current messages report object. This message will bypass any message catching callbacks.

function void
svt_report_catcher::prepend

( )

static function int
svt_report_catcher::process_all_report_catchers

( input ovm_report_server server , input ovm_report_object client , ref ovm_severity severity , input string name , ref string id , ref string message , ref int verbosity_level , ref ovm_action action , input string filename , input int line )

process_all_report_catchers method called by report_server.report to process catchers

protected function void
svt_report_catcher::set_action

( ovm_action action )

Function: set_action

Change the action of the message to ~action~. Any other report catchers will see the modified value.

protected function void
svt_report_catcher::set_id

( string id )

Function: set_id

Change the id of the message to ~id~. Any other report catchers will see the modified value.

protected function void
svt_report_catcher::set_message

( string message )

Function: set_message

Change the text of the message to ~message~. Any other report catchers will see the modified value.

protected function void
svt_report_catcher::set_severity

( ovm_severity severity )

Function: set_severity

Change the severity of the message to ~severity~. Any other report catchers will see the modified value.

protected function void
svt_report_catcher::set_verbosity

( int verbosity )

Function: set_verbosity

Change the verbosity of the message to ~verbosity~. Any other report catchers will see the modified value.

static function void
svt_report_catcher::summarize_report_catcher

( OVM_FILE file )

Function: summarize_report_catcher

This function is called automatically by <ovm_report_server :: summarize>. It prints the statistics for the active catchers.

Public Member Functions
function void	append ( )
virtual function action_e	catch ( )
function void	delete ( )
static function void	delete_all ( )
function ovm_action	get_action ( )
function ovm_report_object	get_client ( )
function string	get_fname ( )
function string	get_id ( )
function int	get_line ( )
function string	get_message ( )
function ovm_severity	get_severity ( )
function int	get_verbosity ( )
function void	new ( string name )
function void	prepend ( )
static function int	process_all_report_catchers ( input ovm_report_server server, input ovm_report_object client, ref ovm_severity severity, input string name, ref string id, ref string message, ref int verbosity_level, ref ovm_action action, input string filename, input int line )
static function void	summarize_report_catcher ( OVM_FILE file )
Public Attributes
bit	is_on
Protected Member Functions
function void	issue ( )
function void	ovm_report_error ( string id, string message, int verbosity, string fname = "", int line = 0 )
function void	ovm_report_fatal ( string id, string message, int verbosity, string fname = "", int line = 0 )
function void	ovm_report_info ( string id, string message, int verbosity, string fname = "", int line = 0 )
function void	ovm_report_warning ( string id, string message, int verbosity, string fname = "", int line = 0 )
function void	set_action ( ovm_action action )
function void	set_id ( string id )
function void	set_message ( string message )
function void	set_severity ( ovm_severity severity )
function void	set_verbosity ( int verbosity )
Member Typedefs
typedef enum	action_e

svt_report_catcher Class Reference

Public Member Functions

Public Attributes

Protected Member Functions

Member Typedefs

Member Function Documentation

Member Attribute Documentation

Member Typedef Documentation