uvm_report_server

uvm_report_server is a global server that processes all of the reports generated by an uvm_report_handler.  None of its methods are intended to be called by normal testbench code, although in some circumstances the virtual methods process_report and/or compose_uvm_info may be overloaded in a subclass.

Summary
uvm_report_server
uvm_report_server is a global server that processes all of the reports generated by an uvm_report_handler.
Variables
id_countAn associative array holding the number of occurences for each unique report ID.
Methods
newCreates the central report server, if not already created.
set_serverSets the global report server to use for reporting.
get_serverGets the global report server.
set_max_quit_count
get_max_quit_countGet or set the maximum number of COUNT actions that can be tolerated before an UVM_EXIT action is taken.
set_quit_count
get_quit_count
incr_quit_count
reset_quit_countSet, get, increment, or reset to 0 the quit count, i.e., the number of COUNT actions issued.
is_quit_count_reachedIf is_quit_count_reached returns 1, then the quit counter has reached the maximum.
set_severity_count
get_severity_count
incr_severity_count
reset_severity_countsSet, get, or increment the counter for the given severity, or reset all severity counters to 0.
set_id_count
get_id_count
incr_id_countSet, get, or increment the counter for reports with the given id.
process_reportCalls compose_message to construct the actual message to be output.
compose_messageConstructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself.
summarizeSee uvm_report_object::report_summarize method.
dump_server_stateDumps server state information.
get_serverReturns a handle to the central report server.

id_count

protected int id_count[string]

An associative array holding the number of occurences for each unique report ID.

new

function new()

Creates the central report server, if not already created.  Else, does nothing.  The constructor is protected to enforce a singleton.

set_server

static function void set_server( uvm_report_server  server )

Sets the global report server to use for reporting.  The report server is responsible for formatting messages.

get_server

static function uvm_report_server get_server()

Gets the global report server.  The method will always return a valid handle to a report server.

set_max_quit_count

function void set_max_quit_count( int  count,   
bit  overridable  =  1 )

get_max_quit_count

function int get_max_quit_count()

Get or set the maximum number of COUNT actions that can be tolerated before an UVM_EXIT action is taken.  The default is 0, which specifies no maximum.

set_quit_count

function void set_quit_count( int  quit_count )

get_quit_count

function int get_quit_count()

incr_quit_count

function void incr_quit_count()

reset_quit_count

function void reset_quit_count()

Set, get, increment, or reset to 0 the quit count, i.e., the number of COUNT actions issued.

is_quit_count_reached

function bit is_quit_count_reached()

If is_quit_count_reached returns 1, then the quit counter has reached the maximum.

set_severity_count

function void set_severity_count( uvm_severity  severity,
int  count )

get_severity_count

function int get_severity_count( uvm_severity  severity )

incr_severity_count

function void incr_severity_count( uvm_severity  severity )

reset_severity_counts

function void reset_severity_counts()

Set, get, or increment the counter for the given severity, or reset all severity counters to 0.

set_id_count

function void set_id_count( string  id,
int  count )

get_id_count

function int get_id_count( string  id )

incr_id_count

function void incr_id_count( string  id )

Set, get, or increment the counter for reports with the given id.

process_report

virtual function void process_report( uvm_severity  severity,
string  name,
string  id,
string  message,
uvm_action  action,
UVM_FILE  file,
string  filename,
int  line,
string  composed_message,
int  verbosity_level,
uvm_report_object  client )

Calls compose_message to construct the actual message to be output.  It then takes the appropriate action according to the value of action and file.

This method can be overloaded by expert users to customize the way the reporting system processes reports and the actions enabled for them.

compose_message

virtual function string compose_message( uvm_severity  severity,
string  name,
string  id,
string  message,
string  filename,
int  line )

Constructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself.

Expert users can overload this method to customize report formatting.

summarize

virtual function void summarize( UVM_FILE  file  =  )

dump_server_state

function void dump_server_state()

Dumps server state information.

get_server

function uvm_report_server get_server()

Returns a handle to the central report server.

protected int id_count[string]
An associative array holding the number of occurences for each unique report ID.
function new()
Creates the central report server, if not already created.
static function void set_server( uvm_report_server  server )
Sets the global report server to use for reporting.
static function uvm_report_server get_server()
Gets the global report server.
function void set_max_quit_count( int  count,   
bit  overridable  =  1 )
function int get_max_quit_count()
Get or set the maximum number of COUNT actions that can be tolerated before an UVM_EXIT action is taken.
function void set_quit_count( int  quit_count )
function int get_quit_count()
function void incr_quit_count()
function void reset_quit_count()
Set, get, increment, or reset to 0 the quit count, i.e., the number of COUNT actions issued.
function bit is_quit_count_reached()
If is_quit_count_reached returns 1, then the quit counter has reached the maximum.
function void set_severity_count( uvm_severity  severity,
int  count )
function int get_severity_count( uvm_severity  severity )
function void incr_severity_count( uvm_severity  severity )
function void reset_severity_counts()
Set, get, or increment the counter for the given severity, or reset all severity counters to 0.
function void set_id_count( string  id,
int  count )
function int get_id_count( string  id )
function void incr_id_count( string  id )
Set, get, or increment the counter for reports with the given id.
virtual function void process_report( uvm_severity  severity,
string  name,
string  id,
string  message,
uvm_action  action,
UVM_FILE  file,
string  filename,
int  line,
string  composed_message,
int  verbosity_level,
uvm_report_object  client )
Calls compose_message to construct the actual message to be output.
virtual function string compose_message( uvm_severity  severity,
string  name,
string  id,
string  message,
string  filename,
int  line )
Constructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself.
virtual function void summarize( UVM_FILE  file  =  )
See uvm_report_object::report_summarize method.
virtual function void report_summarize( UVM_FILE  file  =  0 )
Outputs statistical information on the reports issued by the central report server.
function void dump_server_state()
Dumps server state information.