<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: Vpi</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">Vpi</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/ruby-vpi/vpi_rb.html">
lib/ruby-vpi/vpi.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000030">advance_time</a>
<a href="#M000031">simulation_time</a>
<a href="#M000029">vpi_register_cb</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Class <a href="Vpi/Handle.html" class="link">Vpi::Handle</a><br />
Class <a href="Vpi/S_vpi_time.html" class="link">Vpi::S_vpi_time</a><br />
Class <a href="Vpi/S_vpi_value.html" class="link">Vpi::S_vpi_value</a><br />
</div>
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">INTEGER_BITS</td>
<td>=</td>
<td class="context-item-value">32</td>
<td width="3em"> </td>
<td class="context-item-desc">
Number of bits in PLI_INT32.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">INTEGER_LIMIT</td>
<td>=</td>
<td class="context-item-value">2 ** INTEGER_BITS</td>
<td width="3em"> </td>
<td class="context-item-desc">
Lowest upper bound of PLI_INT32.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">INTEGER_MASK</td>
<td>=</td>
<td class="context-item-value">INTEGER_LIMIT - 1</td>
<td width="3em"> </td>
<td class="context-item-desc">
Bit-mask capable of capturing PLI_INT32.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">Handle</td>
<td>=</td>
<td class="context-item-value">SWIG::TYPE_p_unsigned_int</td>
<td width="3em"> </td>
<td class="context-item-desc">
handles
</td>
</tr>
</table>
</div>
</div>
<div id="aliases-list">
<h3 class="section-bar">External Aliases</h3>
<div class="name-list">
<table summary="aliases">
<tr class="top-aligned-row context-row">
<td class="context-item-name">vpi_register_cb</td>
<td>-></td>
<td class="context-item-value">vpi_register_cb_old</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">vpi_remove_cb</td>
<td>-></td>
<td class="context-item-value">vpi_remove_cb_old</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">initialize</td>
<td>-></td>
<td class="context-item-value">old_initialize</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000030" class="method-detail">
<a name="M000030"></a>
<div class="method-heading">
<a href="Vpi.src/M000030.html" target="Code" class="method-signature"
onclick="popupCode('Vpi.src/M000030.html');return false;">
<span class="method-name">advance_time</span><span class="method-args">(aNumSteps = 1)</span>
</a>
</div>
<div class="method-description">
<p>
Advances the simulation by the given number of steps.
</p>
</div>
</div>
<div id="method-M000031" class="method-detail">
<a name="M000031"></a>
<div class="method-heading">
<a href="Vpi.src/M000031.html" target="Code" class="method-signature"
onclick="popupCode('Vpi.src/M000031.html');return false;">
<span class="method-name">simulation_time</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns the current simulation time as an integer.
</p>
</div>
</div>
<div id="method-M000029" class="method-detail">
<a name="M000029"></a>
<div class="method-heading">
<a href="Vpi.src/M000029.html" target="Code" class="method-signature"
onclick="popupCode('Vpi.src/M000029.html');return false;">
<span class="method-name">vpi_register_cb</span><span class="method-args">(aData {|Vpi::S_cb_data| ...}</span>
</a>
</div>
<div class="method-description">
<p>
This is a Ruby version of the <a
href="Vpi.html#M000029">vpi_register_cb</a> C function. It is identical to
the C function, except for the following differences:
</p>
<ul>
<li>This method accepts a block (callback handler) which is executed whenever
the callback occurs.
</li>
<li>This method overwrites the <tt>cb_rtn</tt> and <tt>user_data</tt> fields of
the given <tt>S_cb_data</tt> object.
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>