[source]

Class uvm_pkg::uvm_report_message

uvm_pkg::uvm_report_message + type_name : string + __m_uvm_field_automation(): void + add_int(): void + add_object(): void + add_string(): void + create(): uvm_object + do_copy(): void + do_print(): void + do_record(): void + get_action(): uvm_action + get_context(): string + get_element_container(): uvm_report_message_element_container + get_file(): UVM_FILE + get_filename(): string + get_id(): string + get_line(): int + get_message(): string + get_object_type(): uvm_object_wrapper + get_report_handler(): uvm_report_handler + get_report_object(): uvm_report_object + get_report_server(): uvm_report_server + get_severity(): uvm_severity + get_type(): type_id + get_type_name(): string + get_verbosity(): int + m_record_core_properties(): void + m_record_message(): void + new_report_message(): uvm_report_message + set_action(): void + set_context(): void + set_file(): void + set_filename(): void + set_id(): void + set_line(): void + set_message(): void + set_report_handler(): void + set_report_message(): void + set_report_object(): void + set_report_server(): void + set_severity(): void + set_verbosity(): void

Collaboration Diagram of uvm_report_message

CLASS

uvm_report_message

The uvm_report_message is the basic UVM object message class. It provides the fields that are common to all messages. It also has a message element container and provides the APIs necessary to add integral types, strings and uvm_objects to the container. The report message object can be initialized with the common fields, and passes through the whole reporting system (i.e. report object, report handler, report server, report catcher, etc) as an object. The additional elements can be added/deleted to/from the message object anywhere in the reporting system, and can be printed or recorded along with the common fields.

Constructors

new(string name = "uvm_report_message")

Function

new

Creates a new uvm_report_message object.

Parameters:

name (string)

Functions

new_report_message(string name = "uvm_report_message")

Function

new_report_message

Creates a new uvm_report_message object. This function is the same as new(), but keeps the random stability.

Parameters:

name (string)

Return type:

uvm_report_message

do_print(uvm_printer printer)
Parameters:

printer (uvm_printer)

do_copy(uvm_object rhs)

Not documented.

Parameters:

rhs (uvm_object)

get_report_object()

Function

get_report_object

Return type:

uvm_report_object

set_report_object(uvm_report_object ro)

Function

set_report_object

Get or set the uvm_report_object that originated the message.

Parameters:

ro (uvm_report_object)

get_report_handler()

Function

get_report_handler

Return type:

uvm_report_handler

set_report_handler(uvm_report_handler rh)

Function

set_report_handler

Get or set the uvm_report_handler that is responsible for checking whether the message is enabled, should be upgraded/downgraded, etc.

Parameters:

rh (uvm_report_handler)

get_report_server()

Function

get_report_server

Return type:

uvm_report_server

set_report_server(uvm_report_server rs)

Function

set_report_server

Get or set the uvm_report_server that is responsible for servicing the message's actions.

Parameters:

rs (uvm_report_server)

get_severity()

Function

get_severity

Return type:

uvm_severity

set_severity(uvm_severity sev)

Function

set_severity

Get or set the severity (UVM_INFO, UVM_WARNING, UVM_ERROR or UVM_FATAL) of the message. The value of this field is determined via the API used (uvm_info(), uvm_waring(), etc.) and populated for the user.

Parameters:

sev (uvm_severity)

get_id()

Function

get_id

set_id(string id)

Function

set_id

Get or set the id of the message. The value of this field is completely under user discretion. Users are recommended to follow a consistent convention. Settings in the uvm_report_handler allow various messaging controls based on this field. See uvm_report_handler.

Parameters:

id (string)

get_message()

Function

get_message

set_message(string msg)

Function

set_message

Get or set the user message content string.

Parameters:

msg (string)

get_verbosity()

Function

get_verbosity

set_verbosity(int ver)

Function

set_verbosity

Get or set the message threshold value. This value is compared against settings in the uvm_report_handler to determine whether this message should be executed.

Parameters:

ver (int)

get_filename()

Function

get_filename

set_filename(string fname)

Function

set_filename

Get or set the file from which the message originates. This value is automatically populated by the messaging macros.

Parameters:

fname (string)

get_line()

Function

get_line

set_line(int ln)

Function

set_line

Get or set the line in the file from which the message originates. This value is automatically populate by the messaging macros.

Parameters:

ln (int)

get_context()

Function

get_context

set_context(string cn)

Function

set_context

Get or set the optional user-supplied string that is meant to convey the context of the message. It can be useful in scopes that are not inherently UVM like modules, interfaces, etc.

Parameters:

cn (string)

get_action()

Function

get_action

Return type:

uvm_action

set_action(uvm_action act)

Function

set_action

Get or set the action(s) that the uvm_report_server should perform for this message. This field is populated by the uvm_report_handler during message execution flow.

Parameters:

act (uvm_action)

get_file()

Function

get_file

set_file(UVM_FILE fl)

Function

set_file

Get or set the file that the message is to be written to when the message's action is UVM_LOG. This field is populated by the uvm_report_handler during message execution flow.

Parameters:

fl (UVM_FILE)

get_element_container()

Function

get_element_container

Get the element_container of the message

Return type:

uvm_report_message_element_container

set_report_message(uvm_severity severity, string id, string message, int verbosity, string filename, int line, string context_name)

Function

set_report_message

Set all the common fields of the report message in one shot.

Parameters:

  • severity (uvm_severity)

  • id (string)

  • message (string)

  • verbosity (int)

  • filename (string)

  • line (int)

  • context_name (string)

do_record(uvm_recorder recorder)

Not documented.

Parameters:

recorder (uvm_recorder)

add_int(string name, uvm_bitstream_t value, int size, uvm_radix_enum radix, uvm_action action = (UVM_LOG|UVM_RM_RECORD))

Function

add_int

This method adds an integral type of the name name and value value to the message. The required size field indicates the size of value . The required radix field determines how to display and record the field. The optional print/record bit is to specify whether the element will be printed/recorded.

Parameters:
add_string(string name, string value, uvm_action action = (UVM_LOG|UVM_RM_RECORD))

Function

add_string

This method adds a string of the name name and value value to the message. The optional print/record bit is to specify whether the element will be printed/recorded.

Parameters:

  • name (string)

  • value (string)

  • action (uvm_action)

add_object(string name, uvm_object obj, uvm_action action = (UVM_LOG|UVM_RM_RECORD))

Function

add_object

This method adds a uvm_object of the name name and reference obj to the message. The optional print/record bit is to specify whether the element will be printed/recorded.

Parameters: