The UVM “Transaction Recording Database” classes are an abstract representation of the backend tool which is recording information for the user. Usually this tool would be dumping information such that it can be viewed with the waves of the DUT.
| Transaction Recording Databases | |
| The UVM “Transaction Recording Database” classes are an abstract representation of the backend tool which is recording information for the user. |
The uvm_text_tr_database is the default implementation for the uvm_tr_database. It provides the ability to store recording information into a textual log file.
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
| uvm_text_tr_database | |||||
| The uvm_text_tr_database is the default implementation for the uvm_tr_database. | |||||
| Class Hierarchy | |||||
| |||||
| Class Declaration | |||||
| |||||
| new | Constructor | ||||
| Implementation Agnostic API | |||||
| do_open_db | Open the backend connection to the database. | ||||
| do_close_db | Close the backend connection to the database. | ||||
| do_open_stream | Provides a reference to a stream within the database. | ||||
| do_establish_link | Establishes a link between two elements in the database | ||||
| Implementation Specific API | |||||
| set_file_name | Sets the file name which will be used for output. | ||||
function new( string name = "unnamed-uvm_text_tr_database" )
Constructor
| name | Instance name |
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
protected virtual function bit do_open_db()
Open the backend connection to the database.
Text-Backend implementation of <uvm_tr_database::open_db>.
The text-backend will open a text file to dump all records in to. The name of this text file is controlled via set_file_name.
This will also lock the file_name, so that it cannot be modified while the connection is open.
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
protected virtual function bit do_close_db()
Close the backend connection to the database.
Text-Backend implementation of <uvm_tr_database::close_db>.
The text-backend will close the text file used to dump all records in to, if it is currently opened.
This unlocks the file_name, allowing it to be modified again.
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
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.
Text-Backend implementation of <uvm_tr_database::open_stream>
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
protected virtual function void do_establish_link( uvm_link_base link )
Establishes a link between two elements in the database
Text-Backend implementation of <uvm_tr_database::establish_link>.
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
function void set_file_name( string filename )
Sets the file name which will be used for output.
The set_file_name method can only be called prior to open_db.
By default, the database will use a file named “tr_db.log”.
@uvm-accellera The details of this API are specific to the Accellera implementation, and are not being considered for contribution to 1800.2
The uvm_void class is the base class for all UVM classes.
virtual class uvm_void
The uvm_object class is the base class for all UVM data and hierarchical classes.
virtual class uvm_object extends uvm_void
The uvm_tr_database class is intended to hide the underlying database implementation from the end user, as these details are often vendor or tool-specific.
virtual class uvm_tr_database extends uvm_object
The uvm_text_tr_database is the default implementation for the uvm_tr_database.
class uvm_text_tr_database extends uvm_tr_database
Constructor
function new( string name = "unnamed-uvm_text_tr_database" )
Open the backend connection to the database.
protected virtual function bit do_open_db()
Close the backend connection to the database.
protected virtual function bit do_close_db()
Provides a reference to a stream within the database.
protected virtual function uvm_tr_stream do_open_stream( string name, string scope, string type_name )
Establishes a link between two elements in the database
protected virtual function void do_establish_link( uvm_link_base link )
Sets the file name which will be used for output.
function void set_file_name( string filename )