svt_pattern_data Class Reference

Inheritance diagram for class svt_pattern_data:

List of all members.

Detailed Description

Data object that stores an individual name/value pair.


Public Member Functions

function void  add_supp_data ( string name, bit [1023:0] value, svt_pattern_data :: type_enum typ = svt_pattern_data::UNDEF )
function void  add_supp_string ( string name, string value )
function svt_pattern_data  copy ( svt_pattern_data to = null )
function bit [1023:0]   get_any_val ( )
function real  get_real_val ( )
function realtime  get_realtime_val ( )
function string  get_string_val ( )
function bit  get_supp_data_value ( string name, ref bit [1023:0] value )
function bit  get_supp_string ( string name, ref string value )
function time  get_time_val ( )
function bit  has_keyword ( string keyword )
function bit  match ( bit [1023:0] match_value, bit is_found_value )
function void  new ( string name, bit [1023:0] value, int array_ix = 0, int positive_match = 1, svt_pattern_data :: type_enum typ = UNDEF, string owner = "", svt_pattern_data :: display_control_enum display_control = REL_DISP, svt_pattern_data :: how_enum display_how = REF, svt_pattern_data :: how_enum ownership_how = DEEP )
function string  psdisplay ( string prefix = "" )
function void  set_any_val ( bit [1023:0] value )
function void  set_real_val ( real value )
function void  set_realtime_val ( realtime value )
function void  set_string_val ( string value )

Public Attributes

svt_pattern_data :: align_enum  alignment 
int  array_ix 
svt_pattern_data :: display_control_enum  display_control 
svt_pattern_data :: how_enum  display_how 
string  enum_type = ""; 
int unsigned  field_width = 0; 
string  keywords [$] 
string  name 
string  owner 
svt_pattern_data :: how_enum  ownership_how 
bit  positive_match = 1; 
int unsigned  supported_methods_flag = 0; 
svt_pattern_data  supp_data [$] 
string  title 
svt_pattern_data :: type_enum  typ 
bit [1023:0]   value 
int  width 

Member Typedefs

 typedef enum  align_enum 
 typedef struct  create_struct 
 typedef enum  display_control_enum 
 typedef struct  get_set_struct 
 typedef enum  how_enum 
 typedef enum  type_enum 

Member Function Documentation

  function void
 svt_pattern_data::add_supp_data
 (  string name , bit [1023:0] value , svt_pattern_data :: type_enum typ = svt_pattern_data::UNDEF  ) 

Utility method for adding simple supplemental data.

name - Name portion of the new name/value pair.

value - Value portion of the new name/value pair.

typ - Type portion of the new name/value pair.

  function void
 svt_pattern_data::add_supp_string
 (  string name , string value  ) 

Utility method for adding string supplemental data to an individual property.

name - Name portion of the new name/value pair.

value - Supplemental string value.

  function svt_pattern_data
 svt_pattern_data::copy
 (  svt_pattern_data to = null  ) 

Copies this pattern data instance.

to - Optional copy destination.

Return values - The copy.

 Superseding functions 
 svt_compound_pattern_data :: copy 
 svt_object_pattern_data :: copy 

  function bit [1023:0]
 svt_pattern_data::get_any_val
 (   ) 

Utility method for returning value as a bit vector. Valid for fields which are not of type OBJECT or GRAPHIC.

Return values - The bit vector value.

  function real
 svt_pattern_data::get_real_val
 (   ) 

Utility method for returning value as a real. Only valid if the field is of type REAL.

Return values - The real value.

  function realtime
 svt_pattern_data::get_realtime_val
 (   ) 

Utility method for returning value as a realtime. Only valid if the field is of type REALTIME.

Return values - The real value.

  function string
 svt_pattern_data::get_string_val
 (   ) 

Utility method for returning value as a string. Only valid if the field is of type STRING.

Return values - The string value.

  function bit
 svt_pattern_data::get_supp_data_value
 (  string name , ref bit [1023:0] value  ) 

Utility method for accessing supplemental data.

name - Name of the supplemental data whose value is to be retrieved.

value - Retrieved value.

Return values - Indicates whether the named supplemental data was found (1) or not found (0). This also indicates whether the 'value' is valid.

  function bit
 svt_pattern_data::get_supp_string
 (  string name , ref string value  ) 

Utility method for accessing supplemental data as a string. Only valid if the supplemental data is of type STRING.

name - Name of the supplemental data whose value is to be retrieved.

value - Retrieved string value.

Return values - Indicates whether named supplemental data of type string was found (1) or not (0).

  function time
 svt_pattern_data::get_time_val
 (   ) 

Utility method for returning value as a time. Only valid if the field is of type TIME.

Return values - The real value.

  function bit
 svt_pattern_data::has_keyword
 (  string keyword  ) 

Method to look for a specific keyword in the keyword list.

keyword - The keyword to look for.

Return values - Indication of whether the keyword was found (1) or not (0).

  function bit
 svt_pattern_data::match
 (  bit [1023:0] match_value , bit is_found_value  ) 

Method to do the value match, taking into account positive_match.

match_value - The value that should be matched against.

is_found_value - Indicates whether the match_value is real, representing a found value, or if the field could not be found. If is_found_value == 0, then the success of the match relies entirely on whether we are doing a positive or negative match. In this situation a positive match will always return 0, a negative match will always return 1. If is_found_value == 1, then the success of the match relies entirely on whether the match_value compares with this.value.

Return values - Indication of whether the value match passed (1) or failed (0).

  function void
 svt_pattern_data::new
 (  string name , bit [1023:0] value , int array_ix = 0, int positive_match = 1, svt_pattern_data :: type_enum typ = UNDEF, string owner = "", svt_pattern_data :: display_control_enum display_control = REL_DISP, svt_pattern_data :: how_enum display_how = REF, svt_pattern_data :: how_enum ownership_how = DEEP  ) 

CONSTRUCTOR: Creates a new instance of the svt_pattern_data class.

name - The pattern data name.

value - The pattern data value.

array_ix - Index associated with the value when the value is in an array.

positive_match - Indicates whether match (positive_match == 1) or mismatch (positive_match == 0) is desired.

typ - Type portion of the new name/value pair.

owner - Class name where the property is defined

display_control - Controls whether the property should be displayed in all RELEVANT display situations, or if it should only be displayed in COMPLETE display situations.

display_how - Controls whether this pattern is displayed, and if so whether it should be displayed via reference or deep display.

ownership_how - Indicates what type of relationship exists between this object and the containing object, and therefore how the various operations should function relative to this contained object.

 Superseding functions 
 svt_compound_pattern_data :: new 

  function string
 svt_pattern_data::psdisplay
 (  string prefix = ""  ) 

Returns a simple string description of the pattern.

Return values - The simple string description.

 Superseding functions 
 svt_compound_pattern_data :: psdisplay 
 svt_object_pattern_data :: psdisplay 

  function void
 svt_pattern_data::set_any_val
 (  bit [1023:0] value  ) 

Utility method for setting a field value using a bit vector. Only valid if the fields which are not of type OBJECT or GRAPHIC.

value - The bit vector value.

  function void
 svt_pattern_data::set_real_val
 (  real value  ) 

Utility method for setting a real field value. Only valid if the field is of type REAL.

value - The real value.

  function void
 svt_pattern_data::set_realtime_val
 (  realtime value  ) 

Utility method for setting a real field value. Only valid if the field is of type REALTIME.

value - The real value.

  function void
 svt_pattern_data::set_string_val
 (  string value  ) 

Utility method for setting a string field value. Only valid if the field is of type STRING.

value - The string value.

Member Attribute Documentation

 svt_pattern_data :: align_enum  attribute
 svt_pattern_data::alignment

Alignment used in short display.

 int  attribute
 svt_pattern_data::array_ix

The pattern array_ix.

 svt_pattern_data :: display_control_enum  attribute
 svt_pattern_data::display_control

Display control

 svt_pattern_data :: how_enum  attribute
 svt_pattern_data::display_how

Display depth

 string  attribute
 svt_pattern_data::enum_type = ""

Type string which can be used in enumerated operrations. Empty string indicates "not set".

 int unsigned  attribute
 svt_pattern_data::field_width = 0

Field bit width used by common data class operations. 0 indicates "not set".

 string  attribute
 svt_pattern_data::keywords[$]

Additional situational keywords

 string  attribute
 svt_pattern_data::name

The pattern data name.

 string  attribute
 svt_pattern_data::owner

Class name where the property is defined

 svt_pattern_data :: how_enum  attribute
 svt_pattern_data::ownership_how

Object access depth

 bit  attribute
 svt_pattern_data::positive_match = 1

Indicates whether the name/value pairs should be the same as (positive_match = 1) or different from (positive_match = 0) the actual svt_data values when the pattern match occurs.

 int unsigned  attribute
 svt_pattern_data::supported_methods_flag = 0

Flag indicating which common data class operations are to be supported automatically for this field. 0 indicates "not set".

 svt_pattern_data  attribute
 svt_pattern_data::supp_data[$]

Supplemental data about this pattern_data instance, potentially situational.

 string  attribute
 svt_pattern_data::title

Title used in short display.

 svt_pattern_data :: type_enum  attribute
 svt_pattern_data::typ

Property type

 bit [1023:0]   attribute
 svt_pattern_data::value

The pattern data value.

 int  attribute
 svt_pattern_data::width

Width used in short display.

Member Typedef Documentation

 typedef enum  svt_pattern_data::align_enum
Types of alignment during display
LEFT
Left aligned
RIGHT
Right aligned
CENTER
Center aligned

 typedef struct  svt_pattern_data::create_struct
string name
svt_pattern_data :: type_enum typ

 typedef enum  svt_pattern_data::display_control_enum
Display control used by the automated SVT shorthand display routines to recognize whether an individual field should be displayed as part of the current request.
REL_DISP
Indicates field display for RELEVANT and COMPLETE display requests
COMP_DISP
Indicates field display solely for COMPLETE display requests

 typedef struct  svt_pattern_data::get_set_struct
string name
bit [1023:0] value

 typedef enum  svt_pattern_data::how_enum
Depth used for the SVT shorthand routines
NONE
Never work with the object reference (e.g., Never display it)
REF
Only work with the object reference (e.g., Only display whether the object is null or not)
DEEP
Work with the entire object (e.g., Perform a deep display) or the evaluated (e.g., based on accessing the calculated 'get__val' value) value

 typedef enum  svt_pattern_data::type_enum
Property type lables used when building the pattern data structure.
UNDEF
Unknown or undefined data type
BIT
Data corresponds to a bit value
BITVEC
Data corresponds to a bit vector value
INT
Data corresponds to an int value
REAL
Data corresponds to a real value
REALTIME
Data corresponds to a realtime value
TIME
Data corresponds to a time value
STRING
Data corresponds to a string value
ENUM
Data corresponds to an enum value
OBJECT
Data corresponds to an object
GRAPHIC
Data corresponds to an graphic element, used for display

08 August 2024, Copyright © 2024 Synopsys, Inc.