ref/ruby/classes/Vpi/Handle.html in ruby-vpi-15.0.2 vs ref/ruby/classes/Vpi/Handle.html in ruby-vpi-16.0.0
- old
+ new
@@ -81,18 +81,16 @@
<div id="description">
<p>
An object inside a Verilog simulation (see <b>vpiHandle</b> in IEEE Std.
1364-2005).
</p>
-<ul>
-<li>VPI types and properties listed in ext/vpi_user.h can be specified by their
+<p>
+VPI types and properties listed in ext/vpi_user.h can be specified by their
names (strings or symbols) or integer constants.
-
+</p>
+<h1>Example names</h1>
<ul>
-<li>example names:
-
-<ul>
<li>"intVal"
</li>
<li>:intVal
@@ -108,13 +106,11 @@
</li>
<li>:VpiIntVal
</li>
</ul>
-</li>
-<li>example constants:
-
+<h1>Example constants</h1>
<ul>
<li>VpiIntVal
</li>
<li>VpiModule
@@ -122,37 +118,34 @@
</li>
<li>VpiReg
</li>
</ul>
-</li>
-</ul>
-</li>
-</ul>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000046">[]</a>
- <a href="#M000044">get_value</a>
- <a href="#M000043">get_value_wrapper</a>
- <a href="#M000047">inspect</a>
+ <a href="#M000045">[]</a>
+ <a href="#M000048">cbValueChange</a>
+ <a href="#M000043">get_value</a>
+ <a href="#M000042">get_value_wrapper</a>
+ <a href="#M000046">inspect</a>
<a href="#M000049">method_missing</a>
- <a href="#M000042">negedge?</a>
- <a href="#M000041">posedge?</a>
- <a href="#M000045">put_value</a>
- <a href="#M000048">to_s</a>
- <a href="#M000038">x!</a>
- <a href="#M000037">x?</a>
- <a href="#M000040">z!</a>
- <a href="#M000039">z?</a>
+ <a href="#M000041">negedge?</a>
+ <a href="#M000040">posedge?</a>
+ <a href="#M000044">put_value</a>
+ <a href="#M000047">to_s</a>
+ <a href="#M000037">x!</a>
+ <a href="#M000036">x?</a>
+ <a href="#M000039">z!</a>
+ <a href="#M000038">z?</a>
</div>
</div>
</div>
@@ -190,16 +183,16 @@
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000046" class="method-detail">
- <a name="M000046"></a>
+ <div id="method-M000045" class="method-detail">
+ <a name="M000045"></a>
<div class="method-heading">
- <a href="Handle.src/M000046.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000046.html');return false;">
+ <a href="Handle.src/M000045.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000045.html');return false;">
<span class="method-name">[]</span><span class="method-args">(*aTypes)</span>
</a>
</div>
<div class="method-description">
@@ -208,35 +201,53 @@
constant).
</p>
</div>
</div>
- <div id="method-M000044" class="method-detail">
- <a name="M000044"></a>
+ <div id="method-M000048" class="method-detail">
+ <a name="M000048"></a>
<div class="method-heading">
- <a href="Handle.src/M000044.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000044.html');return false;">
- <span class="method-name">get_value</span><span class="method-args">(aFormat = VpiObjTypeVal)</span>
+ <a href="Handle.src/M000048.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000048.html');return false;">
+ <span class="method-name">cbValueChange</span><span class="method-args">(aOptions = {})</span>
</a>
</div>
<div class="method-description">
<p>
-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.
+Registers a callback that is invoked whenever the value of this object
+changes.
</p>
</div>
</div>
<div id="method-M000043" class="method-detail">
<a name="M000043"></a>
<div class="method-heading">
<a href="Handle.src/M000043.html" target="Code" class="method-signature"
onclick="popupCode('Handle.src/M000043.html');return false;">
+ <span class="method-name">get_value</span><span class="method-args">(aFormat = VpiObjTypeVal)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+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.
+</p>
+ </div>
+ </div>
+
+ <div id="method-M000042" class="method-detail">
+ <a name="M000042"></a>
+
+ <div class="method-heading">
+ <a href="Handle.src/M000042.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000042.html');return false;">
<span class="method-name">get_value_wrapper</span><span class="method-args">(aFormat)</span>
</a>
</div>
<div class="method-description">
@@ -245,16 +256,16 @@
<tt><a href="S_vpi_value.html">S_vpi_value</a></tt> object.
</p>
</div>
</div>
- <div id="method-M000047" class="method-detail">
- <a name="M000047"></a>
+ <div id="method-M000046" class="method-detail">
+ <a name="M000046"></a>
<div class="method-heading">
- <a href="Handle.src/M000047.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000047.html');return false;">
+ <a href="Handle.src/M000046.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000046.html');return false;">
<span class="method-name">inspect</span><span class="method-args">(*aPropNames)</span>
</a>
</div>
<div class="method-description">
@@ -275,36 +286,26 @@
</a>
</div>
<div class="method-description">
<p>
-Provides access to this handle’s
+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 via <a
+href="Handle.html#M000043">get_value</a> and <a
+href="Handle.html#M000044">put_value</a>.
</p>
-<ol>
-<li>child handles
-
-</li>
-<li>VPI properties
-
-</li>
-</ol>
-<p>
-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 <a
-href="Handle.html#M000044">get_value</a> and <a
-href="Handle.html#M000045">put_value</a>.
-</p>
</div>
</div>
- <div id="method-M000042" class="method-detail">
- <a name="M000042"></a>
+ <div id="method-M000041" class="method-detail">
+ <a name="M000041"></a>
<div class="method-heading">
- <a href="Handle.src/M000042.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000042.html');return false;">
+ <a href="Handle.src/M000041.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000041.html');return false;">
<span class="method-name">negedge?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -312,16 +313,16 @@
Tests if the logic value of this handle is currently at a negative edge.
</p>
</div>
</div>
- <div id="method-M000041" class="method-detail">
- <a name="M000041"></a>
+ <div id="method-M000040" class="method-detail">
+ <a name="M000040"></a>
<div class="method-heading">
- <a href="Handle.src/M000041.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000041.html');return false;">
+ <a href="Handle.src/M000040.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000040.html');return false;">
<span class="method-name">posedge?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -329,16 +330,16 @@
Tests if the logic value of this handle is currently at a positive edge.
</p>
</div>
</div>
- <div id="method-M000045" class="method-detail">
- <a name="M000045"></a>
+ <div id="method-M000044" class="method-detail">
+ <a name="M000044"></a>
<div class="method-heading">
- <a href="Handle.src/M000045.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000045.html');return false;">
+ <a href="Handle.src/M000044.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000044.html');return false;">
<span class="method-name">put_value</span><span class="method-args">(aValue, aFormat = nil, aTime = nil, aDelay = VpiNoDelay)</span>
</a>
</div>
<div class="method-description">
@@ -349,30 +350,30 @@
format.
</p>
</div>
</div>
- <div id="method-M000048" class="method-detail">
- <a name="M000048"></a>
+ <div id="method-M000047" class="method-detail">
+ <a name="M000047"></a>
<div class="method-heading">
<span class="method-name">to_s</span><span class="method-args">(*aPropNames)</span>
</div>
<div class="method-description">
<p>
-Alias for <a href="Handle.html#M000047">inspect</a>
+Alias for <a href="Handle.html#M000046">inspect</a>
</p>
</div>
</div>
- <div id="method-M000038" class="method-detail">
- <a name="M000038"></a>
+ <div id="method-M000037" class="method-detail">
+ <a name="M000037"></a>
<div class="method-heading">
- <a href="Handle.src/M000038.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000038.html');return false;">
+ <a href="Handle.src/M000037.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000037.html');return false;">
<span class="method-name">x!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -380,16 +381,16 @@
Sets the logic value of this handle to unknown (x).
</p>
</div>
</div>
- <div id="method-M000037" class="method-detail">
- <a name="M000037"></a>
+ <div id="method-M000036" class="method-detail">
+ <a name="M000036"></a>
<div class="method-heading">
- <a href="Handle.src/M000037.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000037.html');return false;">
+ <a href="Handle.src/M000036.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000036.html');return false;">
<span class="method-name">x?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -397,16 +398,16 @@
Tests if the logic value of this handle is unknown (x).
</p>
</div>
</div>
- <div id="method-M000040" class="method-detail">
- <a name="M000040"></a>
+ <div id="method-M000039" class="method-detail">
+ <a name="M000039"></a>
<div class="method-heading">
- <a href="Handle.src/M000040.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000040.html');return false;">
+ <a href="Handle.src/M000039.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000039.html');return false;">
<span class="method-name">z!</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -414,15 +415,15 @@
Sets the logic value of this handle to high impedance (z).
</p>
</div>
</div>
- <div id="method-M000039" class="method-detail">
- <a name="M000039"></a>
+ <div id="method-M000038" class="method-detail">
+ <a name="M000038"></a>
<div class="method-heading">
- <a href="Handle.src/M000039.html" target="Code" class="method-signature"
- onclick="popupCode('Handle.src/M000039.html');return false;">
+ <a href="Handle.src/M000038.html" target="Code" class="method-signature"
+ onclick="popupCode('Handle.src/M000038.html');return false;">
<span class="method-name">z?</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
\ No newline at end of file