SVT svt_vip_writer Class Member List

This is the complete list of members for class svt_vip_writer, including all inherited members.


 svt_vip_writer   function void  add_if_paths ( string if_paths[] )  Adds an array of interface path into the FSDB scope with a predefined attribute name. The interface path is added to predefined attribute name "verdi_link_interface" by which we can take advantage of verdi APIs to read the data from FSDB. If the interface paths are multiple the attribute name will be incremented with numeric Eg:"verdi_link_interface_1","verdi_link_interface_2" etc.  
 svt_vip_writer   function bit  add_object_child ( string object_uid, string child_object_uid )  Adds a child object to the object with the specified uid. An object can have multiple child objects, as appropriate for the protocol. This method can be called up until the point at which the object is ended.  
 svt_vip_writer   function bit  add_object_children ( string object_uid, string child_object_uids[] )  Adds an array of child objects to the object with the specified uid. This method can be called up until the point at which the object is ended.  
 svt_vip_writer   function bit  add_object_successor ( string object_uid, string successor_object_uid, svt_vip_writer successor_writer = null )  Adds a successor object to the object with the specified uid. An object can have multiple successor objects, as appropriate for the protocol. This method can be called up until the point at which the object is ended.  
 svt_vip_writer   function bit  add_object_successors ( string object_uid, string successor_object_uids[], svt_vip_writer successor_writer = null )  Adds an array of successor objects to the object with the specified uid. This method can be called up until the point at which the object is ended.  
 svt_vip_writer   function bit  add_object_tag ( string object_uid, string tag_name )  Adds a tag to an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the object.  
 svt_vip_writer   function bit  add_pa_reference ( string ref_object_uid )  Adds an single object ref to XML file. This method is added to support backward compatibility.  
 svt_vip_writer   function bit  add_scope_attribute ( string attr_name, string attr_value, string scope_name = "" )  Utility function used to add a scope attribute, incorporating 'fsdb_file' if present.  
 svt_vip_writer   function bit  add_stream_attribute ( string attr_name, string attr_value )  Utility function used to add a stream attribute.  
 svt_vip_writer   function bit  close_writer ( )  Closes the file handle for the currently opened file. Once the writer is closed, no additional objects can be associated with the writer.  
 svt_vip_writer   function void  enable_debug_opts ( string vip_path )  Utility method to set up the VIP writer class to be used with the debug opts infrastructure. This is used to modify the top-level scope that transactions are recorded in.  
 svt_vip_writer   function int  get_file_handle ( )  Get a handle to the file that is being written to.  
 svt_vip_writer   function int  get_format_type ( )  Method to get the format type which has been established. The format types: 0 FSDB, 1 XML, and 2 for both FSDB and XML.  
 svt_vip_writer   function svt_vip_writer_object  get_object_from_uid ( string object_uid, bit check_begin_time = 1, bit find_all = 0 )  Retrieves the instance of the svt_vip_writer_object class that is associated with the specified object uid. If no object can be located within the array of unended objects, the method will report and error and return null.  
 svt_vip_writer   function bit  is_writer_open ( )  Gets the opened / closed status of the writer.  
 svt_vip_writer   function void  new ( string instance_name, string protocol_name, string protocol_version, string suite_name = "", string file_name = "", int format_type = 0 )  Constructs a new instance of the svt_vip_writer class.  
 svt_vip_writer   function bit  object_begin ( string object_uid )  Begins an object. When this method is called, the begin time of the object is set to the current simulation time, if not already set. If the begin time of the object has already been set, the object has already been started and this method will have no effect on the object; however, an error will be reported and the method will return a failure status.  
 svt_vip_writer   function string  object_create ( string object_type, string object_uid = "", string parent_object_uid = "", string object_channel = "", realtime begin_time = -1, realtime end_time = -1, string status = "", string time_unit = "", string label = "", string attr_nameattr_name = [$], string attr_valattr_val = [$] )  Creates a new object and returns the uid for the newly-created object. The start time for the object is set to the current simulation time.  
 svt_vip_writer   function bit  object_end ( string object_uid )  Ends an object. When this method is called, the end time of the object is set to the current simulation time. At this point, all information about the object is considered to have been specified; thus, no further changes can be made to the attributes associated with the object.  
 svt_vip_writer   function bit  open_writer ( )  Opens the file handle for a file in write mode. This method must be called prior to creating any objects that are associated with the writer.  
 svt_vip_writer  string  pa_object_refs [$] The uids of the child objects. An empty queue indicates that the object has no child objects. This is added to support backward compatibility. 
 svt_vip_writer   function void  record_vip_info ( string vip_name, string if_path )  Records various aspects of the VIP in the FSDB as scope attributes  
 svt_vip_writer  uvm_report_object  reporter Built-in shared reporter instance that will be used by the XML writer instance.  
 svt_vip_writer   function bit  save_object_begin_block ( string object_uid, string object_block_desc = "" )  Creates a new object XML data and save it to temp data structure. This method is added for backward compatibility. This method receives the complete begin block to be written.  
 svt_vip_writer   function bit  set_custom_relation ( string source_object_uid, string target_object_uid, string relation_type, svt_vip_writer target_writer = null )  This function sets the custom transaction relation for the 'target_object_uid' to the 'source_object_uid' inside FSDB.  
 svt_vip_writer   function bit  set_custom_relations ( string source_object_uid, string target_object_uids[], string relation_type, svt_vip_writer target_writer = null )  This function sets the custom transaction relation for all 'target_object_uids' to the 'source_object_uid' inside FSDB.  
 svt_vip_writer   function bit  set_file_dump_format ( int format_type )  This method set the file format type enum to the format the data needs to be dumpped. The format types: 0 FSDB, 1 XML, and 2 for both FSDB and XML.  
 svt_vip_writer   function bit  set_object_channel ( string object_uid, string channel )  Specifies the channel with which the object with the specified uid is associated. This method can be called up until the point at which the object is ended.  
 svt_vip_writer   function bit  set_object_field_value_bit ( string object_uid, string field_name, bit field_value, bit expected_field_value = 0, bit has_expected = 0 )  Specifies the value of a bit field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_field_value_bit_vector ( string object_uid, string field_name, bit [1023:0] field_value, int numbits = 4096, bit [1023:0] expected_field_value = 0, bit has_expected = 0 )  Specifies the value of a bit-vector field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_field_value_int ( string object_uid, string field_name, longint field_value, int numbits = 32, longint expected_field_value = 0, bit has_expected = 0 )  Specifies the value of a integer field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_field_value_logic_vector ( string object_uid, string field_name, logic [1023:0] field_value, int numbits = 4096, logic [1023:0] expected_field_value = 0, bit has_expected = 0 )  Specifies the value of a logic-vector field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_field_value_real ( string object_uid, string field_name, real field_value, real expected_field_value = 0, bit has_expected = 0 )  Specifies the value of a real field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_field_value_string ( string object_uid, string field_name, string field_value, string expected_field_value = "", bit has_expected = 0 )  Specifies the value of a string field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_field_value_time ( string object_uid, string field_name, realtime field_value, realtime expected_field_value = 0, bit has_expected = 0, string time_unit_val = "" )  Specifies the value of a time field for an object. This method can be called up until the point at which the object is ended; however, only the last value specified is associated with the field.  
 svt_vip_writer   function bit  set_object_parent ( string object_uid, string parent_object_uid )  Specifies the uid of the parent object for the object with the specified uid. This method can be called up until the point at which the object is ended.  
 svt_vip_writer   function bit  set_object_predecessor ( string object_uid, string predecessor_object_uid, svt_vip_writer predecessor_writer = null )  Specifies the uid of the predecessor object for the object with the specified uid. This method can be called up until the point at which the object is ended.