svt_event_pool Class Reference

Inheritance diagram for class svt_event_pool:

List of all members.


Detailed Description

Base class for a shared event pool resource. This is used in the design of the Verilog CMD interface. This may also be used in layered protocols where timing information between the protocol layers needs to be communicated.



Public Member Functions

function void  add ( string key, ovm_event item )
function void  add_ev ( string key, ovm_event item, bit is_on_off = 0, int skip_file = 0 )
static function bit  get_event_is_off ( ovm_object_string_pool ev_pool, string ev_name )
static function bit  get_event_is_on ( ovm_object_string_pool ev_pool, string ev_name )
static function ovm_object  get_event_trigger_data ( ovm_object_string_pool ev_pool, string ev_name )
function void  log_to_logger ( int log_file_id, bit events_described, svt_logger logger )
function void  mcd_skip_next ( string key, int log_file_id )
function void  new ( string name = "svt_event_pool", string suite_name = "", ovm_report_object reporter = null )
static function void  reset_event ( ovm_object_string_pool ev_pool, string ev_name )
static function void  trigger_event ( ovm_object_string_pool ev_pool, string ev_name, ovm_object data = null )
static task   wait_event_off ( ovm_object_string_pool ev_pool, string ev_name )
static task   wait_event_on ( ovm_object_string_pool ev_pool, string ev_name )
static task   wait_event_trigger ( ovm_object_string_pool ev_pool, string ev_name )

Public Attributes

ovm_report_object  reporter 


Member Function Documentation

  function void
 svt_event_pool::add

 (  string key , ovm_event item  ) 


Add a check to ensure that this method is not called directly (use add_ev instead);

  function void
 svt_event_pool::add_ev

 (  string key , ovm_event item , bit is_on_off = 0, int skip_file = 0  ) 


Method used to add and event to the pool and to set up logging information. This method should be used instead of the `SVT_XVM(pool)::add method.

key - string ID for this event

item - Event object that is stored in the pool

is_on_off - Flag that allows logging to record the event correctly

skip_file - Causes logging to be disabled for this event

 static function bit
 svt_event_pool::get_event_is_off

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to get the 'is_off' state for an event.

 static function bit
 svt_event_pool::get_event_is_on

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to get the 'is_on' state for an event.

 static function ovm_object
 svt_event_pool::get_event_trigger_data

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to get the event triger_data.

  function void
 svt_event_pool::log_to_logger

 (  int log_file_id , bit events_described , svt_logger logger  ) 


Internal method used to log events.

  function void
 svt_event_pool::mcd_skip_next

 (  string key , int log_file_id  ) 


Internal method used to log events.

  function void
 svt_event_pool::new

 (  string name = "svt_event_pool", string suite_name = "", ovm_report_object reporter = null  ) 


CONSTRUCTOR: Creates a new instance of the svt_event_pool class, passing the appropriate argument values to the `SVT_XVM(event_pool) parent class.

name - Instance name

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

 static function void
 svt_event_pool::reset_event

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to reset an event.

 static function void
 svt_event_pool::trigger_event

 (  ovm_object_string_pool ev_pool , string ev_name , ovm_object data = null  ) 


Static utility method that makes it easy to trigger an event.

 static task
 svt_event_pool::wait_event_off

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to wait for an event to be 'off'.

 static task
 svt_event_pool::wait_event_on

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to wait for an event to be 'on'.

 static task
 svt_event_pool::wait_event_trigger

 (  ovm_object_string_pool ev_pool , string ev_name  ) 


Static utility method that makes it easy to wait for an event.

Member Attribute Documentation

 ovm_report_object  attribute
 svt_event_pool::reporter


SVT message macros route messages through this reference