idv_timer_sim_ovm Class Reference

Simulation Countdown Timer for OVM. More...

Inheritance diagram for idv_timer_sim_ovm:
Inheritance graph
[legend]
Collaboration diagram for idv_timer_sim_ovm:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 new (realtime countdown_time, ovm_component component, string name, bit autostart=0, string file_name="", int file_line=0)
 Constructor.
virtual void alarm ()
 Alarm.
virtual void fatal_error (string msg="")
 Fatal Error.
virtual void note (string msg="")
 Note.

Public Attributes

ovm_component m_component_h
 Component Handle.
string m_file_name
 File Name of file that contains this timer instance.
int m_file_line
 Line number of file where this timer is instantiated.

Detailed Description

Simulation Countdown Timer for OVM.

This class is a simulation countdown timer with OVM logging.

Definition at line 55 of file idv_timer_sim_ovm.sv.


Member Function Documentation

virtual void idv_timer_sim_ovm::alarm (  )  [virtual]

Alarm.

Defines what happens when the countdown time expires.

Returns:
void

Reimplemented from idv_timer_sim.

Definition at line 94 of file idv_timer_sim_ovm.sv.

virtual void idv_timer_sim_ovm::fatal_error ( string  msg = ""  )  [virtual]

Fatal Error.

Defines what happens when a fatal error occurs in the base class (this class).

Returns:
void

Reimplemented from idv_timer_sim.

Definition at line 104 of file idv_timer_sim_ovm.sv.

idv_timer_sim_ovm::new ( realtime  countdown_time,
ovm_component  component,
string  name,
bit  autostart = 0,
string  file_name = "",
int  file_line = 0 
)

Constructor.

Class Constructor

Usage:
At construction pass: time value for countdown, handle to 'this' component (component that is instantiating this timer), name of this timer, autostart enable/disable, file name macro, file line macro

  idv_timer_sim_ovm m_timer;
  ...
  m_timer = new(5ns, this, "Timer Name, 0, `ovm_file, `ovm_line);
Parameters:
countdown_time realtime - Time to countdown from
component ovm_component - OVM Component that contains this timer instance
name string - Name of this timer instance
autostart bit - Start timer on construction (defaults to off)
file_name string - Name of the file that contains this timer instance
file_line int - Line number of the file that contains this timer instance

Definition at line 81 of file idv_timer_sim_ovm.sv.

virtual void idv_timer_sim_ovm::note ( string  msg = ""  )  [virtual]

Note.

Defines what happens when a Note Display occurs in the base class (this class).

Returns:
void

Reimplemented from idv_timer_sim.

Definition at line 114 of file idv_timer_sim_ovm.sv.


Member Data Documentation

Component Handle.

Definition at line 58 of file idv_timer_sim_ovm.sv.

Line number of file where this timer is instantiated.

Definition at line 60 of file idv_timer_sim_ovm.sv.

File Name of file that contains this timer instance.

Definition at line 59 of file idv_timer_sim_ovm.sv.


The documentation for this class was generated from the following file:

Intelligent Design Verification
Intelligent Design Verification
Project: Timers, Revision: 1.3.1
Copyright (c) 2008-2010 Intelligent Design Verification.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included here:
http://www.intelligentdv.com/licenses/fdl.txt
doxygen
Doxygen Version: 1.6.3
IDV SV Filter Version: 2.6.3
Sat Jun 19 12:13:51 2010
Find a documentation bug? Report bugs to: bugs.intelligentdv.com Project: DoxygenFilterSV