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.
| uvm_report_server | |
| uvm_report_server is a global server that processes all of the reports generated by an uvm_report_handler. | |
| Variables | |
| id_count | An associative array holding the number of occurences for each unique report ID. |
| Methods | |
| new | Creates the central report server, if not already created. |
| set_server | Sets the global report server to use for reporting. |
| get_server | Gets the global report server. |
| set_max_quit_count | |
| get_max_quit_count | Get 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_count | Set, get, increment, or reset to 0 the quit count, i.e., the number of COUNT actions issued. |
| is_quit_count_reached | If 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_counts | Set, get, or increment the counter for the given severity, or reset all severity counters to 0. |
| set_id_count | |
| get_id_count | |
| incr_id_count | Set, get, or increment the counter for reports with the given id. |
| process_report | Calls compose_message to construct the actual message to be output. |
| compose_message | Constructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself. |
| summarize | See uvm_report_object::report_summarize method. |
| dump_server_state | Dumps server state information. |
| 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. Else, does nothing. The constructor is protected to enforce a singleton.
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.
static function uvm_report_server get_server()
Gets the global report server. The method will always return a valid handle to a 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. The default is 0, which specifies no maximum.
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. 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.
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.
virtual function void summarize( UVM_FILE file = )
See uvm_report_object::report_summarize method.
An associative array holding the number of occurences for each unique report ID.
protected int id_count[string]
Creates the central report server, if not already created.
function new()
Sets the global report server to use for reporting.
static function void set_server( uvm_report_server server )
Gets the global report server.
static function uvm_report_server get_server()
function void set_max_quit_count( int count, bit overridable = 1 )
Get or set the maximum number of COUNT actions that can be tolerated before an UVM_EXIT action is taken.
function int get_max_quit_count()
function void set_quit_count( int quit_count )
function int get_quit_count()
function void incr_quit_count()
Set, get, increment, or reset to 0 the quit count, i.e., the number of COUNT actions issued.
function void reset_quit_count()
If is_quit_count_reached returns 1, then the quit counter has reached the maximum.
function bit is_quit_count_reached()
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 )
Set, get, or increment the counter for the given severity, or reset all severity counters to 0.
function void reset_severity_counts()
function void set_id_count( string id, int count )
function int get_id_count( string id )
Set, get, or increment the counter for reports with the given id.
function void incr_id_count( string id )
Calls compose_message to construct the actual message to be output.
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 )
Constructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself.
virtual function string compose_message( uvm_severity severity, string name, string id, string message, string filename, int line )
See uvm_report_object::report_summarize method.
virtual function void summarize( UVM_FILE file = )
Outputs statistical information on the reports issued by the central report server.
virtual function void report_summarize( UVM_FILE file = 0 )
Dumps server state information.
function void dump_server_state()