svt_compound_pattern_data Class Reference

Inheritance diagram for class svt_compound_pattern_data:

List of all members.


Detailed Description

Data object for storing an set of name/value pairs.



Public Member Functions

function void  add_multiple_pattern_data ( svt_pattern_data pdq[$] )
function void  add_pattern_data ( svt_pattern_data pd )
function svt_pattern_data  copy ( svt_pattern_data to = null )
function void  delete_pattern_data ( svt_pattern_data pd = null )
function bit [1023:0]   get_any_array_val ( int array_ix )
function void  get_compound_contents ( ref svt_pattern_data compound_contents[$] )
function real  get_real_array_val ( int array_ix )
function realtime  get_realtime_array_val ( int array_ix )
function string  get_string_array_val ( int array_ix )
function void  new ( string name, bit [1023:0] value, int array_ix = 0, int positive_match = 1, svt_pattern_data :: type_enum typ = svt_pattern_data::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_array_val ( int array_ix, bit [1023:0] value )
function void  set_real_array_val ( int array_ix, real value )
function void  set_realtime_array_val ( int array_ix, realtime value )
function void  set_string_array_val ( int array_ix, string value )

Public Attributes

svt_pattern_data  compound_contents [$] 


Member Function Documentation

  function void
 svt_compound_pattern_data::add_multiple_pattern_data

 (  svt_pattern_data pdq [$]  ) 


Method to add multiple pattern data instances to the compound pattern data instance.

pdq - Queue of pattern data instances to be added.

  function void
 svt_compound_pattern_data::add_pattern_data

 (  svt_pattern_data pd  ) 


Method to add a pattern data instance to the compound pattern data instance.

pd - The pattern data instance to be added.

  function svt_pattern_data
 svt_compound_pattern_data::copy

 (  svt_pattern_data to = null  ) 


Copies this pattern data instance.

to - Optional copy destination.

Return values - The copy.


 Superseded functions 
 svt_pattern_data :: copy 
 Superseding functions 
 svt_object_pattern_data :: copy 

  function void
 svt_compound_pattern_data::delete_pattern_data

 (  svt_pattern_data pd = null  ) 


Method to delate a pattern data instance, or all pattern data instances, from the compound pattern data instance.

pd - The pattern data instance to be deleted. If null, deletes all pattern data instances.

  function bit [1023:0]
 svt_compound_pattern_data::get_any_array_val

 (  int array_ix  ) 


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

array_ix - Index into value array.

Return values - The bit vector value.

  function void
 svt_compound_pattern_data::get_compound_contents

 (  ref svt_pattern_data compound_contents [$]  ) 


Extensible method for getting the compound contents.

 Superseding functions 
 svt_object_pattern_data :: get_compound_contents 

  function real
 svt_compound_pattern_data::get_real_array_val

 (  int array_ix  ) 


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

array_ix - Index into value array.

Return values - The real value.

  function realtime
 svt_compound_pattern_data::get_realtime_array_val

 (  int array_ix  ) 


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

array_ix - Index into value array.

Return values - The realtime value.

  function string
 svt_compound_pattern_data::get_string_array_val

 (  int array_ix  ) 


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

array_ix - Index into value array.

Return values - The string value.

  function void
 svt_compound_pattern_data::new

 (  string name , bit [1023:0] value , int array_ix = 0, int positive_match = 1, svt_pattern_data :: type_enum typ = svt_pattern_data::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_compound_pattern_data class.

name - The pattern data name.

value - The pattern data value.

array_ix - Index into value when value is 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.


 Superseded functions 
 svt_pattern_data :: new 

  function string
 svt_compound_pattern_data::psdisplay

 (  string prefix = ""  ) 


Returns a simple string description of the pattern.

Return values - The simple string description.


 Superseded functions 
 svt_pattern_data :: psdisplay 
 Superseding functions 
 svt_object_pattern_data :: psdisplay 

  function void
 svt_compound_pattern_data::set_any_array_val

 (  int array_ix , 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.

array_ix - Index into value array.

value - The bit vector value.

  function void
 svt_compound_pattern_data::set_real_array_val

 (  int array_ix , real value  ) 


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

array_ix - Index into value array.

value - The real value.

  function void
 svt_compound_pattern_data::set_realtime_array_val

 (  int array_ix , realtime value  ) 


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

array_ix - Index into value array.

value - The realtime value.

  function void
 svt_compound_pattern_data::set_string_array_val

 (  int array_ix , string value  ) 


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

array_ix - Index into value array.

value - The string value.


Member Attribute Documentation

 svt_pattern_data  attribute
 svt_compound_pattern_data::compound_contents[$]


The compound set of pattern data.