SVT svt_xml_writer Class Member List

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


 svt_xml_writer  static svt_sequence_item_base  active_cfgs [string] Register active configuration, provides a way to cache cfg handles when the request to save a cfg occurs before the creation of the writer. The writer creation then accesses this cache to obtain a handle to the cfg and insure it is written into XML/FSDB. 
 svt_xml_writer  static svt_xml_writer  active_writers [string] Register active writer when created, the string value is the component the writer is associated. 
 svt_xml_writer   function void  add_if_paths ( string if_paths[] )  This method calls the 'svt_vip_writer' API to add the interface path into FSDB.  
 svt_xml_writer   function bit  add_object_successor ( string object_uid, string successor_object_uid, svt_xml_writer successor_writer = null )  This is a wrapper API provided for clients to capture the successor object information inside XML/FSDB.  
 svt_xml_writer   function bit  add_object_successors ( string object_uid, string successor_object_uids[], svt_xml_writer successor_writer = null )  This is a wrapper API provided for clients to capture the set of successor object's information inside XML/FSDB.  
 svt_xml_writer   function bit  add_scope_attribute ( string attr_name, string attr_value, string scope_name = "" )  Utility function used to add a scope attribute.  
 svt_xml_writer   function bit  add_stream_attribute ( string attr_name, string attr_value )  Utility function used to add a stream attribute.  
 svt_xml_writer   function bit  begin_pa_xml ( string prot_name, string inst_name, string version = "" )  This method opens the file and writes out the XML header.  
 svt_xml_writer  protected bit  begin_pa_xml_done = 0; Flag to indicate whether we have executed the 'begin' for the xml.  
 svt_xml_writer  enum value  BOTH   
 svt_xml_writer  protected int  client_control [string] Additional controls that clients can register and access during generation.  
 svt_xml_writer   function bit  end_pa_xml ( )  This method writes out the XML trailer and closes the file.  
 svt_xml_writer  protected bit  end_pa_xml_done = 0; Flag to indicate whether we have executed the 'begin' for the xml.  
 svt_xml_writer  protected int  file Handle to the file that is being written to.  
 svt_xml_writer  enum  format_type_enum   
 svt_xml_writer  typedef  format_type_enum   
 svt_xml_writer  enum value  FSDB   
 svt_xml_writer  enum value  FSDB_PERF_ANALYSIS   
 svt_xml_writer   function svt_xml_writer  get_active_writer ( string inst_name )  Retrive 'writer' instance for the given full hierarchical name. If the writer not found for given full hierarchical name try if any 'writer' associated for 'parent hierarchical name', if found retrive writer and register 'parent' writer to given full hierarchical name to enahance performance for subsequent retrivals.  
 svt_xml_writer   function bit  get_begin_pa_xml_done ( )  Utility function for getting the begin_pa_xml_done value.  
 svt_xml_writer   function int  get_client_control ( string name )  Retrieves a client control value from the XML writer.  
 svt_xml_writer   function bit  get_end_pa_xml_done ( )  Utility function for getting the end_pa_xml_done value.  
 svt_xml_writer   function int  get_file ( )  Get a handle to the file that is being written to.  
 svt_xml_writer   function format_type_enum  get_format_type ( )  Method used to get the format type of the writer.  
 svt_xml_writer   function void  new ( string prot_name, string inst_name, string version = "", string file_ext = "", string suite_name = "", svt_xml_writer :: format_type_enum format_type = FSDB )  CONSTRUCTOR: Creates a new instance of the svt_xml_writer class.  
 svt_xml_writer  string  object_uid Holds the uid for the current object. Added to support backward compatibility. 
 svt_xml_writer   function void  register_client_control ( string name, int value )  Registers a client control with the XML writer.  
 svt_xml_writer  uvm_report_object  reporter Built-in shared reporter instance that will be used by the XML writer instance.  
 svt_xml_writer   function bit  set_custom_relation ( string source_object_uid, string target_object_uid, string relation_type, svt_xml_writer target_writer = null )  This is a wrapper API provided for clients to capture the custom object relation inside FSDB.  
 svt_xml_writer   function bit  set_custom_relations ( string source_object_uid, string target_object_uids[], string relation_type, svt_xml_writer target_writer = null )  This is a wrapper API provided for clients to capture the custom object relation inside FSDB.  
 svt_xml_writer   function bit  set_object_predecessor ( string object_uid, string predecessor_object_uid, svt_xml_writer predecessor_writer = null )  This is a wrapper API provided for clients to capture the predecessor object information inside XML/FSDB.  
 svt_xml_writer  protected svt_vip_writer  vip_writer VIP Writer instance to create FSDB or XML  
 svt_xml_writer   function bit  write_pa_block_close ( string block_name, string prefix = "" )  This method writes the XML trailer to the indicated XML file.  
 svt_xml_writer   function bit  write_pa_block_open ( string block_name, string block_text = "", string prefix = "" )  This method writes the XML header to the file.  
 svt_xml_writer   function bit  write_pa_child_reference ( string object_uid, string child_object_uid )  This method writes child references to the file.  
 svt_xml_writer   function bit  write_pa_comment ( string comment, string prefix = "" )  This method writes a comment to the indicated XML file. This method is deprecated shouldn't be used in new implementation. Added to support backward compatibiltiy.  
 svt_xml_writer   function bit  write_pa_field_name_string_value ( string object_uid, string name, string arr_val, string arr_exp_val, bit is_expected = 0, string prefix )  This method writes field name and an a string representation of associated value to the indicated XML/FSDB file.  
 svt_xml_writer   function bit  write_pa_field_name_value ( string object_uid, string name, bit [1023:0] value, bit [1023:0] expected_value, input svt_pattern_data :: type_enum typ, bit is_expected = 0, int unsigned bit_width = 0 )  This method writes field name/value pair to XML/FSDB, the value will always be in bit vector converted to right data type and written out to XML/FSDB accordingly.  
 svt_xml_writer   function bit  write_pa_name_value ( string name, string value, string prefix = "" )  This method writes a name/value pair to the indicated XML file. This method is added to set the filed name and field value to the current object to be written to XML. This method is used only for backward compatibility where some clients directly called the field value writing. This methods needs to be removed once all the clients moved to new writer methods.  
 svt_xml_writer   function bit  write_pa_object_begin ( string object_type, string object_uid, string parent_object_uid, string channel, realtime start_time, realtime end_time, string status, string time_unit = "" )  This method writes the object begin information to the file.  
 svt_xml_writer   function bit  write_pa_object_begin_block ( string object_uid, string object_block_desc )  This method writes object begin block to XML file. This method is added only to support backward compatibility for existing VIPs, shouldn't be used by any new VIPs tor existing VIPs updatingPA XML support.  
 svt_xml_writer   function bit  write_pa_object_close ( string object_uid )  This method writes the object end information to the file.  
 svt_xml_writer   function bit  write_pa_one_field_record ( string record_name, string field_name, string field_value, string prefix )  This method writes a one field record out to the indicated XML file.  
 svt_xml_writer  enum value  XML