svt_agent Class Reference

Inheritance diagram for class svt_agent:

List of all members.


Detailed Description

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



Public Member Functions

function void  build ( )
function void  connect ( )
function void  display_checked_out_features ( )
function void  get_cfg ( ref svt_configuration cfg )
function string  get_suite_name ( )
function void  new ( string name = "", ovm_component parent = null, string suite_name = "" )
function void  reconfigure ( svt_configuration cfg )
function void  report ( )
task   run ( )
function void  svt_check_and_load_verbosity ( )

Public Attributes

svt_err_check  err_check = null; 
svt_event_pool  event_pool 
int  intermediate_report = 1; 
ovm_active_passive_enum  is_active 
ovm_report_object  reporter = this; 

Protected Member Functions

function void  change_dynamic_cfg ( svt_configuration cfg )
function void  change_static_cfg ( svt_configuration cfg )
virtual function void  get_dynamic_cfg ( ref svt_configuration cfg )
virtual function bit  get_is_running ( )
virtual function void  get_static_cfg ( ref svt_configuration cfg )
function bit  is_valid_cfg_type ( svt_configuration cfg )

Protected Attributes

protected bit  is_running 


Member Function Documentation

  function void
 svt_agent::build

 (   ) 


Build phase

 Superseded functions 
 ovm_component :: build 

 protected function void
 svt_agent::change_dynamic_cfg

 (  svt_configuration cfg  ) 


Copies (deep) the dynamic configuration properties from the argument into the configuration object stored in the agent. Used internally by reconfigure; not to be called directly.

 protected function void
 svt_agent::change_static_cfg

 (  svt_configuration cfg  ) 


Copies (deep) the static configuration properties from the argument into the configuration object stored in the agent. Used internally by reconfigure; not to be called directly.

  function void
 svt_agent::connect

 (   ) 


Connect phase

 Superseded functions 
 ovm_component :: connect 

  function void
 svt_agent::display_checked_out_features

 (   ) 


Displays the license features that were used to authorize this suite

  function void
 svt_agent::get_cfg

 (  ref svt_configuration cfg  ) 


Returns a copy of the agent's configuration object, including the current configuration settings. If cfg is null, creates configuration object of appropriate type.

 protected virtual function void
 svt_agent::get_dynamic_cfg

 (  ref svt_configuration cfg  ) 


Copies (deep) the dynamic configuration properties from the configuration object stored in the agent into the argument. If cfg is null, creates configuration object of appropriate type. Used internally by get_cfg; not to be called directly.

 protected virtual function bit
 svt_agent::get_is_running

 (   ) 


Used to identify whether the agent has been started. Based on whether the transactors in the agent have been started.

Return values - 1 indicates that the agent has been started, 0 indicates it has not.

 protected virtual function void
 svt_agent::get_static_cfg

 (  ref svt_configuration cfg  ) 


Copies (deep) the static configuration properties from the configuration object stored in the agent into the argument. If cfg is null, creates config object of appropriate type. Used internally by get_cfg; not to be called directly.

  function string
 svt_agent::get_suite_name

 (   ) 


Returns the model suite name associated with an object.

 protected function bit
 svt_agent::is_valid_cfg_type

 (  svt_configuration cfg  ) 


Expected to return a 1 if the supplied configuration object is of the correct type for the agent. Extended classes implementing specific agents will provide an extended version of this method and call it directly.

  function void
 svt_agent::new

 (  string name = "", ovm_component parent = null, string suite_name = ""  ) 


CONSTRUCTOR: Create a new agent instance, passing the appropriate argument values to the `SVT_XVM(agent) parent class.

name - Name assigned to this agent.

parent - Component which contains this agent

suite_name - Identifies the product suite to which the agent object belongs.

  function void
 svt_agent::reconfigure

 (  svt_configuration cfg  ) 


Updates the agent configuration with data from the supplied object. This method always results in a call to reconfigure for the transactors.

  function void
 svt_agent::report

 (   ) 


Report phase: If final report (i.e., intermediate_report = 0) this method calls svt_err_check :: report on the err_check object.

 Superseded functions 
 ovm_component :: report 

  task
 svt_agent::run

 (   ) 


Run phase

 Superseded tasks 
 ovm_component :: run 

  function void
 svt_agent::svt_check_and_load_verbosity

 (   ) 


Check and load verbosity

Member Attribute Documentation

 svt_err_check  attribute
 svt_agent::err_check = null


DUT Error Check infrastructure object shared by the components of the agent.

 svt_event_pool  attribute
 svt_agent::event_pool


Event pool associated with this agent

 int  attribute
 svt_agent::intermediate_report = 1


Determines if a transaction summary should be generated in the report task.

 ovm_active_passive_enum  attribute
 svt_agent::is_active = OVM_ACTIVE

 protected bit  attribute
 svt_agent::is_running


Flag that indicates the driver has entered the run phase.

 ovm_report_object  attribute
 svt_agent::reporter = this


SVT message macros route messages through this reference