svt_sequence_library Class Reference

Inheritance diagram for class svt_sequence_library:

List of all members.


Detailed Description

Class that provides the basic infrastructure common to all SVT sequences.



Public Member Functions

function string  get_suite_name ( )
function void  new ( string name = "svt_sequence_library", string suite_name = "" )
function unsigned int  populate_library ( svt_configuration cfg )
function unsigned int  select_sequence ( int unsigned max )

Class Parameters

type  REQ = ovm_sequence_item
type  RSP 

Public Attributes

int unsigned  select_sequence_counter = 0; 

Protected Attributes

protected string  suite_name = ""; 


Member Function Documentation

  function string
 svt_sequence_library::get_suite_name

 (   ) 


Returns the model suite name associated with an object.

  function void
 svt_sequence_library::new

 (  string name = "svt_sequence_library", string suite_name = ""  ) 


CONSTRUCTOR: Create a new SVT sequence library object

  function unsigned int
 svt_sequence_library::populate_library

 (  svt_configuration cfg  ) 


Populates the library with all of the desired sequences. This method registers all applicable sequences to an instance of this class. Expectation is to call this method after creating an instance of this library.

Base class currently implemented to generate an error and return '0'. The implication of this is that extended classes must implement the method and must not call the base class.

cfg - The configuration to validate against.

Return values - Returns the number of sequences added to the library.

  function unsigned int
 svt_sequence_library::select_sequence

 (  int unsigned max  ) 


Generates an index used to select the next sequence to execute. Overrides must return a value between 0 and max, inclusive. Used only for UVM_SEQ_LIB_USER selection mode. The default implementation returns 0, incrementing on successive calls, wrapping back to 0 when reaching max.

max - The maximum index value to select, typically the number of sequences registered with the library 1.

Return values - The selected index value.


 Superseded functions 
 svt_ovm_sequence_library :: select_sequence 


Class Parameters Documentation

 type  attribute
 svt_sequence_library::REQ = ovm_sequence_item

 type  attribute
 svt_sequence_library::RSP


Member Attribute Documentation

 int unsigned  attribute
 svt_sequence_library::select_sequence_counter = 0


Counter used internally to the select_sequence method.

 protected string  attribute
 svt_sequence_library::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.