svt_notify Class Reference

Inheritance diagram for class svt_notify:

List of all members.


Detailed Description

Base class for a shared notification service that may be needed by some protocol suites. An example of where this may be used would be in a layered protocol, where timing information between the protocol layers needs to be communicated.



Public Member Functions

function int  configure_named_notify ( string name, int notification_id = -1, vmm_notify :: sync_e sync = ONE_SHOT, int skip_file = 0 )
function int  get_notification_id ( string name )
function string  get_notification_name ( int notification_id )
function void  log_to_logger ( int log_file_id, bit notifications_described, svt_logger logger )
function void  mcd_skip_next ( int notification_id, int log_file_id )
function void  new ( vmm_log log, string suite_name )

Public Attributes


Member Function Documentation

  function int
 svt_notify::configure_named_notify

 (  string name , int notification_id = -1, vmm_notify :: sync_e sync = ONE_SHOT, int skip_file = 0  ) 


Method used to configure a notification and to establish a string identifier which can be used to obtain the numeric identifier for the notification.

  function int
 svt_notify::get_notification_id

 (  string name  ) 


Gets the notification Id associated with the indicated name, as specified via a previous call to configure_named_notify.

name - Name associated with the notification.

Return values - Notification ID which can be used to access the named notification.

  function string
 svt_notify::get_notification_name

 (  int notification_id  ) 


Gets the name associated with the indicated notification ID, as specified via a previous call to configure_named_notify.

notification_id - ID associated with the notification.

Return values - Notification name which has been specified.

  function void
 svt_notify::log_to_logger

 (  int log_file_id , bit notifications_described , svt_logger logger  ) 


Internal method used to log notifications.

  function void
 svt_notify::mcd_skip_next

 (  int notification_id , int log_file_id  ) 


Internal method used to log notifications.

  function void
 svt_notify::new

 (  vmm_log log , string suite_name  ) 


CONSTRUCTOR: Creates a new instance of the svt_notify class, passing the appropriate argument values to the vmm_notify parent class.

log - An vmm_log object reference used to replace the default internal logger. The class extension that calls super.new should pass a reference to its own static log instance.

suite_name - A String that identifies the product suite to which the transaction object belongs.


Member Attribute Documentation