Class Vpi::Handle
In: lib/ruby-vpi/vpi.rb
Parent: Object

An object inside a Verilog simulation (see vpiHandle in IEEE Std. 1364-2005).

  • VPI types and properties listed in ext/vpi_user.h can be specified by their names (strings or symbols) or integer constants.
    • example names:
      • "intVal"
      • :intVal
      • "vpiIntVal"
      • :vpiIntVal
      • "VpiIntVal"
      • :VpiIntVal
    • example constants:
      • VpiIntVal
      • VpiModule
      • VpiReg

Methods

[]   get_value   get_value_wrapper   inspect   method_missing   negedge?   posedge?   put_value   to_s   x!   x?   z!   z?  

Included Modules

Vpi

Constants

Property = Struct.new :type, :name, :operation, :accessor, :assignment

Public Instance methods

[](*aTypes)

Returns an array of child handles of the given types (name or integer constant).

get_value(aFormat = VpiObjTypeVal)

Reads the value using the given format (name or integer constant) and returns it. If a format is not given, then the Verilog simulator will attempt to determine the correct format.

get_value_wrapper(aFormat)

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

inspect(*aPropNames)

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

method_missing(aMeth, *aArgs, &aBlockArg)

Provides access to this handle’s

  1. child handles
  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 via get_value and put_value.

negedge?()

Tests if the logic value of this handle is currently at a negative edge.

posedge?()

Tests if the logic value of this handle is currently at a positive edge.

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 given value. If a format is not given, then the Verilog simulator will attempt to determine the correct format.

to_s(*aPropNames)

Alias for inspect

x!()

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

x?()

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

z!()

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

z?()

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

[Validate]