Class VPI::Handle
In: lib/ruby-vpi/core/callback.rb
lib/ruby-vpi/core/handle.rb
lib/ruby-vpi/core/edge.rb
ruby-vpi-dynamic.rb
Parent: Object

A handle is an object inside a Verilog simulation (see vpiHandle in IEEE Std. 1364-2005 for details).

Nearly all methods of this class, such as put_value() and get_value(), you allow you to specify VPI types and properties (which are listed in ext/vpi_user.h) by their names (strings or symbols) or integer constants.

For example, the vpiIntVal property can be specified as a string ("vpiIntVal"), a symbol (:vpiIntVal), or as an integer (VpiIntVal or VPI::vpiIntVal).

Methods

/   <=>   []   cbValueChange   change?   change_00?   change_01?   change_0f?   change_0h?   change_0l?   change_0t?   change_0x?   change_0z?   change_10?   change_11?   change_1f?   change_1h?   change_1l?   change_1t?   change_1x?   change_1z?   change_f0?   change_f1?   change_ff?   change_fh?   change_fl?   change_ft?   change_fx?   change_fz?   change_h0?   change_h1?   change_hf?   change_hh?   change_hl?   change_ht?   change_hx?   change_hz?   change_l0?   change_l1?   change_lf?   change_lh?   change_ll?   change_lt?   change_lx?   change_lz?   change_t0?   change_t1?   change_tf?   change_th?   change_tl?   change_tt?   change_tx?   change_tz?   change_x0?   change_x1?   change_xf?   change_xh?   change_xl?   change_xt?   change_xx?   change_xz?   change_z0?   change_z1?   change_zf?   change_zh?   change_zl?   change_zt?   change_zx?   change_zz?   edge?   f!   f?   force?   force_value   get_value   get_value_wrapper   h!   h?   inspect   l!   l?   method_missing   put_value   release_value   t!   t?   to_a   to_s   vpi0!   vpi0?   vpi1!   vpi1?   vpiH!   vpiH?   vpiL!   vpiL?   vpiX!   vpiX?   vpiZ!   vpiZ?   x!   x?   z!   z?  

Included Modules

VPI

External Aliases

change_01? -> posedge?
change_10? -> negedge?

Public Instance methods

/(aRelativePath)

Returns the child handle at the given relative VPI path.

<=>(other)

Sort by absolute VPI path.

[](aProp)

Returns the value of the given VPI property (name or integer constant) of this handle.

cbValueChange(aOptions = {})

Registers a callback that is invoked whenever the value of this object changes.

change?()

Tests if the logic value of this handle has changed since the last simulation time step.

change_00?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi0 (in the current time step).

change_01?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi1 (in the current time step).

change_0f?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi0 (in the current time step).

change_0h?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiH (in the current time step).

change_0l?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiL (in the current time step).

change_0t?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi1 (in the current time step).

change_0x?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiX (in the current time step).

change_0z?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiZ (in the current time step).

change_10?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi0 (in the current time step).

change_11?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi1 (in the current time step).

change_1f?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi0 (in the current time step).

change_1h?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiH (in the current time step).

change_1l?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiL (in the current time step).

change_1t?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi1 (in the current time step).

change_1x?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiX (in the current time step).

change_1z?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiZ (in the current time step).

change_f0?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi0 (in the current time step).

change_f1?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi1 (in the current time step).

change_ff?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi0 (in the current time step).

change_fh?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiH (in the current time step).

change_fl?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiL (in the current time step).

change_ft?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to Vpi1 (in the current time step).

change_fx?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiX (in the current time step).

change_fz?()

Tests if the logic value of this handle has changed from Vpi0 (in the previous time step) to VpiZ (in the current time step).

change_h0?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to Vpi0 (in the current time step).

change_h1?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to Vpi1 (in the current time step).

change_hf?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to Vpi0 (in the current time step).

change_hh?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to VpiH (in the current time step).

change_hl?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to VpiL (in the current time step).

change_ht?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to Vpi1 (in the current time step).

change_hx?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to VpiX (in the current time step).

change_hz?()

Tests if the logic value of this handle has changed from VpiH (in the previous time step) to VpiZ (in the current time step).

change_l0?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to Vpi0 (in the current time step).

change_l1?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to Vpi1 (in the current time step).

change_lf?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to Vpi0 (in the current time step).

change_lh?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to VpiH (in the current time step).

change_ll?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to VpiL (in the current time step).

change_lt?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to Vpi1 (in the current time step).

change_lx?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to VpiX (in the current time step).

change_lz?()

Tests if the logic value of this handle has changed from VpiL (in the previous time step) to VpiZ (in the current time step).

change_t0?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi0 (in the current time step).

change_t1?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi1 (in the current time step).

change_tf?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi0 (in the current time step).

change_th?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiH (in the current time step).

change_tl?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiL (in the current time step).

change_tt?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to Vpi1 (in the current time step).

change_tx?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiX (in the current time step).

change_tz?()

Tests if the logic value of this handle has changed from Vpi1 (in the previous time step) to VpiZ (in the current time step).

change_x0?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to Vpi0 (in the current time step).

change_x1?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to Vpi1 (in the current time step).

change_xf?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to Vpi0 (in the current time step).

change_xh?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to VpiH (in the current time step).

change_xl?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to VpiL (in the current time step).

change_xt?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to Vpi1 (in the current time step).

change_xx?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to VpiX (in the current time step).

change_xz?()

Tests if the logic value of this handle has changed from VpiX (in the previous time step) to VpiZ (in the current time step).

change_z0?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to Vpi0 (in the current time step).

change_z1?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to Vpi1 (in the current time step).

change_zf?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to Vpi0 (in the current time step).

change_zh?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to VpiH (in the current time step).

change_zl?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to VpiL (in the current time step).

change_zt?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to Vpi1 (in the current time step).

change_zx?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to VpiX (in the current time step).

change_zz?()

Tests if the logic value of this handle has changed from VpiZ (in the previous time step) to VpiZ (in the current time step).

edge?()

Tests if either a positive or negative edge has occurred.

f!()

Alias for vpi0!

f?()

Alias for vpi0?

force?()

Tests if there is currently a value forced onto this handle.

force_value(*args)

Forces the given value (see arguments for put_value) onto this handle.

get_value(aFormat = VpiIntVal)

Reads the value using the given format (name or integer constant) and returns it. If a format is not given, then it is assumed to be VpiIntVal.

get_value_wrapper(aFormat)

Reads the value using the given format (name or integer constant) and returns a S_vpi_value object.

h!()

Alias for vpiH!

h?()

Alias for vpiH?

inspect(*aPropNames)

Inspects the given VPI property names, in addition to those common to all handles.

l!()

Alias for vpiL!

l?()

Alias for vpiL?

method_missing(aMeth, *aArgs, &aBlock)

Provides access to this handle‘s (1) child handles and (2) VPI properties through method calls. In the case that a child handle has the same name as a VPI property, the child handle will be accessed instead of the VPI property. However, you can still access the VPI property using the square brackets #[] method.

put_value(aValue, aFormat = nil, aTime = nil, aDelay = VpiNoDelay)

Writes the given value using the given format (name or integer constant), time, and delay, and then returns the written value.

  • If you do not specify the format, then the Verilog simulator will attempt to determine the correct format.
release_value()

Releases all forced values on this handle (if any).

t!()

Alias for vpi1!

t?()

Alias for vpi1?

to_a(*aChildTypes)

Returns an array of child handles which have the given types (names or integer constants).

to_s(*aPropNames)

Alias for inspect

vpi0!()

Sets the integer value of this handle to 0.

vpi0?()

Tests if the integer value of this handle is 0.

vpi1!()

Sets the integer value of this handle to 1.

vpi1?()

Tests if the integer value of this handle is 1.

vpiH!()

Sets the strength value of this handle to high.

vpiH?()

Tests if the strength value of this handle is high.

vpiL!()

Sets the strength value of this handle to low.

vpiL?()

Tests if the strength value of this handle is low.

vpiX!()

Sets the logic value of this handle to unknown (x).

vpiX?()

Tests if the logic value of this handle is unknown (x).

vpiZ!()

Sets the logic value of this handle to high impedance (z).

vpiZ?()

Tests if the logic value of this handle is high impedance (z).

x!()

Alias for vpiX!

x?()

Alias for vpiX?

z!()

Alias for vpiZ!

z?()

Alias for vpiZ?

[Validate]