svt_xactor_callback Class Reference

Inheritance diagram for class svt_xactor_callback:

List of all members.


Detailed Description

Provides a layer of insulation between the vmm_xactor_callbacks class and the callback facade classes used by SVT models. All callbacks in SVT model components should be extended from this class.

At this time, this class does not add any additional functionality to vmm_xactor_callbacks, but it is anticipated that in the future new functionality (e.g. support for record/playback) will be added.



Public Member Functions

function string  get_name ( )
function void  inform_notify ( svt_xactor xactor, string name, svt_notify notify )
function void  new ( string suite_name = "", string name = "svt_callback" )
function void  report_cov ( svt_xactor xactor, string prefix, int kind, ref bit met_goals, ref string report )
function void  start ( svt_xactor xactor )
function void  stop ( svt_xactor xactor )

Protected Attributes

protected svt_xactor  xactor = null; 


Member Function Documentation

  function string
 svt_xactor_callback::get_name

 (   ) 


Method implemented to provide access to the callback type name.

Return values - The type name for the callback class.

  function void
 svt_xactor_callback::inform_notify

 (  svt_xactor xactor , string name , svt_notify notify  ) 


Provides access to an svt_notify instance, or in the case of the vmm_xactor notify field, the handle to the transactor. In the latter case the transactor can be used to access the associated vmm_notify instance stored in notify. The extended class can use this method to setup a reliance on the notify instance.

xactor - A reference to the transactor object issuing this callback.

name - Name identifying the svt_notify if provide, or identifying the transactor if the inform_notify is being issued for the 'notify' field on the transactor.

notify - The svt_notify instance that is being provided for use. This field is set to null if the inform_notify is being issued for the 'notify' field on the transactor.

  function void
 svt_xactor_callback::new

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


CONSTRUCTOR: Create a new transactor callback instance, passing the appropriate argument values to the vmm_xactor_callbacks parent class.

suite_name - Identifies the product suite to which the xactor callback object belongs.

name - Identifies the callback instance.

  function void
 svt_xactor_callback::report_cov

 (  svt_xactor xactor , string prefix , int kind , ref bit met_goals , ref string report  ) 


Callback issued by transactor to pull together current functional coverage information.

xactor - A reference to the transactor object issuing this callback.

prefix - Prefix that should be included in each line of the returned 'report' string.

kind - The kind of report being requested. -1 reserved for 'generic' report.

met_goals - Indicates status relative to current coverage goals.

report - Short textual report describing coverage status.

  function void
 svt_xactor_callback::start

 (  svt_xactor xactor  ) 


Callback issued by transactor to allow callbacks to initiate activities. This callback is issued during svt_xactor :: main so that any processes initiated by this callback will be torn down if svt_xactor :: reset_xactor is called. This method sets the svt_xactor_callback :: xactor data member.

xactor - A reference to the transactor object issuing this callback.

  function void
 svt_xactor_callback::stop

 (  svt_xactor xactor  ) 


Callback issued by transactor to allow callbacks to suspend activities.

xactor - A reference to the transactor object issuing this callback.


Member Attribute Documentation

 protected svt_xactor  attribute
 svt_xactor_callback::xactor = null


A pointer to the transactor with which this class is associated, only valid once 'start' has been called.