[source]

Class uvm_pkg::uvm_report_server

uvm_pkg::uvm_report_server + compose_report_message(): string + do_copy(): void + execute_report_message(): void + get_id_count(): int + get_id_set(): void + get_max_quit_count(): int + get_message_database(): uvm_tr_database + get_quit_count(): int + get_server(): uvm_report_server + get_severity_count(): int + get_severity_set(): void + get_type_name(): string + process_report_message(): void + report_summarize(): void + set_id_count(): void + set_max_quit_count(): void + set_message_database(): void + set_quit_count(): void + set_server(): void + set_severity_count(): void + summarize(): void uvm_pkg::uvm_default_report_server

Inheritance Diagram of uvm_report_server

Constructors

new(string name = "base")
Parameters:

name (string)

Functions

get_type_name()
set_max_quit_count(int count, bit overridable = 1)

Function

set_max_quit_count

count is the maximum number of UVM_QUIT actions the uvm_report_server will tolerate before invoking client.die(). when overridable = 0 is passed, the set quit count cannot be changed again

Parameters:

  • count (int)

  • overridable (bit)

get_max_quit_count()

Function

get_max_quit_count

returns the currently configured max quit count

set_quit_count(int quit_count)

Function

set_quit_count

sets the current number of UVM_QUIT actions already passed through this uvm_report_server

Parameters:

quit_count (int)

get_quit_count()

Function

get_quit_count

returns the current number of UVM_QUIT actions already passed through this server

set_severity_count(uvm_severity severity, int count)

Function

set_severity_count

sets the count of already passed messages with severity severity to count

Parameters:
get_severity_count(uvm_severity severity)

Function

get_severity_count

returns the count of already passed messages with severity severity

Parameters:

severity (uvm_severity)

set_id_count(string id, int count)

Function

set_id_count

sets the count of already passed messages with id to count

Parameters:

  • id (string)

  • count (int)

get_id_count(string id)

Function

get_id_count

returns the count of already passed messages with id

Parameters:

id (string)

get_id_set(string q)

Function

get_id_set

returns the set of id's already used by this uvm_report_server

Parameters:

q (string)

get_severity_set(uvm_severity q)

Function

get_severity_set

returns the set of severities already used by this uvm_report_server

Parameters:

q (uvm_severity)

set_message_database(uvm_tr_database database)

Function

set_message_database

sets the uvm_tr_database used for recording messages

Parameters:

database (uvm_tr_database)

get_message_database()

Function

get_message_database

returns the uvm_tr_database used for recording messages

Return type:

uvm_tr_database

do_copy(uvm_object rhs)

Function

do_copy

copies all message statistic severity,id counts to the destination uvm_report_server the copy is cummulative (only items from the source are transferred, already existing entries are not deleted, existing entries/counts are overridden when they exist in the source set)

Parameters:

rhs (uvm_object)

process_report_message(uvm_report_message report_message)

Function- process_report_message

Main entry for uvm_report_server, combines execute_report_message and compose_report_message

Parameters:

report_message (uvm_report_message)

execute_report_message(uvm_report_message report_message, string composed_message)

Function

execute_report_message

Processes the provided message per the actions contained within.

Expert users can overload this method to customize action processing.

Parameters:
compose_report_message(uvm_report_message report_message, string report_object_name = "")

Function

compose_report_message

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.

Parameters:
report_summarize(UVM_FILE file = 0)

Function

report_summarize

Outputs statistical information on the reports issued by this central report server. This information will be sent to the command line if file is 0, or to the file descriptor file if it is not 0.

The run_test method in uvm_top calls this method.

Parameters:

file (UVM_FILE)

summarize(UVM_FILE file = 0)

Function- summarize

Parameters:

file (UVM_FILE)

set_server(uvm_report_server server)

Function

set_server

Sets the global report server to use for reporting.

This method is provided as a convenience wrapper around setting the report server via the uvm_coreservice_t::set_report_server method.

In addition to setting the server this also copies the severity/id counts from the current report_server to the new one

 // Using the uvm_coreservice_t:
 uvm_coreservice_t cs;
 cs = uvm_coreservice_t::get();
 your_server.copy(cs.get_report_server());
 cs.set_report_server(your_server);

 // Not using the uvm_coreservice_t:
 uvm_report_server::set_server(your_server);
Parameters:

server (uvm_report_server)

get_server()

Function

get_server

Gets the global report server used for reporting.

This method is provided as a convenience wrapper around retrieving the report server via the uvm_coreservice_t::get_report_server method.

 // Using the uvm_coreservice_t:
 uvm_coreservice_t cs;
 uvm_report_server rs;
 cs = uvm_coreservice_t::get();
 rs = cs.get_report_server();

 // Not using the uvm_coreservice_t:
 uvm_report_server rs;
 rs = uvm_report_server::get_server();
Return type:

uvm_report_server