Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z

C |
| Callback Hooks uvm_objection
| Callback Interface uvm_report_catcher
| Callback Macros
| callback_mode uvm_callback
| Callbacks uvm_mem uvm_phase uvm_reg uvm_reg_field uvm_vreg uvm_vreg_field
| Callbacks Classes
| can_get uvm_tlm_if_base#(T1,T2)
| can_peek uvm_tlm_if_base#(T1,T2)
| can_put uvm_tlm_if_base#(T1,T2)
| cancel uvm_barrier uvm_event_base
| capacity uvm_reg_fifo
| catch uvm_report_catcher
| CB uvm_callbacks#(T,CB)
| Change Message State uvm_report_catcher
| check_config_usage uvm_component
| check_data_width uvm_reg_block
| check_phase uvm_component uvm_reg_predictor
| check_type uvm_comparer
| Classes for Adapting Between Register and Bus Operations
| clear uvm_objection
| clear_extension uvm_tlm_generic_payload
| clear_extensions uvm_tlm_generic_payload
| clear_hdl_path uvm_mem uvm_reg uvm_reg_block uvm_reg_file
| clear_response_queue uvm_sequence_base
| clone uvm_object
| close uvm_recorder uvm_tr_stream
| close_db uvm_tr_database
| Code migration script
| Command Line Debug uvm_cmdline_processor
| Command Line Processor Class
| Comparators comps/ uvm_in_order_comparator.svh overviews/ comparators.txt
| compare uvm_object
| compare_field uvm_comparer
| compare_field_int uvm_comparer
| compare_field_real uvm_comparer
| compare_object uvm_comparer
| compare_string uvm_comparer
| Comparing uvm_object
| compose_report_message uvm_default_report_server uvm_report_server
| Conditional Compilation
| Configuration uvm_object
| Configuration and Resource Classes
| Configuration API uvm_recorder uvm_tr_stream
| Configuration Interface uvm_component
| configure uvm_mem uvm_reg uvm_reg_block uvm_reg_field uvm_reg_file uvm_reg_indirect_data uvm_reg_map uvm_vreg uvm_vreg_field
| configure_phase uvm_component
| connect uvm_port_base#(IF)uvm_tlm_nb_passthrough_target_socket uvm_tlm_nb_target_socket
| Connect uvm_tlm_b_initiator_socket uvm_tlm_b_target_socket uvm_tlm_nb_initiator_socket
| connect_phase uvm_component
| Construction uvm_phase
| Container Classes
| Convenience Methods uvm_report_handler
| Convenience Write/ Read API uvm_reg_sequence
| convert2string uvm_mem_mam uvm_object uvm_reg_item
| copy uvm_object
| Copying uvm_object
| Core Base Classes
| Coverage uvm_mem uvm_reg uvm_reg_block
| create uvm_component_registry#(T,Tname)uvm_object uvm_object_registry#(T,Tname)uvm_tlm_extension_base
| create_component uvm_component uvm_component_registry#(T,Tname)uvm_object_wrapper
| create_component_by_name uvm_default_factory uvm_factory
| create_component_by_type uvm_default_factory uvm_factory
| create_item uvm_sequence_base
| create_map uvm_reg_block
| create_object uvm_component uvm_object_registry#(T,Tname)uvm_object_wrapper
| create_object_by_name uvm_default_factory uvm_factory
| create_object_by_type uvm_default_factory uvm_factory
| Creation uvm_default_factory uvm_factory uvm_object
| Current Message State uvm_report_catcher
| current_grabber uvm_sequencer_base
D |
| data uvm_reg_bus_op
| Data Access Policies
| Database API uvm_tr_database
| Debug uvm_callbacks#(T,CB)uvm_default_factory uvm_factory uvm_report_catcher uvm_resource_pool
| debug_connected_to uvm_port_base#(IF)
| debug_create_by_name uvm_default_factory uvm_factory
| debug_create_by_type uvm_default_factory uvm_factory
| debug_provided_to uvm_port_base#(IF)
| dec_radix uvm_printer_knobs
| decode uvm_reg_cbs
| decr uvm_tlm_time
| Default Policy Classes
| default_alloc uvm_mem_mam
| default_map uvm_reg_block
| default_path uvm_reg_block
| default_precedence uvm_resource_base
| default_radix uvm_printer_knobs uvm_recorder
| define_access uvm_reg_field
| define_domain uvm_component
| delete uvm_callbacks#(T,CB)uvm_object_string_pool#(T)uvm_pool#(KEY,T)uvm_queue#(T)uvm_report_message_element_container
| delete_by_name uvm_callbacks#(T,CB)
| delete_callback uvm_event#(T)
| delete_elements uvm_report_message_element_container
| depth uvm_printer_knobs
| die uvm_root
| disable_auto_item_recording uvm_sqr_if_base#(REQ,RSP)
| disable_recording uvm_transaction
| display uvm_callbacks#(T,CB)
| display_objections uvm_objection
| do_accept_tr uvm_component uvm_transaction
| do_begin_tr uvm_component uvm_transaction
| do_block uvm_mem_access_seq uvm_mem_walk_seq uvm_reg_access_seq uvm_reg_bit_bash_seq uvm_reg_hw_reset_seq uvm_reg_mem_shared_access_seq
| do_bus_read uvm_reg_map
| do_bus_write uvm_reg_map
| do_close uvm_recorder uvm_text_recorder uvm_text_tr_stream uvm_tr_stream
| do_close_db uvm_text_tr_database uvm_tr_database
| do_compare uvm_object
| do_copy uvm_object uvm_reg_item uvm_report_server
| do_end_tr uvm_component uvm_transaction
| do_establish_link uvm_text_tr_database uvm_tr_database
| do_free uvm_recorder uvm_text_recorder uvm_text_tr_stream uvm_tr_stream
| do_get_lhs uvm_cause_effect_link uvm_link_base uvm_parent_child_link uvm_related_link
| do_get_rhs uvm_cause_effect_link uvm_link_base uvm_parent_child_link uvm_related_link
| do_kill uvm_sequence_base
| do_not_randomize uvm_sequence_base
| do_open uvm_recorder uvm_text_recorder uvm_text_tr_stream uvm_tr_stream
| do_open_db uvm_text_tr_database uvm_tr_database
| do_open_recorder uvm_text_tr_stream uvm_tr_stream
| do_open_stream uvm_text_tr_database uvm_tr_database
| do_pack uvm_object
| do_post_read uvm_reg_backdoor
| do_post_write uvm_reg_backdoor
| do_pre_read uvm_reg_backdoor
| do_pre_write uvm_reg_backdoor
| do_predict uvm_reg_fifo
| do_print uvm_object uvm_resource_base
| do_read uvm_reg_map
| do_record uvm_object
| do_record_field uvm_recorder uvm_text_recorder
| do_record_field_int uvm_recorder uvm_text_recorder
| do_record_field_real uvm_recorder uvm_text_recorder
| do_record_generic uvm_recorder uvm_text_recorder
| do_record_object uvm_recorder uvm_text_recorder
| do_record_string uvm_recorder uvm_text_recorder
| do_record_time uvm_recorder uvm_text_recorder
| do_reg_item uvm_reg_sequence
| do_set_lhs uvm_cause_effect_link uvm_link_base uvm_parent_child_link uvm_related_link
| do_set_rhs uvm_cause_effect_link uvm_link_base uvm_parent_child_link uvm_related_link
| do_unpack uvm_object
| do_write uvm_reg_map
| drop_objection uvm_objection uvm_phase
| dropped uvm_component uvm_objection uvm_objection_callback
| dump uvm_resource_db uvm_resource_pool
E |
| element uvm_reg_item
| element_kind uvm_reg_item
| emit uvm_printer uvm_table_printer uvm_tree_printer
| enable_print_topology uvm_root
| enable_recording uvm_transaction
| enable_report_id_count_summary uvm_default_report_server
| encode uvm_reg_cbs
| end_elements uvm_printer_knobs
| end_event uvm_transaction
| end_of_elaboration_phase uvm_component
| end_offset uvm_mem_mam_cfg
| end_prematurely uvm_phase
| END_REQ
| END_RESP
| end_tr uvm_component uvm_transaction
| end_v uvm_visitor#(NODE)
| Enumerations reg/ uvm_reg_model.svh tlm2/ uvm_tlm2_ifs.svh
| establish_link uvm_tr_database
| events uvm_transaction
| Example uvm_reg_adapter
| exec_func uvm_phase
| exec_task uvm_phase
| execute uvm_bottomup_phase uvm_task_phase uvm_topdown_phase
| execute_item uvm_sequencer_base
| execute_report_message uvm_default_report_server uvm_report_server
| exists uvm_config_db uvm_pool#(KEY,T)
| Explicit Register Predictor
| extension uvm_reg_item
| Extensions Mechanism uvm_tlm_generic_payload
| extract_phase uvm_component

These macros are used to register and execute callbacks extending from uvm_callbacks.

> function bit callback_mode(
> | int | on | = | -1
> )

Enable/disable callbacks (modeled like rand_mode and constraint_mode).
This section defines the classes used for callback registration, management, and user-defined callbacks.

> virtual function bit can_get()

Returns 1 if a new transaction can be provided immediately upon request, 0 otherwise.

> virtual function bit can_peek()

Returns 1 if a new transaction is available; 0 otherwise.

> virtual function bit can_put()

Returns 1 if the component is ready to accept the transaction; 0 otherwise.

> virtual function void cancel ()

Decrements the waiter count by one.

> virtual function void cancel ()

Decrements the number of waiters on the event.

> function int unsigned capacity()

The maximum number of entries, or depth, of the FIFO.

> pure virtual function action_e catch()

This is the method that is called for each registered report catcher.
This type parameter specifies the base callback type that will be managed by this callback class.

> function void check_config_usage (
> | bit | recurse | = | 1
> )

Check all configuration settings in a components configuration table to determine if the setting has been used, overridden or not used.

> protected static function bit check_data_width(
> | int | unsigned | width
> )

Check that the specified data width (in bits) is less than or equal to the value of `UVM_REG_DATA_WIDTH

> virtual function void check_phase(
> | uvm_phase | phase
> )

The uvm_check_phase phase implementation method.

> virtual function void check_phase(
> | uvm_phase | phase
> )

Checks that no pending register transactions are still queued.

> bit check_type = 1

This bit determines whether the type, given by uvm_object::get_type_name, is used to verify that the types of two objects are the same.
This section defines classes used to convert transaction streams between generic register address/data reads and writes and physical bus accesses.

> virtual function void clear(
> | uvm_object | obj | = | null
> )

Immediately clears the objection state.

> function void clear_extension(
> | uvm_tlm_extension_base | ext_handle
> )

Remove the instance-specific extension bound under the specified key.

> function void clear_extensions()

Remove all instance-specific extensions

> function void clear_hdl_path (
> | string | kind | = | "RTL"
> )

Delete HDL paths

> function void clear_hdl_path (
> | string | kind | = | "RTL"
> )

Delete HDL paths

> function void clear_hdl_path (
> | string | kind | = | "RTL"
> )

Delete HDL paths

> function void clear_hdl_path (
> | string | kind | = | "RTL"
> )

Delete HDL paths

> virtual function void clear_response_queue()

Empties the response queue for this sequence.

> virtual function uvm_object clone ()

The clone method creates and returns an exact copy of this object.

> function void close(
> | time | close_time | = | 0
> )

Closes this recorder.

> function void close()

Closes this stream.

> function bit close_db()

Closes the backend connection to the database.
Suitable constructors may be automatically added to classes that are missing them by using the add_uvm_object_new.pl script.
This class provides a general interface to the command line arguments that were provided for the given simulation.
The following classes define comparators for objects and built-in types.

> function bit compare (
> | uvm_object | rhs, |  |
> | uvm_comparer | comparer | = | null
> )

Deep compares members of this data object with those of the object provided in the rhs (right-hand side) argument, returning 1 on a match, 0 otherwise.

> virtual function bit compare_field (
> | string | name, |  |
> | uvm_bitstream_t | lhs, |  |
> | uvm_bitstream_t | rhs, |  |
> | int | size, |  |
> | uvm_radix_enum | radix | = | UVM_NORADIX
> )

Compares two integral values.

> virtual function bit compare_field_int (
> | string | name, |  |
> | uvm_integral_t | lhs, |  |
> | uvm_integral_t | rhs, |  |
> | int | size, |  |
> | uvm_radix_enum | radix | = | UVM_NORADIX
> )

This method is the same as compare_field except that the arguments are small integers, less than or equal to 64 bits.

> virtual function bit compare_field_real (
> | string | name,
> | real | lhs,
> | real | rhs
> )

This method is the same as compare_field except that the arguments are real numbers.

> virtual function bit compare_object (
> | string | name,
> | uvm_object | lhs,
> | uvm_object | rhs
> )

Compares two class objects using the policy knob to determine whether the comparison should be deep, shallow, or reference.

> virtual function bit compare_string (
> | string | name,
> | string | lhs,
> | string | rhs
> )

Compares two string variables.

> virtual function string compose_report_message(
> | uvm_report_message | report_message, |  |
> | string | report_object_name | = | ""
> )

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

> pure virtual function string compose_report_message(
> | uvm_report_message | report_message, |  |
> | string | report_object_name | = | ""
> )

Constructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself.
These macros provide the ability to conditionally compile based on the revision of the library which is being used.
The configuration and resources classes provide access to a centralized database where type specific information can be stored and received.
Components can be designed to be user-configurable in terms of its topology (the type and number of children it has), mode of operation, and run-time parameters (knobs).

> function void configure (
> | uvm_reg_block | parent, |  |
> | string | hdl_path | = | ""
> )

Instance-specific configuration

> function void configure (
> | uvm_reg_block | blk_parent, |  |
> | uvm_reg_file | regfile_parent | = | null,
> | string | hdl_path | = | ""
> )

Instance-specific configuration

> function void configure(
> | uvm_reg_block | parent | = | null,
> | string | hdl_path | = | ""
> )

Instance-specific configuration

> function void configure(
> |  | uvm_reg | parent,
> | int | unsigned | size,
> | int | unsigned | lsb_pos,
> |  | string | access,
> |  | bit | volatile,
> |  | uvm_reg_data_t | reset,
> |  | bit | has_reset,
> |  | bit | is_rand,
> |  | bit | individually_accessible
> )

Instance-specific configuration

> function void configure (
> | uvm_reg_block | blk_parent, |  |
> | uvm_reg_file | regfile_parent, |  |
> | string | hdl_path | = | ""
> )

Configure a register file instance

> function void configure (
> | uvm_reg | idx, |  |
> | uvm_reg | reg_a[], |  |
> | uvm_reg_block | blk_parent, |  |
> | uvm_reg_file | regfile_parent | = | null
> )

Configure the indirect data register.

> function void configure(
> |  | uvm_reg_block | parent, |  |
> |  | uvm_reg_addr_t | base_addr, |  |
> | int | unsigned | n_bytes, |  |
> |  | uvm_endianness_e | endian, |  |
> |  | bit | byte_addressing | = | 1
> )

Instance-specific configuration

> function void configure(
> |  | uvm_reg_block | parent, |  |
> |  | uvm_mem | mem | = | null,
> | longint | unsigned | size | = | 0,
> |  | uvm_reg_addr_t | offset | = | 0,
> | int | unsigned | incr | = | 0
> )

Instance-specific configuration

> function void configure(
> |  | uvm_vreg | parent,
> | int | unsigned | size,
> | int | unsigned | lsb_pos
> )

Instance-specific configuration

> virtual task configure_phase(
> | uvm_phase | phase
> )

The uvm_configure_phase phase implementation method.

> virtual function void connect (
> | this_type | provider
> )

Connects this port to the given provider port.

> function void connect(
> | this_type | provider
> )

Connect this socket to the specified uvm_tlm_nb_initiator_socket

> function void connect(
> | this_type | provider
> )

Connect this socket to the specified uvm_tlm_nb_initiator_socket
Connect this socket to the specified uvm_tlm_b_target_socket
Connect this socket to the specified uvm_tlm_b_initiator_socket
Connect this socket to the specified uvm_tlm_nb_target_socket

> virtual function void connect_phase(
> | uvm_phase | phase
> )

The uvm_connect_phase phase implementation method.
The container classes are type parameterized data structures.
The following methods delegate to the corresponding method in the register or memory element.

> function string convert2string()

Image of the state of the manager

> virtual function string convert2string()

This virtual function is a user-definable hook, called directly by the user, that allows users to provide object information in the form of a string.

> virtual function string convert2string()

Returns a string showing the contents of this transaction.

> function void copy (
> | uvm_object | rhs
> )

The copy makes this object a copy of the specified object.
The UVM library defines a set of base classes and utilities that facilitate the design of modular, scalable, reusable verification environments.

> static function T create(
> | string | name, |  |
> | uvm_component | parent, |  |
> | string | contxt | = | ""
> )

Returns an instance of the component type, T, represented by this proxy, subject to any factory overrides based on the context provided by the parent’s full name.

> virtual function uvm_object create (
> | string | name | = | ""
> )

The create method allocates a new object of the same type as this object and returns it via a base uvm_object handle.

> static function T create (
> | string | name | = | "",
> | uvm_component | parent | = | null,
> | string | contxt | = | ""
> )

Returns an instance of the object type, T, represented by this proxy, subject to any factory overrides based on the context provided by the parent’s full name.

> virtual function uvm_object create (
> | string | name | = | ""
> )

> function uvm_component create_component (
> | string | requested_type_name,
> | string | name
> )

A convenience function for uvm_factory::create_component_by_name, this method calls upon the factory to create a new child component whose type corresponds to the preregistered type name, requested_type_name, and instance name, name.

> virtual function uvm_component create_component (
> | string | name,
> | uvm_component | parent
> )

Creates a component of type T having the provided name and parent.

> virtual function uvm_component create_component (
> | string | name,
> | uvm_component | parent
> )

Creates a new component, passing to its constructor the given name and parent.

> virtual function uvm_component create_component_by_name (
> | string | requested_type_name, |  |
> | string | parent_inst_path | = | "",
> | string | name, |  |
> | uvm_component | parent |  |
> )

Creates and returns a component or object of the requested type, which may be specified by type or by name.

> pure virtual function uvm_component create_component_by_name (
> | string | requested_type_name, |  |
> | string | parent_inst_path | = | "",
> | string | name, |  |
> | uvm_component | parent |  |
> )

Creates and returns a component or object of the requested type, which may be specified by type or by name.

> virtual function uvm_component create_component_by_type (
> | uvm_object_wrapper | requested_type, |  |
> | string | parent_inst_path | = | "",
> | string | name, |  |
> | uvm_component | parent |  |
> )

> pure virtual function uvm_component create_component_by_type (
> | uvm_object_wrapper | requested_type, |  |
> | string | parent_inst_path | = | "",
> | string | name, |  |
> | uvm_component | parent |  |
> )

> protected function uvm_sequence_item create_item(
> | uvm_object_wrapper | type_var,
> | uvm_sequencer_base | l_sequencer,
> | string | name
> )

Create_item will create and initialize a sequence_item or sequence using the factory.

> virtual function uvm_reg_map create_map(
> |  | string | name, |  |
> |  | uvm_reg_addr_t | base_addr, |  |
> | int | unsigned | n_bytes, |  |
> |  | uvm_endianness_e | endian, |  |
> |  | bit | byte_addressing | = | 1
> )

Create an address map in this block

> function uvm_object create_object (
> | string | requested_type_name, |  |
> | string | name | = | ""
> )

A convenience function for uvm_factory::create_object_by_name, this method calls upon the factory to create a new object whose type corresponds to the preregistered type name, requested_type_name, and instance name, name.

> virtual function uvm_object create_object(
> | string | name | = | ""
> )

Creates an object of type T and returns it as a handle to a uvm_object.

> virtual function uvm_object create_object (
> | string | name | = | ""
> )

Creates a new object with the optional name.

> virtual function uvm_object create_object_by_name (
> | string | requested_type_name, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

> pure virtual function uvm_object create_object_by_name (
> | string | requested_type_name, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

> virtual function uvm_object create_object_by_type (
> | uvm_object_wrapper | requested_type, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

> pure virtual function uvm_object create_object_by_type (
> | uvm_object_wrapper | requested_type, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

> virtual function uvm_sequence_base current_grabber()

Returns a reference to the sequence that currently has a lock or grab on the sequence.

> uvm_reg_data_t data

The data to write.
The UVM provides special objects as utility classes for applying common policies to data access (such as ‘locking’ data, or ensuring that it remains constant after being read).

> function void debug_connected_to (
> | int | level | = | 0,
> | int | max_level | = | -1
> )

The debug_connected_to method outputs a visual text display of the port/export/imp network to which this port connects (i.e., the port’s fanout).

> virtual function void debug_create_by_name (
> | string | requested_type_name, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

These methods perform the same search algorithm as the create_* methods, but they do not create new objects.

> pure virtual function void debug_create_by_name (
> | string | requested_type_name, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

These methods perform the same search algorithm as the create_* methods, but they do not create new objects.

> virtual function void debug_create_by_type (
> | uvm_object_wrapper | requested_type, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

> pure virtual function void debug_create_by_type (
> | uvm_object_wrapper | requested_type, |  |
> | string | parent_inst_path | = | "",
> | string | name | = | ""
> )

> function void debug_provided_to (
> | int | level | = | 0,
> | int | max_level | = | -1
> )

The debug_provided_to method outputs a visual display of the port/export network that ultimately connect to this port (i.e., the port’s fanin).

> string dec_radix = "'d"

This string should be prepended to the value of an integral type when a radix of UVM_DEC is used for the radix of the integral object.

> virtual function void decode(
> | ref | uvm_reg_data_t | data[]
> )

Data decode

> function void decr(
> | real | t,
> | time | scaled,
> | real | secs
> )

Decrement the time value by the specified number of scaled time unit
Policy classes copying, comparing, packing, unpacking, and recording uvm_object-based objects.

> uvm_mem_mam_policy default_alloc

Region allocation policy

> uvm_reg_map default_map

Default address map

> uvm_path_e default_path = UVM_DEFAULT_PATH

Default access path for the registers and memories in this block.

> static int unsigned default_precedence = 1000

The default precedence for an resource that has been created.

> uvm_radix_enum default_radix = UVM_HEX

This knob sets the default radix to use for integral values when no radix enum is explicitly supplied to the uvm_printer::print_field or uvm_printer::print_field_int methods.

> uvm_radix_enum default_radix = UVM_HEX

This is the default radix setting if record_field is called without a radix.

> static function bit define_access(
> | string | name
> )

Define a new access policy value

> virtual protected function void define_domain(
> | uvm_domain | domain
> )

Builds custom phase schedules into the provided domain handle.

> static function void delete(
> | T | obj,
> | uvm_callback | cb
> )

Deletes the given callback object, cb, from the queue associated with the given obj handle.

> virtual function void delete (
> | string | key
> )

Removes the item with the given string key from the pool.

> virtual function void delete (
> | KEY | key
> )

Removes the item with the given key from the pool.

> virtual function void delete (
> | int | index | = | -1
> )

Removes the item at the given index from the queue; if index is not provided, the entire contents of the queue are deleted.

> virtual function void delete(
> | int | index
> )

Delete the index-th element in the container

> static function void delete_by_name(
> | string | name,
> | uvm_callback | cb,
> | uvm_component | root
> )

Removes the given callback object, cb, associated with one or more uvm_component callback queues.

> virtual function void delete_callback (
> | uvm_event_callback#(T) | cb
> )

Unregisters the given callback, cb, from this event.

> virtual function void delete_elements()

Delete all the elements in the container

> int depth = -1

Indicates how deep to recurse when printing objects.

> virtual function void die()

This method is called by the report server if a report reaches the maximum quit count or has a UVM_EXIT action associated with it, e.g., as with fatal errors.

> virtual function void disable_auto_item_recording()

By default, item recording is performed automatically when get_next_item() and item_done() are called.

> function void disable_recording ()

Turns off recording for the transaction stream.

> static function void display(
> | T | obj | = | null
> )

This function displays callback information for obj.

> function void display_objections(
> | uvm_object | obj | = | null,
> | bit | show_header | = | 1
> )

Displays objection information about the given object.

> virtual protected function void do_accept_tr (
> | uvm_transaction | tr
> )

The accept_tr method calls this function to accommodate any user-defined post-accept action.

> virtual protected function void do_accept_tr ()

This user-definable callback is called by accept_tr just before the accept event is triggered.

> virtual protected function void do_begin_tr (
> | uvm_transaction | tr,
> | string | stream_name,
> | integer | tr_handle
> )

The begin_tr and begin_child_tr methods call this function to accommodate any user-defined post-begin action.

> virtual protected function void do_begin_tr ()

This user-definable callback is called by begin_tr and begin_child_tr just before the begin event is triggered.

> protected virtual task do_block(
> | uvm_reg_block | blk
> )

Test all of the memories in a given block

> protected virtual task do_block(
> | uvm_reg_block | blk
> )

Test all of the memories in a given block

> protected virtual task do_block(
> | uvm_reg_block | blk
> )

Test all of the registers in a block

> protected virtual task do_block(
> | uvm_reg_block | blk
> )

Test all of the registers in a given block

> protected virtual task do_block(
> | uvm_reg_block | blk
> )

Test all of the registers in a given block

> protected virtual task do_block(
> | uvm_reg_block | blk
> )

Test all of the registers and memories in a block

> virtual task do_bus_read (
> | uvm_reg_item | rw,
> | uvm_sequencer_base | sequencer,
> | uvm_reg_adapter | adapter
> )

Perform a bus read operation.

> virtual task do_bus_write (
> | uvm_reg_item | rw,
> | uvm_sequencer_base | sequencer,
> | uvm_reg_adapter | adapter
> )

Perform a bus write operation.

> protected virtual function void do_close(
> | time | close_time
> )

Callback triggered via close.

> protected virtual function void do_close(
> | time | close_time
> )

Callback triggered via uvm_recorder::close.

> protected virtual function void do_close()

Callback triggered via uvm_tr_stream::close.

> protected virtual function void do_close()

Callback triggered via close.

> protected virtual function bit do_close_db()

Close the backend connection to the database.

> pure virtual protected function bit do_close_db()

Backend implementation of close_db

> virtual function bit do_compare (
> | uvm_object | rhs,
> | uvm_comparer | comparer
> )

The do_compare method is the user-definable hook called by the compare method.

> virtual function void do_copy (
> | uvm_object | rhs
> )

The do_copy method is the user-definable hook called by the copy method.

> virtual function void do_copy(
> | uvm_object | rhs
> )

Copy the rhs object into this object.

> function void do_copy (
> | uvm_object | rhs
> )

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)

> virtual protected function void do_end_tr (
> | uvm_transaction | tr,
> | integer | tr_handle
> )

The end_tr method calls this function to accommodate any user-defined post-end action.

> virtual protected function void do_end_tr ()

This user-definable callback is called by end_tr just before the end event is triggered.

> protected virtual function void do_establish_link(
> | uvm_link_base | link
> )

Establishes a link between two elements in the database

> pure virtual protected function void do_establish_link(
> | uvm_link_base | link
> )

Backend implementation of establish_link

> protected virtual function void do_free()

Callback triggered via free.

> protected virtual function void do_free()

Callback triggered via uvm_recorder::free.

> protected virtual function void do_free()

Callback triggered via uvm_tr_stream::free.

> protected virtual function void do_free()

Callback triggered via free.

> virtual function uvm_object do_get_lhs()

Retrieves the left-hand-side (Cause)

> pure virtual function uvm_object do_get_lhs()

Callback for retrieving the left-hand-side

> virtual function uvm_object do_get_lhs()

Retrieves the left-hand-side (Parent)

> virtual function uvm_object do_get_lhs()

Retrieves the left-hand-side

> virtual function uvm_object do_get_rhs()

Retrieves the right-hand-side (Effect)

> pure virtual function uvm_object do_get_rhs()

Callback for retrieving the right-hand-side

> virtual function uvm_object do_get_rhs()

Retrieves the right-hand-side (Child)

> virtual function uvm_object do_get_rhs()

Retrieves the right-hand-side

> virtual function void do_kill()

This function is a user hook that is called whenever a sequence is terminated by using either sequence.kill() or sequencer.stop_sequences() (which effectively calls sequence.kill()).

> bit do_not_randomize

If set, prevents the sequence from being randomized before being executed by the `uvm_do*() and `uvm_rand_send*() macros, or as a default sequence.

> protected virtual function void do_open(
> | uvm_tr_stream | stream,
> | time | open_time,
> | string | type_name
> )

Callback triggered via uvm_tr_stream::open_recorder.

> protected virtual function void do_open(
> | uvm_tr_stream | stream,
> | time | open_time,
> | string | type_name
> )

Callback triggered via uvm_tr_stream::open_recorder.

> protected virtual function void do_open(
> | uvm_tr_database | db,
> | string | scope,
> | string | stream_type_name
> )

Callback triggered via uvm_tr_database::open_stream.

> protected virtual function void do_open(
> | uvm_tr_database | db,
> | string | scope,
> | string | stream_type_name
> )

Callback triggered via uvm_tr_database::open_stream.

> protected virtual function bit do_open_db()

Open the backend connection to the database.

> pure virtual protected function bit do_open_db()

Backend implementation of open_db

> protected virtual function uvm_recorder do_open_recorder(
> | string | name,
> | time | open_time,
> | string | type_name
> )

Marks the beginning of a new record in the stream

> protected virtual function uvm_recorder do_open_recorder(
> | string | name,
> | time | open_time,
> | string | type_name
> )

Marks the beginning of a new record in the stream.

> protected virtual function uvm_tr_stream do_open_stream(
> | string | name,
> | string | scope,
> | string | type_name
> )

Provides a reference to a stream within the database.

> pure virtual protected function uvm_tr_stream do_open_stream(
> | string | name,
> | string | scope,
> | string | type_name
> )

Backend implementation of open_stream

> virtual function void do_pack (
> | uvm_packer | packer
> )

The do_pack method is the user-definable hook called by the pack methods.

> protected task do_post_read(
> | uvm_reg_item | rw
> )

Execute the post-read callbacks

> protected task do_post_write(
> | uvm_reg_item | rw
> )

Execute the post-write callbacks

> protected task do_pre_read(
> | uvm_reg_item | rw
> )

Execute the pre-read callbacks

> protected task do_pre_write(
> | uvm_reg_item | rw
> )

Execute the pre-write callbacks

> virtual function void do_predict(
> | uvm_reg_item | rw, |  |
> | uvm_predict_e | kind | = | UVM_PREDICT_DIRECT,
> | uvm_reg_byte_en_t | be | = | -1
> )

Updates the abstract (mirror) FIFO based on write() and read() operations.

> virtual function void do_print (
> | uvm_printer | printer
> )

The do_print method is the user-definable hook called by print and sprint that allows users to customize what gets printed or sprinted beyond the field information provided by the `uvm_field_* macros, Utility and Field Macros for Components and Objects.

> function void do_print (
> | uvm_printer | printer
> )

Implementation of do_print which is called by print().

> virtual task do_read(
> | uvm_reg_item | rw
> )

Perform a read operation.

> virtual function void do_record (
> | uvm_recorder | recorder
> )

The do_record method is the user-definable hook called by the record method.

> pure virtual protected function void do_record_field(
> | string | name,
> | uvm_bitstream_t | value,
> | int | size,
> | uvm_radix_enum | radix
> )

Records an integral field (less than or equal to 4096 bits).

> protected virtual function void do_record_field(
> | string | name,
> | uvm_bitstream_t | value,
> | int | size,
> | uvm_radix_enum | radix
> )

Records an integral field (less than or equal to 4096 bits).

> pure virtual protected function void do_record_field_int(
> | string | name,
> | uvm_integral_t | value,
> | int | size,
> | uvm_radix_enum | radix
> )

Records an integral field (less than or equal to 64 bits).

> protected virtual function void do_record_field_int(
> | string | name,
> | uvm_integral_t | value,
> | int | size,
> | uvm_radix_enum | radix
> )

Records an integral field (less than or equal to 64 bits).

> pure virtual protected function void do_record_field_real(
> | string | name,
> | real | value
> )

Records a real field.

> protected virtual function void do_record_field_real(
> | string | name,
> | real | value
> )

Record a real field.

> pure virtual protected function void do_record_generic(
> | string | name,
> | string | value,
> | string | type_name
> )

Records a name/value pair, where value has been converted to a string.

> protected virtual function void do_record_generic(
> | string | name,
> | string | value,
> | string | type_name
> )

Records a name/value pair, where value has been converted to a string.

> pure virtual protected function void do_record_object(
> | string | name,
> | uvm_object | value
> )

Records an object field.

> protected virtual function void do_record_object(
> | string | name,
> | uvm_object | value
> )

Record an object field.

> pure virtual protected function void do_record_string(
> | string | name,
> | string | value
> )

Records a string field.

> protected virtual function void do_record_string(
> | string | name,
> | string | value
> )

Records a string field.

> pure virtual protected function void do_record_time(
> | string | name,
> | time | value
> )

Records a time field.

> protected virtual function void do_record_time(
> | string | name,
> | time | value
> )

Records a time field.

> virtual task do_reg_item(
> | uvm_reg_item | rw
> )

Executes the given register transaction, rw, via the sequencer on which this sequence was started (i.e.

> virtual function void do_set_lhs(
> | uvm_object | lhs
> )

Sets the left-hand-side (Cause)

> pure virtual function void do_set_lhs(
> | uvm_object | lhs
> )

Callback for setting the left-hand-side

> virtual function void do_set_lhs(
> | uvm_object | lhs
> )

Sets the left-hand-side (Parent)

> virtual function void do_set_lhs(
> | uvm_object | lhs
> )

Sets the left-hand-side

> virtual function void do_set_rhs(
> | uvm_object | rhs
> )

Sets the right-hand-side (Effect)

> pure virtual function void do_set_rhs(
> | uvm_object | rhs
> )

Callback for setting the right-hand-side

> virtual function void do_set_rhs(
> | uvm_object | rhs
> )

Sets the right-hand-side (Child)

> virtual function void do_set_rhs(
> | uvm_object | rhs
> )

Sets the right-hand-side

> virtual function void do_unpack (
> | uvm_packer | packer
> )

The do_unpack method is the user-definable hook called by the unpack method.

> virtual task do_write(
> | uvm_reg_item | rw
> )

Perform a write operation.

> virtual function void drop_objection (
> | uvm_object | obj | = | null,
> | string | description | = | "",
> | int | count | = | 1
> )

Drops the number of objections for the source object by count, which defaults to 1.

> virtual function void drop_objection (
> | uvm_object | obj, |  |
> | string | description | = | "",
> | int | count | = | 1
> )

Drop an objection to ending this phase

> virtual function void dropped (
> | uvm_objection | objection,
> | uvm_object | source_obj,
> | string | description,
> | int | count
> )

The dropped callback is called when this or a descendant of this component instance drops the specified objection.

> virtual function void dropped (
> | uvm_object | obj,
> | uvm_object | source_obj,
> | string | description,
> | int | count
> )

Objection callback that is called when a drop_objection has reached obj.

> virtual function void dropped (
> | uvm_objection | objection,
> | uvm_object | obj,
> | uvm_object | source_obj,
> | string | description,
> | int | count
> )

Objection dropped callback function.

> static function void dump()

Dump all the resources in the resource pool.

> function void dump(
> | bit | audit | = | 0
> )

dump the entire resource pool.

> uvm_object element

A handle to the RegModel model element associated with this transaction.

> uvm_elem_kind_e element_kind

Kind of element being accessed: REG, MEM, or FIELD.

> virtual function string emit ()

Emits a string representing the contents of an object in a format defined by an extension of this object.

> virtual function string emit()

Formats the collected information from prior calls to print_* into table format.

> virtual function string emit()

Formats the collected information from prior calls to print_* into hierarchical tree format.

> bit enable_print_topology = 0

If set, then the entire testbench topology is printed just after completion of the end_of_elaboration phase.

> function void enable_recording (
> | uvm_tr_stream | stream
> )

Turns on recording to the stream specified.

> bit enable_report_id_count_summary=1

A flag to enable report count summary for each ID

> virtual function void encode(
> | ref | uvm_reg_data_t | data[]
> )

Data encoder

> int end_elements = 5

This defines the number of elements at the end of a list that should be printed.

> uvm_event#(
> | uvm_object
> ) end_event

A uvm_event#(uvm_object) that is triggered when this transaction’s actual execution on the bus ends, typically as a result of a driver calling uvm_component::end_tr.

> virtual function void end_of_elaboration_phase(
> | uvm_phase | phase
> )

The uvm_end_of_elaboration_phase phase implementation method.

> rand bit [63:0] end_offset

Last address of managed space

> function void end_prematurely()

Set a flag to cause the phase to end prematurely.
End of request phase
End of response phase

> function void end_tr (
> | uvm_transaction | tr, |  |
> | time | end_time | = | 0,
> | bit | free_handle | = | 1
> )

This function marks the end of a transaction, tr, by this component.

> function void end_tr (
> | time | end_time | = | 0,
> | bit | free_handle | = | 1
> )

This function indicates that the transaction execution has ended.

> virtual function void end_v()

This method will be invoked by the visitor after the last NODE is visited

> function void establish_link(
> | uvm_link_base | link
> )

Establishes a link between two elements in the database

> const uvm_event_pool events = new

The event pool instance for this transaction.
The following example illustrates how to implement a RegModel-BUS adapter class for the APB bus protocol.

> virtual function void exec_func(
> | uvm_component | comp,
> | uvm_phase | phase
> )

Implements the functor/delegate functionality for a function phase type comp - the component to execute the functionality upon phase - the phase schedule that originated this phase call

> virtual task exec_task(
> | uvm_component | comp,
> | uvm_phase | phase
> )

Implements the functor/delegate functionality for a task phase type comp - the component to execute the functionality upon phase - the phase schedule that originated this phase call

> virtual function void execute(
> | uvm_component | comp,
> | uvm_phase | phase
> )

Executes the bottom-up phase phase for the component comp.

> virtual function void execute(
> | uvm_component | comp,
> | uvm_phase | phase
> )

Fork the task-based phase phase for the component comp.

> virtual function void execute(
> | uvm_component | comp,
> | uvm_phase | phase
> )

Executes the top-down phase phase for the component comp.

> virtual task execute_item(
> | uvm_sequence_item | item
> )

Executes the given transaction item directly on this sequencer.

> virtual function void execute_report_message(
> | uvm_report_message | report_message,
> | string | composed_message
> )

Processes the provided message per the actions contained within.

> pure virtual function void execute_report_message(
> | uvm_report_message | report_message,
> | string | composed_message
> )

Processes the provided message per the actions contained within.

> static function bit exists(
> | uvm_component | cntxt, |
> | string | inst_name, |
> | string | field_name, |
> | bit | spell_chk | =
> )

Check if a value for field_name is available in inst_name, using component cntxt as the starting search point.

> virtual function int exists (
> | KEY | key
> )

Returns 1 if an item with the given key exists in the pool, 0 otherwise.
The uvm_reg_predictor class defines a predictor component, which is used to update the register model’s mirror values based on transactions explicitly observed on a physical bus.

> rand uvm_object extension

Handle to optional user data, as conveyed in the call to write(), read(), mirror(), or update() used to trigger the operation.

> virtual function void extract_phase(
> | uvm_phase | phase
> )

The uvm_extract_phase phase implementation method.