This is the complete list of members for class svt_debug_opts_carrier, including all inherited members.
| svt_debug_opts_carrier | static protected svt_debug_opts_carrier | __vmm_rhs | |
| svt_data | function void | add_compound_pattern_prop ( svt_pattern pttrn, string owner, string name, svt_pattern_data :: type_enum typ, int unsigned supported_methods_flag = 0, int unsigned field_width = 0, string enum_type = "" ) | Method which can be used to add a single svt_compound_pattern_data element to the provided pattern. |
| svt_pattern_data_carrier | function void | add_multiple_props ( create_struct field_desc[$] ) | Method to add multiple new name/value pairs to the current set of name/value pairs included in the pattern. |
| svt_data | function void | add_pattern_prop ( svt_pattern pttrn, string owner, string name, svt_pattern_data :: type_enum typ, int unsigned supported_methods_flag = 0, int unsigned field_width = 0, string enum_type = "" ) | Method which can be used to add a single svt_pattern_data element to the provided pattern. |
| svt_debug_opts_carrier | function void | add_prop ( string name, bit [1023:0] value = 0, int array_ix = 0, svt_pattern_data :: type_enum typ = svt_pattern_data::UNDEF ) | Method to add a new name/value pair to the current set of name/value pairs included in the pattern. |
| svt_pattern_data_carrier | function void | add_supp_data ( string prop_name, string name, bit [1023:0] value, svt_pattern_data :: type_enum typ = svt_pattern_data::UNDEF ) | Utility method for adding simple supplemental data to an individual property. |
| svt_pattern_data_carrier | function void | add_supp_string ( string prop_name, string name, string value ) | Utility method for adding string supplemental data to an individual property. |
| svt_debug_opts_carrier | virtual function vmm_data | allocate ( ) | |
| svt_data | function svt_pattern | allocate_auto_op_pattern ( int allocate_pattern_filter ) | This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that support automated implementations for the common data methods. |
| svt_data | function svt_pattern | allocate_pattern ( ) | This is a pattern allocation method which is implemented to add properties without including support for the 'automated operation' capabilities. This is provided by VIPs which have not updated to provide the automated operation support via do_allocate_pattern. VIPs should provide one or the other, but not both. |
| svt_data | function svt_pattern | allocate_xml_pattern ( ) | This method allocates a pattern containing svt_pattern_data instances for all of the data fields in the object that are to be included in the object's XML output. |
| svt_data | function bit | auto_compare ( svt_data rhs_data, output string diff ) | Methodology independent 'compare' method for comparing fields based on pattern information. |
| svt_data | function void | auto_copy ( svt_data to ) | Methodology independent 'copy' method for copying fields based on pattern information. |
| svt_data | function unsigned int | auto_pack ( ref logic [7:0] bytes[], input int unsigned offset ) | Methodology independent 'pack' method for packing fields based on pattern information. |
| svt_data | function unsigned int | auto_unpack ( const ref logic [7:0] bytes[], input int unsigned offset ) | Methodology independent 'unpack' method for unpacking fields based on pattern information. |
| svt_debug_opts_carrier | virtual function unsigned int | byte_pack ( ref logic [7:0] bytes[], input int unsigned offset, input int kind ) | |
| svt_data | function unsigned int | byte_size ( int kind = -1 ) | Returns the size (in bytes) required by the byte_pack operation based on the requested byte_size kind. |
| svt_debug_opts_carrier | virtual function unsigned int | byte_unpack ( const ref logic [7:0] bytes[], input int unsigned offset, input int len, input int kind ) | |
| svt_data | static function timeunit_enum | calc_timeunit ( ) | Calculates the timeunit that the VIP has been compiled in. |
| svt_debug_opts_carrier | virtual function bit | compare ( vmm_data to, output string diff, input int kind ) | |
| svt_data | function bit | compare_pattern_data ( svt_pattern_data rhs_pd, output string diff, input string name_override ) | Compare the information associated with a single pattern_data instance. |
| svt_data | function bit | compare_via_pattern ( svt_pattern pttrn ) | This method takes advantage of the get_prop_val method to make a simple way to compare a property pattern with the contents of a data instance. The method simply uses each name specified in pttrn, uses get_prop_val to retrieve the corresponding value from the data instance, and compares it to the value stored in the pattern. |
| svt_data | enum value | COMPLETE | |
| svt_pattern_data_carrier | svt_pattern_data | contents [$] | The properties which have been stored in the carrier. |
| svt_debug_opts_carrier | virtual function vmm_data | copy ( vmm_data to = null ) | |
| vmm_data | int | data_id | |
| svt_data | function bit | decode_pattern_data ( svt_pattern_data pd, ref string pd_string, input string delimiter ) | Simple utility used to convert an svt_pattern_data representation into its equivalent string property value representation. |
| svt_data | function bit | decode_prop_val ( string prop_name, bit [1023:0] prop_val, ref string prop_val_string, input svt_pattern_data :: type_enum typ ) | Simple utility used to convert 'bit [1023:0]' property value representation into its equivalent string property value representation. If provided the type is used by the default implementation to choose an appropriate conversion method. If the type is specified as UNDEF then the the field is assumed to be an int field and the string is assumed to be an ascii int representation. Derived classes can extend this method to support other field representations such as strings, enums, bitvecs, etc. |
| svt_data | enum value | DEEP | |
| svt_data | function void | display_get_prop_val_outcome ( bit success, string prop_name, bit [1023:0] prop_val, int array_ix, svt_data data_obj ) | Method to display the outcome of a get_prop_val operation. |
| svt_data | static int | display_kind = -1; | Used by all svt_data derived display methods to limit the contents of the string generated by the 'psdisplay' method and put to the log by the 'display' method. |
| svt_data | function void | display_set_prop_val_outcome ( bit success, string prop_name, bit [1023:0] prop_val, int array_ix ) | Method to display the outcome of a set_prop_val operation. |
| svt_debug_opts_carrier | function void | do_all ( vmm_data :: do_what_e do_what, ref logic [7:0] pack[], const ref logic [7:0] unpack[] ) | |
| vmm_data | enum value | DO_ALL | |
| svt_pattern_data_carrier | function svt_pattern | do_allocate_pattern ( ) | This method allocates a pattern containing svt_pattern_data instances for all of the primitive data fields in the object. |
| svt_data | function unsigned int | do_byte_pack ( ref logic [7:0] bytes[], input int unsigned offset, input int kind ) | Packs the object into the bytes buffer, beginning at offset, based on the requested byte_pack kind. |
| svt_data | function unsigned int | do_byte_unpack ( const ref logic [7:0] bytes[], input int unsigned offset, input int len, input int kind ) | Unpacks len bytes of the object from the bytes buffer, beginning at offset, based on the requested byte_unpack kind. |
| svt_data | function bit | do_compare ( vmm_data to, output string diff, input int kind ) | Compares the object with to, based on the requested compare kind. Differences are placed in diff. |
| vmm_data | enum value | DO_COMPARE | |
| svt_data | function vmm_data | do_copy ( vmm_data to = null ) | Copies the object into to, allocating if necessay. |
| vmm_data | enum value | DO_COPY | |
| vmm_data | enum value | DO_DEEP | |
| vmm_data | enum value | DO_DEEPCOMPARE | |
| vmm_data | enum value | DO_DEEPCOPY | |
| vmm_data | enum | do_how_e | |
| svt_data | function bit | do_is_valid ( bit silent = 1, int kind = -1 ) | Checks to see that the data field values are valid. |
| vmm_data | enum value | DO_NOCOMPARE | |
| vmm_data | enum value | DO_NOCOPY | |
| vmm_data | enum value | DO_NONE | |
| vmm_data | enum value | DO_PACK | |
| vmm_data | enum value | DO_PRINT | |
| vmm_data | enum value | DO_REF | |
| vmm_data | enum value | DO_REFCOMPARE | |
| vmm_data | enum value | DO_REFCOPY | |
| vmm_data | enum value | DO_UNPACK | |
| vmm_data | enum | do_what_e | |
| svt_data | function bit | encode_prop_val ( string prop_name, string prop_val_string, ref bit [1023:0] prop_val, input svt_pattern_data :: type_enum typ ) | Simple utility used to convert string property value representation into its equivalent 'bit [1023:0]' property value representation. If provided the type is used by the default implementation to choose an appropriate conversion method. If the type is specified as UNDEF then the the field is assumed to be an int field and the string is assumed to be an ascii int representation. Derived classes can extend this method to support other field representations such as strings, enums, bitvecs, etc. |
| vmm_data | enum value | ENDED | |
| vmm_data | enum value | EXECUTE | |
| svt_data | function type_enum | find_type ( string prop_name ) | Utility method which can be used to get the 'type' of the indicated property. |
| svt_debug_opts_carrier | function string | get_class_name ( ) | Returns the name of this class, or a class derived from this class. |
| svt_data | function bit | get_do_compare_done ( ) | Utility to obtain the do_compare_done setting for the object. |
| svt_data | function bit | get_do_pack_done ( ) | Utility to obtain the do_pack_done setting for the object. |
| svt_data | static function string | get_environment_variable_value ( string method_name, string env_var_name, vmm_log log, bit is_optional = 0 ) | Function which can be used to get access to an environment variable. |
| svt_data | function string | get_mcd_class_name ( ) | Returns the name of this class, or a class derived from this class. |
| svt_data | function svt_pa_object_data | get_pa_obj_data ( string uid = "", string typ = "", string parent_uid = "", string channel = "" ) | This method returns PA object which contains the PA header information for XML or FSDB. |
| svt_debug_opts_carrier | function bit [1023:0] | get_primitive_val ( svt_debug_opts_carrier pdc, string name, output int size ) | Used during playback, this method is used to update ref arguments on callbacks. The pattern data carrier object that is recorded prior to callback execution must be supplied because the pattern data carrier object that is obtained post-callback execution are string values, and so the original property type is not available in the post-execution pattern data carrier object. |
| svt_debug_opts_carrier | function bit | get_primitive_vals ( svt_debug_opts_carrier pdc, get_set_struct prim_propsprim_props = [$], output bit [1023:0] prim_vals ) | Returns a queue of prop_val elements |
| svt_pattern_data_carrier | function bit | get_prop_val ( string prop_name, ref bit [1023:0] prop_val, input int array_ix, ref svt_data data_obj ) | This method is used by a component's command interface, to allow command code to retrieve the value of a single named property of a data class derived from this class. If the prop_name argument does not match a property of the class, or if the array_ix argument is not zero and does not point to a valid array element, this function returns '0'. Otherwise it returns '1', with the value of the prop_val argument assigned to the value of the specified property. However, If the property is a sub-object, a reference to it is assigned to the data_obj (ref) argument. In that case, the prop_val argument is meaningless. The component will then store the data object reference in its temporary data object array, and return a handle to its location as the prop_val argument of the get_data_prop task of the component. The command testbench code must then use that handle to access the properties of the sub-object. |
| svt_pattern_data_carrier | function bit | get_prop_val_via_pattern ( ref svt_pattern pttrn ) | Since for do_allocate_pattern this class simply returns its own contents field the expectation is that this will be processing a pattern made up of the original carrier contents. Implying that it already has the values. |
| svt_data | function string | get_suite_name ( ) | Returns the suite name associated with an object. |
| svt_pattern_data_carrier | function bit | get_supp_data_value ( string prop_name, string name, ref bit [1023:0] value ) | Utility method for accessing supplemental data on an individual property. |
| svt_data | static function string | get_timeunit_str ( string class_name, vmm_log log ) | Returns the timeunit that the VIP has been compiled in as a string value. |
| svt_data | function string | get_uid ( ) | This method can be used to obtain a unique identifier for a data object. |
| svt_data | function svt_pattern | get_user_fsdb_props ( ) | User method for providing additional properties, consisting of name/value pairs, that are to be included in any FSDB output. |
| svt_data | function string | get_xml_object_block_desc ( string obj_type = "", string obj_sub_type = "", string parent_uid = "", string channel = "" ) | This method returns a string for use in the XML object block which provides basic information about the object. |
| vmm_data | enum value | HOW_TO_COMPARE | |
| vmm_data | enum value | HOW_TO_COPY | |
| svt_data | function bit | is_safe_as_ref ( svt_xml_writer writer ) | This method indicates whether it will be safe to reference this object in the output generated by the writer. |
| svt_data | function bit | is_silent ( ) | Returns true if silent mode is currently enabled |
| svt_debug_opts_carrier | virtual function bit | is_valid ( bit silent = 1, int kind = -1 ) | |
| svt_data | int | kind = svt_data::UNASSIGNED; | Used as an alternate method for the 'kind' argument to compare, is_valid, byte_size, byte_pack, and byte_unpack. If set to a value other than 10, then this value will be used rather than the 'kind' value that is passed into these methods or the policy class that is passed in. Acceptible values are RELEVANT and COMPLETE. |
| svt_data | enum | kind_enum | Kinds commonly recognized (i.e., via constants) by compare, is_valid, byte_size, byte_pack, and byte_unpack. Although specified as an enum, the constant values associated with these enum elements allow them to be used to define the integer 'kind' parameter to these methods. |
| svt_data | typedef | kind_enum | |
| svt_data | function bit | load ( int file ) | |
| svt_data | function bit | load_from_string ( string text ) | |
| svt_data | function bit | load_prop_vals ( string filename = "", int file = 0 ) | This method loads the property values from the indicated file assuming a basic text format. If filename specified without file then creates file handle and uses it to load the values. If file specified without filename then uses file to load the values. If both filename and file specified than no load is attempted and the failure is indicated via the return. |
| svt_data | function bit | load_prop_vals_with_checks ( string filename = "", int file = 0 ) | This method calls load_prop_vals, but enables checking on the file format and content. |
| svt_data | vmm_log | log | Log instance that will be passed in from a derived class (through the constructor). |
| svt_data | function int | log_base_2 ( int val, bit round_up = 1 ) | This method returns the log_base_2 of provided value. |
| svt_data | static int | max_array_elem_display = SVT_MAX_ARRAY_ELEM_DISPLAY_DEFAULT; | Used by all svt_data derived display methods to limit the number of array entries which are displayed whenever an array data member is displayed. If the number of array elements is less than or equal to the max_array_elem_display value or max_array_elem_display is set to -1, then all array elements are displayed. If max_array_elem_display is set to 0, then only the array size will be displayed. Otherwise max_array_elem_display array elements are displayed. Since this field is not owned by an individual instance, it is not copied, compared, etc., like the other svt_data properties. Initial value set to SVT_MAX_ARRAY_ELEM_DISPLAY_DEFAULT so it can be overridden at compile time. |
| svt_data | function void | mcd_log_object ( int mcd_log_file, string mcd_parameter ) | |
| svt_debug_opts_carrier | function void | new ( vmm_log log = null, string host_inst_name = "", create_struct field_descfield_desc = [$], string obj_class_typeobj_class_type = [$], svt_data prop_objprop_obj = [$], bit [1023:0] prop_valprop_val = [$] ) | CONSTRUCTOR: Creates a new instance of the svt_debug_opts_carrier class. This should only ever be called if debug_opts have been enabled. This is enforced by the SVT_DEBUG_OPTS_CARRIER_PRE_CB macro, so clients are strongly advised to use that macro to create instances of this object. |
| vmm_data | vmm_notify | notify | |
| svt_data | static vmm_log | notify_log = new; | Built-in shared log instance that will be used by the vmm_data.notify instance. |
| svt_data | enum value | NULL | |
| svt_data | function unsigned int | pack_pattern_data ( svt_pattern_data pd, ref logic [7:0] bytes[], input int unsigned offset ) | Pack the information associated with a single pattern_data instance. |
| svt_data | function int | power_of_2 ( int val ) | This method returns the power of 2 of provided value. |
| svt_debug_opts_carrier | virtual function string | psdisplay ( string prefix = "" ) | |
| svt_data | function int | reasonable_constraint_mode ( bit on_off ) | Method to turn reasonable constraints on/off as a block. This method is not implemented in this virtual class. |
| svt_data | enum | recursive_op_enum | Hierachical transaction options. These are used to control how embedded objects are handled for the 'copy' and 'compare' methods. |
| svt_data | typedef | recursive_op_enum | |
| svt_data | enum value | RELEVANT | |
| svt_data | function int | resolve_compare_kind ( int kind ) | Resolves the kind value used for compare operations. |
| svt_data | function int | resolve_is_valid_kind ( int kind ) | Resolves the kind value used for is_valid operations. |
| svt_data | function int | resolve_pack_kind ( int kind ) | Resolves the kind value used for pack/unpack operations. |
| svt_data | function real | safe_atoreal ( string ascii_real ) | Utility method which can be used to safely convert an ascii string to a real value, dealing with any embedded '_' characters. |
| svt_data | function void | save ( int file ) | |
| svt_data | function bit | save_child_refs ( svt_xml_writer writer, string prefix = "" ) | This method can be used to write out Unique IDs for the children of this object using the XML format. The extended class must drive this process, but can use the save_ref method on the to individual children to output those children. |
| svt_data | function bit | save_object_begin ( svt_xml_writer writer ) | This method uses the 'writer' class methods to write out the object begin data to file. This method is intoduced to resolve the Verdi call back issue where during concurrent transaction the order of the transaction has to be correct otherwise Verdi dumper APIs will have performance issue. |
| svt_data | function bit | save_object_data ( svt_xml_writer writer, string prefix = "" ) | This method writes the object start to XML/FSDB file, This method is introduced to resolve the Verdi call back issue where during concurrent transaction the order of the transaction as to be correct otherwise Verdi dumper APIs will have performance issue. |
| svt_data | function bit | save_pattern_to_xml ( svt_xml_writer writer, svt_pa_object_data pa_obj_data, svt_pattern pttrn, string prefix = "" ) | This method writes the property values stored in the pattern to the indicated file using the XML format. |
| svt_data | function bit | save_prop_vals ( string filename = "", int file = 0, string prefix = "" ) | This method saves the property values to the indicated file using a basic text format. If filename specified without file then creates file handle and uses it to saves the values. If file specified without filename then uses file to save the values. If both filename and file specified than no save is attempted and the failure is indicated via the return. |
| svt_data | function bit | save_prop_vals_to_fsdb ( string inst_name, string parent_object_uid = "", string stream_attr_namestream_attr_name = [$], string stream_attr_valstream_attr_val = [$] ) | This method writes the property values associated with this data object to an FSDB file. |
| svt_data | function bit | save_prop_vals_to_fsdb_internal ( string top_level_name, string object_channel, string parent_object_uid = "", string object_uid = "", string prefix = "" ) | This is an internal method and should not be used by external components. |
| svt_data | function bit | save_prop_vals_to_xml ( svt_xml_writer writer, string object_block_desc = "", string prefix = "" ) | This method writes the property values to the indicated file using the XML format. This method relies on the allocate_xml_pattern method to obtain the pattern for the property values to be saved. Therefore the preferred mechanism for altering the format is to overload the allocate_xml_pattern to define a different pattern. |
| svt_data | function bit | save_ref ( svt_xml_writer writer, string prefix = "" ) | This method can be used to write out the Unique IDs for an object using the XML format. |
| vmm_data | int | scenario_id | |
| svt_debug_opts_carrier | function bit | set_multiple_prop_vals ( get_set_struct prop_desc[$] ) | Method to assign multiple values to the corresponding named properties included in the carrier. |
| svt_pattern_data_carrier | function bit | set_prop_object ( string prop_name, svt_data prop_obj, int array_ix ) | This method allows clients to assign an object to a single named property included in the carrier's contents. |
| svt_pattern_data_carrier | function bit | set_prop_val ( string prop_name, bit [1023:0] prop_val, int array_ix ) | This method is used by a component's command interface, to allow command code to set the value of a single named property of a data class derived from this class. This method cannot be used to set the value of a sub-object, since sub-object construction is taken care of automatically by the command interface. If the prop_name argument does not match a property of the class, or it matches a sub-object of the class, or if the array_ix argument is not zero and does not point to a valid array element, this function returns '0'. Otherwise it returns '1'. |
| svt_data | function bit | set_prop_val_via_pattern ( svt_pattern pttrn ) | This method takes advantage of the set_prop_val method to make a simple way to take a common property pattern, and apply it across multiple data instances. The method simply takes all of the name/value pairs specified in pttrn, and uses set_prop_val to apply them to the data instance. |
| svt_data | function void | set_prop_val_via_plusargs ( string plusarg_keyword ) | This method takes advantage of the set_prop_val method to load up a set of property values based on a command line plusarg value. |
| svt_data | enum value | SHALLOW | |
| svt_data | static vmm_log | silent_log = new; | Built-in shared log that is used for all messages issued when in silent mode. |
| svt_data | function void | silent_mode ( bit mode ) | Disables generation of internal messages. This can be used to turn off debug messages while executing a method that may itself be used as an argument to VMM message macros. Using this feature resolves the issue of embedded messages. |
| vmm_data | enum value | STARTED | |
| vmm_data | int | stream_id | |
| svt_data | static function bit | strip_array_element_suffix ( vmm_log log, string prop_name, output string base_name, output int array_ix ) | Utility method which accepts a property name containing an array element index, and returns the base property name and the index value. |
| svt_data | protected string | suite_name = ""; | Identifies the product suite with which a derivative class is associated. Can be accessed through 'get_suite_name', but cannot be altered after object creation. |
| svt_data | function void | svt_post_do_all_do_byte_unpack ( ) | User extendable hook which is called at the end of the byte_unpack method, after the call to 'do_all'. Extended classes can implement this method to add a customized action at the end of the byte_unpack method. |
| svt_data | function void | svt_post_do_all_do_copy ( vmm_data to ) | User extendable hook which is called at the end of the copy method, after the call to 'do_all'. Extended classes can implement this method to add a customized action at the end of the copy method. |
| svt_data | function string | svt_shorthand_psdisplay ( string prefix ) | Uses the SVT pattern data to format the display generated by calling psdisplay. This routine is called automatically when the SVT shorthand macros are used and shoudl not be called by extended classes. |
| svt_data | function string | svt_shorthand_psdisplay_hook ( string prefix ) | User extendable hook which is called immediately after svt_shorthand_psdisplay. Extended classes can implement this method to add a customized display after the automated display. |
| svt_data | enum value | UNASSIGNED | |
| svt_data | function unsigned int | unpack_pattern_data ( svt_pattern_data pd, const ref logic [7:0] bytes[], input int unsigned offset ) | Unpack the information associated with a single pattern_data instance. |
| svt_debug_opts_carrier | function bit | update_save_prop_vals_to_fsdb ( string inst_name, string parent_object_uid = "", get_set_struct update_descupdate_desc = [$] ) | This method modifies the object with the provided updates and then writes the resulting property values associated with the data object to an FSDB file. This implementation is mainly here to intercept the request and pass it along or discard it, depending on whether debug opts are enabled. |
| svt_data | function void | vmm_opts_via_pattern ( ) | This method takes advantage of the set_prop_val method to implement the vmm_opts feature. The method uses the name and type values from the pattern to test whether a value corresponding to that property name has been supplied via vmm_opts. If a value has been supplied, then set_prop_val is used to set the value of the property. |
| vmm_data | static protected logic [7:0] | __vmm_bytes [] | |
| vmm_data | static protected bit | __vmm_done_user | |
| vmm_data | static protected string | __vmm_image | |
| vmm_data | static protected int | __vmm_kind | |
| vmm_data | static protected int | __vmm_len | |
| vmm_data | static protected bit [4095:0] | __vmm_maxbits | |
| vmm_data | static protected int | __vmm_offset | |
| vmm_data | static protected string | __vmm_prefix | |
| vmm_data | static protected bit | __vmm_status | |
| vmm_data | protected function void | copy_data ( vmm_data to ) | |
| vmm_data | function void | display ( string prefix = "" ) | |
| vmm_data | function vmm_data | do_allocate ( ) | |
| vmm_data | function unsigned int | do_byte_size ( int kind = -1 ) | |
| vmm_data | function unsigned int | do_max_byte_size ( int kind = -1 ) | |
| vmm_data | function unsigned int | max_byte_size ( int kind = -1 ) | |
| vmm_data | function vmm_log | set_log ( vmm_log log ) | |
| vmm_data | protected function unsigned int | __vmm_byte_size ( int kind = -1 ) | |
| vmm_data | function string | do_psdisplay ( string prefix = "" ) | |
| vmm_data | enum | notifications_e | |
| vmm_data | enum value | _DO_DUMMY | |
| vmm_data | typedef | do_how_e | |
| vmm_data | typedef | do_what_e | |
| vmm_data | typedef | notifications_e | |