SVT svt_traffic_profile_transaction Class Member List

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


 svt_transaction  enum value  ABORTED   
 svt_transaction  enum value  ACCEPT   
 svt_transaction  enum value  ACTIVE   
 svt_transaction  realtime  active_xml_start_time = -1; Local 'time' stores the current active start time of the object. This is used for backwards compatibility purposes. Should be removed when all clients remove the 'save_prop_vals_to_xml' implementation and move to 'save_object_begin' and 'save_object_data'. 
 svt_traffic_profile_transaction  rand svt_traffic_profile_transaction :: addr_val_type_enum  addr_gen_type Indicates the type of address generation If set to sequential, a sequential range of address value starting from base_addr will be used. If set to twomin, a two dimensional address pattern is used. Check description of properties below for details. If set to random, random values between base_addr and base_addr+addr_xrange-1 is used. Values will be chosen such that all the valid paths to slaves from this master are covered. 
 svt_traffic_profile_transaction  rand bit [63:0]   addr_twodim_stride Valid if addr is twodim. This determines the offset of each new row  
 svt_traffic_profile_transaction  rand bit [63:0]   addr_twodim_yrange Valid if addr is twodim. After a transaction uses address specified by (base_addr + addr_twodim_yrange - addr_twodim_stride + addr_twodim_xrange 1), the next transaction uses address specified by base_addr.  
 svt_traffic_profile_transaction  enum  addr_val_type_enum   
 svt_traffic_profile_transaction  typedef  addr_val_type_enum   
 svt_traffic_profile_transaction  rand bit [63:0]   addr_xrange = 1 << 64 - 1; Address range to be used for various address patterns. If addr is sequential, sequential addressing is used from base_addr until it reaches base_addr + addr_xrange - 1, upon which the next transaction will use base_addr as the address. If addr is twodim, after a transaction uses address specified by (base_addr + addr_xrange - 1), the next transaction uses address specified by (base_addr + addr_twodim_stride). This pattern continues until addr_twodim_yrange is reached. If addr is random, base_addr + addr_xrange 1 indicates the maximum address that can be generated  
 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_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_traffic_profile_transaction  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_transaction   function svt_data_converter  allocate_data_converter ( )  Method to allocate a new data converter. Extended classes with additional converter capabilities should overload this method to allocate an extended data converter supporting these additional capabilities. 
 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_traffic_profile_transaction   function svt_pattern  allocate_xml_pattern ( )  allocate_xml_pattern method collects all the fields which are primitive data fields of the transaction and filters the fields to get only the fields to be displayed in the PA.  
 svt_transaction   function void  apply_byte_to_crc ( bit [7:0] value, bit init = 0 )  This methods applies a byte to the CRC algorithm.  
 svt_traffic_profile_transaction  enum  attr_val_type_enum   
 svt_traffic_profile_transaction  typedef  attr_val_type_enum   
 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_traffic_profile_transaction  rand bit [63:0]   base_addr = 0; The base address to be used for address generation  
 svt_transaction   function bit  begin_is_off ( )  Utility method which identifies the 'off' state of the begin event independent of the underlying methodology. 
 svt_transaction   function bit  begin_is_on ( )  Utility method which identifies the 'on' state of the begin event independent of the underlying methodology. 
 svt_traffic_profile_transaction  virtual  function unsigned int  byte_pack ( ref logic [7:0] bytes[], input int unsigned offset, input int kind )   
 svt_traffic_profile_transaction   function unsigned int  byte_size ( int kind = -1 )  Returns the size (in bytes) required by the byte_pack operation.  
 svt_traffic_profile_transaction  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_transaction  enum value  CANCELLED   
 svt_transaction   function void  clear ( )  Clears the contents of the transaction so that it can safely be reused. 
 svt_transaction   function void  clear_implementation ( )  This method clears the implementation [$] transaction list, as well as any causal references which may have been setup. 
 svt_transaction   function void  clear_trace ( )  This method clears the trace [$] transaction list, as well as any original references which may have been setup. 
 svt_traffic_profile_transaction  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_traffic_profile_transaction  virtual  function vmm_data  copy ( vmm_data to = null )   
 svt_transaction   function void  copy_implementation ( vmm_data to, svt_data :: recursive_op_enum impl_trace_op = DEEP )  Copies the object implementation queue into to.  
 svt_transaction   function void  copy_trace ( vmm_data to, svt_data :: recursive_op_enum impl_trace_op = DEEP )  Copies the object trace queue into to.  
 svt_traffic_profile_transaction  enum value  CYCLE   
 svt_traffic_profile_transaction  rand svt_traffic_profile_transaction :: attr_val_type_enum  data_gen_type Indicates whether fixed, cycle or random data is to be used for transactions. If set to fixed, a fixed data value as indicated in data_min is used. If set to cycle, a range of data values is cycled through from data_min to data_max. If set to random, a random data value is used between data_min and data_max. 
 vmm_data  int  data_id  
 svt_traffic_profile_transaction  rand bit [1023:0]   data_max The upper bound of data value to be used. Valid if data is set to cycle 
 svt_traffic_profile_transaction  rand bit [1023:0]   data_min The lower bound of data value to be used. Valid if data is set to cycle 
 svt_transaction   function bit  decode_8b10b_data ( input bit [9:0] data_in, ref bit running_disparity, output bit data_k, output bit [7:0] data_out )  Decodes a ten bit data value into its eight bit representation. The function returns 0 and the output is unpredictable.  
 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_traffic_profile_transaction   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. Extended to support decoding of enum values.  
 svt_data  enum value  DEEP   
 svt_transaction  svt_transaction  default_implementation_xact_factory = null; Default factory used for creation of the implementation queue.  
 svt_transaction  enum value  DISABLED   
 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_traffic_profile_transaction   function void  do_all ( vmm_data :: do_what_e do_what, ref logic [7:0] pack[], const ref logic [7:0] unpack[] )   
 svt_traffic_profile_transaction   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. The svt_pattern_data :: name is set to the corresponding field name, the svt_pattern_data :: value is set to 0.  
 svt_traffic_profile_transaction   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_traffic_profile_transaction   function unsigned int  do_byte_unpack ( const ref logic [7:0] bytes[], input int unsigned offset, input int len, input int kind )  Unpacks the object from the bytes buffer, beginning at offset, based on the requested byte_unpack kind.  
 svt_traffic_profile_transaction   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.  
 svt_traffic_profile_transaction   function vmm_data  do_copy ( vmm_data to = null )  Extend the copy method to copy the transaction class fields.  
 svt_traffic_profile_transaction   function bit  do_is_valid ( bit silent = 1, int kind = RELEVANT )  Checks to see that the data field values are valid, focusing mainly on checking/enforcing valid_ranges constraint. Only supported kind values are -1 and svt_data :: COMPLETE. Both values result in the same check of the fields. 
 svt_transaction   function bit  enable_trace ( )  This virtual method is used to enable/disable the trace capability. The base class implementation always returns 0, indicating that this feature is disabled. Extended classes wishing to support this feature must consider whether this feature should always be enabled, be enabled for all instances of the extended class, or enabled on a per instance basis. This method, and any supporting data fields, etc., in the extended class should be implemented in accordance with these decisions. 
 svt_transaction   function bit  encode_8b10b_data ( input bit [7:0] data_in, input bit data_k, ref bit running_disparity, output bit [9:0] data_out )  Encodes an eight bit data value into its ten bit representation. The function returns 0 and the output is unpredictable if Xs and Zs are passed in via the argument.  
 svt_traffic_profile_transaction   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. Extended to support encoding of enum values.  
 svt_transaction   function bit  end_is_off ( )  Utility method which identifies the 'off' state of the end event independent of the underlying methodology. 
 svt_transaction   function bit  end_is_on ( )  Utility method which identifies the 'on' state of the end event independent of the underlying methodology. 
 svt_traffic_profile_transaction  enum value  END_OF_PROFILE   
 svt_transaction  real  end_time = 0; Time at which this transaction was ended  
 svt_transaction  static svt_data :: recursive_op_enum  exception_list_opts Used by all svt_transaction derived 'copy' and 'compare' methods to determine whether the exception list object is not copied or compared (NULL), the reference is copied and compared (SHALLOW), or whether the object is copied and compared (DEEP). Since not owned by an individual instance, not copied, compared, etc., like other svt_transaction properties. 
 svt_transaction  static  function svt_transaction  find_recycled_xact ( string class_name )  Static method to obtain a previously used transaction from recycled_xact [$] for reuse. Calls clear before returning the recycled transaction.  
 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_traffic_profile_transaction  enum value  FIXED   
 svt_traffic_profile_transaction  rand int  frame_size = SVT_TRAFFIC_MAX_FRAME_SIZE; Applicable if any of the output_event_type is FRAME_SIZE. Indicates the number of bytes after which the corresponding output_event must be triggered. The event is triggered after every frame_size number of bytes are transmitted.  
 svt_traffic_profile_transaction  enum value  FRAME_SIZE   
 svt_traffic_profile_transaction  rand int  frame_time = SVT_TRAFFIC_MAX_FRAME_TIME; Applicable if any of the output_event_type is FRAME_TIME. Indicates the number of cycles after which the corresponding output_event must be triggered. The event is triggered after every frame_time number of cycles 
 svt_traffic_profile_transaction  enum value  FRAME_TIME   
 svt_transaction   function realtime  get_accept_realtime ( )  Accessor method which returns the time at which the accept event was triggered as a realtime value. 
 svt_transaction   function svt_configuration  get_base_cfg ( )  Returns a reference of the transaction object. NOTE: This operation is used to fetch details to filter psdisplay_short display fields.  
 svt_transaction   function realtime  get_begin_realtime ( )  Accessor method which returns the time at which the begin event was triggered as a realtime value. 
 svt_transaction   function svt_transaction  get_causal_ref ( )  This method returns the causal_xact transaction reference. 
 svt_data   function string  get_class_name ( )  Returns the name of this class, or a class derived from this class.  
 svt_transaction   function void  get_clean_realtimes ( ref realtime start_time, ref realtime end_time )  Method provided to get clean real time values to support XML, FSDB and other output.  
 svt_transaction   function void  get_clean_times ( ref time start_time, ref time end_time )  Method provided to get clean time values to support XML, FSDB and other output. This method has been deprecated. Clients should override 'get_clean_realtimes' instead of 'get_clean_times'. 
 svt_transaction   function bit [31:0]   get_crc ( )  This method returns the calculated CRC value. 
 svt_transaction   function bit [31:0]   get_crc_initial_value ( )  Utility method for getting the CRC initial value.  
 svt_transaction   function bit [31:0]   get_crc_polynomial ( )  Utility method for getting the crc polynomial value.  
 svt_transaction   function svt_data_converter  get_data_converter ( )  Method to return the current data converter. Extended classes which provide data converter capabilities should overload this method to provide access to the current data converter, typically shared as a static member of the suite specific transaction object. 
 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_transaction   function realtime  get_end_realtime ( )  Accessor method which returns the time at which the end event was triggered as a realtime value. 
 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_transaction   function svt_transaction  get_implementation ( int ix )  Get the indexed transaction out of the implementation [$] property. 
 svt_transaction   function svt_transaction  get_implementation_xact_factory ( )  This virtual method must be replaced by transactions that make use of the implementation [$] property. Derived transactions must return a typed factory object which can be used when generating the transaction references in the implementation [$] transaction list. 
 svt_transaction   function bit  get_is_internal ( )  Method to get the is_internal value.  
 svt_traffic_profile_transaction   function string  get_mcd_class_name ( )  Returns the class name for the object used for logging. 
 svt_transaction   function svt_transaction  get_original_ref ( )  This method returns the original_xact transaction reference. 
 svt_transaction   function svt_pa_object_data  get_pa_obj_data ( string uid = "", string typ = "", string parent_uid = "", string channel = "" )  This method create/update the 'svt_pa_object_data' object data for use in the XML/FSDB which provides basic information about the object. The transaction extension adds begin and end time information to the object if provided by the base class.  
 svt_traffic_profile_transaction   function bit  get_prop_val ( string prop_name, ref bit [1023:0] prop_val, input int array_ix, ref svt_data data_obj )  HDL Support: For read access to public data members of this class. 
 svt_data   function bit  get_prop_val_via_pattern ( ref svt_pattern pttrn )  This method takes advantage of the get_prop_val method to make a simple way to extract a property pattern from a data instance. The method simply takes all of the names specified in pttrn, and uses get_prop_val to retrieve the corresponding value so it can be placed in the pattern.  
 svt_transaction   function svt_transaction  get_recycled_xact ( string class_name )  Method to obtain a previously used transaction from recycled_xact [$] for reuse. Calls clear before returning the recycled transaction.  
 svt_transaction   function time  get_safe_begin_time ( )  Method which filters out any begin time values of -1.  
 svt_transaction   function time  get_safe_end_time ( )  Method which filters out any end time values of -1.  
 svt_data   function string  get_suite_name ( )  Returns the suite name associated with an object.  
 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_transaction   function svt_transaction  get_trace ( int ix )  Get the indexed transaction out of the trace [$] property. 
 svt_transaction   function svt_transaction  get_trace_xact_factory ( )  This virtual method must be replaced by transactions that make use of the trace [$] property. Derived transactions must return a typed factory object which can be used when generating the transaction references in the trace [$] transaction list. 
 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_transaction   function bit  get_xact_status ( ref svt_transaction :: status_enum status )  Method provided to get the transaction status for inclusion in XML and other 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.  
 svt_traffic_profile_transaction  string  group_name The name of the group in the traffic profile corresponding to this configuration 
 svt_traffic_profile_transaction  int  group_seq_number The sequence number of the group in the traffic profile corresponding to this configuration 
 svt_transaction  svt_transaction  implementation [$] Reference to the lower level transactions that are created as a result of processing this transaction. This is assigned by calling the store_context method. 
 svt_transaction  enum value  INITIAL   
 svt_transaction   function void  initialize_8b10b ( bit force_load = 0 )  This method initializes the 8b10b lookup tables.  
 svt_transaction   function void  initialize_crc ( bit [31:0] poly, int width, bit [31:0] init, bit force_load = 0 )  This method initializes the CRC lookup table, saves the CRC width, and the initial CRC value.  
 svt_transaction   function void  initialize_scrambling ( )  This method initializes the scrambling seed. 
 svt_traffic_profile_transaction  string  input_events [] Name of input events based on which this traffic profile will will start. The traffic profile will start if any of the input events are triggered. The names given in this variable should be associated with the output event of some other profile, so that this traffic profile will start based on when the output event is triggered.  
 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_transaction   function bit  is_supported ( svt_configuration cfg, bit silent = 0 )  Determines if this transaction can reasonably be expected to function correctly on the supplied cfg object.  
 svt_traffic_profile_transaction  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 )   
 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_traffic_profile_transaction  string  output_events [] Name of output events triggered from this traffic profile at pre-defined points which are specified in output_event_type. The names given in this variable should be associated with the input event of some other profile, which will will start based on when the output event is triggered.  
 svt_traffic_profile_transaction  svt_traffic_profile_transaction :: output_event_type_enum  output_event_type[] Indicates the pre-defined points at which the output events given in output_event must be triggered If set to END_OF_PROFILE, the output event is triggered when the last transaction from the profile is complete If set to END_OF_FRAME_TIME, the output event is triggered every frame_time number of cycles If set to END_OF_FRAME_SIZE, the output event is triggered after every frame_size number of bytes are transmitted 
 svt_traffic_profile_transaction  enum  output_event_type_enum   
 svt_traffic_profile_transaction  typedef  output_event_type_enum   
 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_transaction  enum value  PARTIAL_ACCEPT   
 svt_transaction   function void  post_randomize ( )  Override post_randomize to implement the 'post' half of a pre_randomize/post_randomize handshake, designed to insure that pre_randomize and post_randomize are not blocked by extended classes. 
 svt_data   function int  power_of_2 ( int val )  This method returns the power of 2 of provided value.  
 svt_transaction   function void  pre_randomize ( )  Override pre_randomize to implement the 'pre' half of a pre_randomize/post_randomize handshake, designed to insure that pre_randomize and post_randomize are not blocked by extended classes. 
 svt_traffic_profile_transaction  string  profile_name Name of the profile  
 svt_transaction  static svt_data :: recursive_op_enum  protocol_xacts_opts Used by all svt_transaction derived 'copy' and 'compare' methods to determine whether the lower level protocol references are not copied or compared (NULL), the references are copied and compared (SHALLOW), or whether the objects are copied and compared (DEEP). Since not owned by an individual instance, not copied, compared, etc., like other svt_transaction properties. 
 svt_transaction   function string  psdisplay_concise ( )  Returns a concise string (32 characters or less) that gives a concise description of the data transaction. Can be used to represent the currently processed data transaction via a signal. 
 svt_transaction   function string  psdisplay_implementation ( string prefix = "", int max_impl_elem_display = -1 )  Displays the implementation list to a string. Each line of the generated output is preceded by prefix.  
 svt_transaction   function string  psdisplay_meta_info ( string prefix = "" )  Displays the meta information to a string. Each line of the generated output is preceded by prefix. Extends class flexibility in choosing what meta information should be displayed. 
 svt_transaction   function string  psdisplay_short ( string prefix = "", bit hdr_only = 0 )  Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet.  
 svt_transaction   function string  psdisplay_short_hdr_body ( string prefix = "" )  Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet. This method basically consists of two calls to psdisplay_short, with hdr_only = 1 and hdr_only = 0, to create the header and body information for the transaction.  
 svt_transaction   function string  psdisplay_short_via_pattern ( svt_pattern pttrn, string prefix = "", bit hdr_only = 0 )  Returns a string that reports the essential contents of the packet generally necessary to uniquely identify that packet.  
 svt_transaction   function string  psdisplay_trace ( string prefix = "", int max_trace_elem_display = -1 )  Displays the trace list to a string. Each line of the generated output is preceded by prefix.  
 svt_traffic_profile_transaction  enum value  RANDOM   
 svt_traffic_profile_transaction  enum value  RANDOM_ADDR   
 svt_traffic_profile_transaction  svt_fifo_rate_control_configuration  read_fifo_cfg Configuration for rate control in READ FIFO.  
 svt_traffic_profile_transaction  svt_fifo_rate_control  read_fifo_rate_control Utility class for performing FIFO based rate control for READ transactions  
 svt_traffic_profile_transaction  constraint  reasonable_data_val   
 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_transaction   function void  recycle_me ( )  Method to add this transaction to recycled_xact [$], which is a queue of recycled transactions. Transactions should only be recycled if the client is sure that the transaction is no longer in use. 
 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_transaction  enum value  RETRY   
 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_transaction   function bit  save_prop_vals_to_xml ( svt_xml_writer writer, string object_block_desc = "", string prefix = "" )  This method overides the super method to set the 'active_xml_start_time' to support backward compatibility and call the super class method to save the object properties.  
 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_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_transaction   function void  scramble ( input byte unsigned array_in[], ref bit [15:0] lfsr, output byte unsigned array_out[] )  Function is used for scrambling a byte of data. Following rules are followed while implementing this function: 1) The LFSR implements the polynomial: G(X)=X^16+X^5+X^4+X^3+1 2) All D-codes and K-codes are scrambled. 3) There is no resetting of the LFSR under any condition.  
 svt_traffic_profile_transaction  string  seqr_full_name Full Name of the sequencer instance on which this profile is to run This name must match the full hierarchical name of the sequencer 
 svt_traffic_profile_transaction  string  seqr_name Name of the sequencer on which this profile is to run This can be a proxy name and need not match the actual name of the sequencer 
 svt_traffic_profile_transaction  enum value  SEQUENTIAL   
 svt_transaction   function void  set_crc_initial_value ( bit [31:0] init )  Utility method for setting the CRC initial value.  
 svt_transaction   function void  set_crc_polynomial ( bit [31:0] poly )  Utility method for setting the CRC polynomial value.  
 svt_transaction   function void  set_data_converter ( svt_data_converter new_converter )  Method to set the current data converter. Extended classes which provide data converter capabilities should overload this method to store away the current data converter, typically shared as a static member of the suite specific transaction object. 
 svt_transaction   function void  set_is_internal ( bit is_internal = 1 )  Method to set the is_internal value.  
 svt_data   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 supported by a class derived from this class. This base class implementation always returns a value of '0' since the svt_data class has no 'object' properties.  
 svt_traffic_profile_transaction   function bit  set_prop_val ( string prop_name, bit [1023:0] prop_val, int array_ix )  HDL Support: For write access to public data members of this class. 
 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.  
 svt_transaction  real  start_time = 0; Time at which this transaction was started  
 svt_transaction  enum  status_enum  Used to indicate status for a transaction or for a data flow within a transaction. Transactions may be setup with a single status property, or they may have multiple properties corresponding to the different data flows supported by the transaction.  
 svt_transaction  typedef  status_enum   
 svt_transaction   function void  store_causal_ref ( svt_transaction causal )  This method updates this transaction's causal_xact reference to point to the causal transaction. 
 svt_transaction   function void  store_context ( svt_transaction implementation_xact )  This method first sets up the causal reference for the implementation_xact and then saves the implementation_xact in the implementation [$] transaction list. 
 svt_transaction   function void  store_original_ref ( svt_transaction original )  This method updates this transaction's original_xact reference to point to the original transaction. 
 svt_transaction   function void  store_trace ( svt_transaction trace_xact, bit copy = 1, svt_data :: recursive_op_enum copy_depth = SHALLOW )  This method is used to add trace_xact to the trace [$] transaction list associated with this transaction. It first sets up our transaction as the original_xact reference for the trace_xact transaction, and then saves the trace_xact transaction in the trace [$] transaction list.  
 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_transaction  realtime  svt_accept_realtime = 0; Time at which this transaction was accepted recorded as a realtime value  
 svt_transaction  realtime  svt_begin_realtime = 0; Time at which this transaction was started recorded as a realtime value  
 svt_transaction  realtime  svt_end_realtime = 0; Time at which this transaction was ended recorded as a realtime value  
 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_transaction   function void  svt_transaction_copy_hook ( vmm_data to = null )  Hook called by the VMM shorthand macro after performing the automated 'copy' routine.  
 svt_traffic_profile_transaction  rand int unsigned  total_num_bytes = SVT_TRAFFIC_MAX_TOTAL_NUM_BYTES; Number of Transactions in a sequence.  
 svt_transaction  svt_transaction  trace [$] Trace of any transactions of the same type that were created as a result of processing this transaction (e.g., due to retries, etc.). If enable_trace defined to return 0, then only contains 'last' traced transaction. If enable_trace defined to return 1, then contains all traced transactions. Elements are added to this list via calls to store_trace
 svt_traffic_profile_transaction  enum value  TWODIM   
 svt_data  enum value  UNASSIGNED   
 svt_traffic_profile_transaction  enum value  UNIQUE   
 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_transaction   function void  unscramble ( input byte unsigned array_in[], ref bit [15:0] lfsr, output byte unsigned array_out[] )  Function is used for unscrambling a byte of data. The function returns 0 and the output is unpredictable if Xs and Zs are passed in via the argument. Following rules are followed while implementing this function: 1) The LFSR implements the polynomial: G(X)=X^16+X^5+X^4+X^3+1 2) There is no resetting of the LFSR under any condition.  
 svt_traffic_profile_transaction  constraint  valid_ranges   
 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. 
 svt_transaction   task  wait_begin ( )  Utility method which can be used to wait for the beginning of this transaction independent of the underlying methodology. 
 svt_transaction   task  wait_end ( )  Utility method which can be used to wait for the end of this transaction independent of the underlying methodology. 
 svt_transaction   task  wait_end_last_implementation ( )  Utility method which can be used to wait for the end of the last transaction in the implementation queue. 
 svt_transaction   task  wait_for_causal_ref ( )  This method waits for the transaction's causal_xact reference to point to something other than null. 
 svt_transaction   task  wait_for_causal_ref_thru_time_unit ( int wait_time = 1 )  This method waits for the transaction's causal_xact reference to point to something other than null, but only for the indicated number of time units. It gives up if the value isn't updated within the specificied number of time units.  
 svt_traffic_profile_transaction  svt_fifo_rate_control_configuration  write_fifo_cfg Configuration for rate control in WRITE FIFO.  
 svt_traffic_profile_transaction  svt_fifo_rate_control  write_fifo_rate_control Utility class for performing FIFO based rate control for WRITE transactions  
 svt_traffic_profile_transaction  rand svt_traffic_profile_transaction :: xact_size_enum  xact_size The total number of bytes transferred in each transaction Applicable only for non-cache line size transactions. For cache-line size transactions, it is defined by the protocol and corresponding VIP constraints  
 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  
 svt_traffic_profile_transaction  static protected svt_traffic_profile_transaction  __vmm_rhs  
 svt_traffic_profile_transaction   function void  new ( vmm_log log = null, string suite_name = "" )  CONSTRUCTOR: Create a new traffic profile instance, passing the appropriate argument values to the vmm_data parent class.  
 svt_traffic_profile_transaction  virtual  function string  psdisplay ( string prefix = "" )   
 svt_traffic_profile_transaction   function int  reasonable_constraint_mode ( bit on_off )  Method to turn reasonable constraints on/off as a block. 
 svt_traffic_profile_transaction  enum value  XACT_SIZE_1024BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_128BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_16BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_256BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_32BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_512BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_64BIT   
 svt_traffic_profile_transaction  enum value  XACT_SIZE_8BIT   
 svt_traffic_profile_transaction  enum  xact_size_enum   
 svt_traffic_profile_transaction  typedef  xact_size_enum   
 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  enum value  DO_ALL   
 vmm_data   function vmm_data  do_allocate ( )   
 vmm_data   function unsigned int  do_byte_size ( int kind = -1 )   
 vmm_data  enum value  DO_COMPARE   
 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   
 vmm_data  typedef  do_how_e   
 vmm_data   function unsigned int  do_max_byte_size ( int kind = -1 )   
 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   function string  do_psdisplay ( string prefix = "" )   
 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   
 vmm_data  enum value  ENDED   
 vmm_data  enum value  EXECUTE   
 vmm_data  enum value  HOW_TO_COMPARE   
 vmm_data  enum value  HOW_TO_COPY   
 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  enum  notifications_e   
 vmm_data  enum value  STARTED   
 vmm_data  enum value  _DO_DUMMY   
 vmm_data  typedef  do_what_e   
 vmm_data  typedef  notifications_e