| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.5) on Tue Jan 21 20:13:53 EST 2020 --> |
| <title>IPDIStackFrame (PTP API Specification)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <meta name="dc.created" content="2020-01-21"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IPDIStackFrame (PTP API Specification)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IPDIStackFrame.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>PTP</b><br>Release 7.0</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ptp.debug.core.pdi.model</a></div> |
| <h2 title="Interface IPDIStackFrame" class="title">Interface IPDIStackFrame</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../IPDISessionObject.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISessionObject</a></code>, <code><a href="../IPDISet.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISet</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IPDIStackFrame</span> |
| extends <a href="../IPDISessionObject.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISessionObject</a></pre> |
| <div class="block">A stack frame in a suspended thread. |
| A stack frame contains variables representing visible locals and arguments at the current execution location.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="IPDIArgument.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIArgument</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createArgument(org.eclipse.ptp.debug.core.pdi.model.IPDIArgumentDescriptor)">createArgument</a></span>​(<a href="IPDIArgumentDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIArgumentDescriptor</a> varDesc)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a variable from the descriptor for evaluation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="IPDILocalVariable.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDILocalVariable</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createLocalVariable(org.eclipse.ptp.debug.core.pdi.model.IPDILocalVariableDescriptor)">createLocalVariable</a></span>​(<a href="IPDILocalVariableDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDILocalVariableDescriptor</a> varDesc)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a variable from the descriptor for evaluation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(org.eclipse.ptp.debug.core.pdi.model.IPDIStackFrame)">equals</a></span>​(<a href="IPDIStackFrame.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIStackFrame</a> stackframe)</code></th> |
| <td class="colLast"> |
| <div class="block">Determines whether both stackframes are the same</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="IPDIArgumentDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIArgumentDescriptor</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArgumentDescriptors()">getArgumentDescriptors</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the arguments in this stack frame.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLevel()">getLevel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the level of the stack frame, 1 based.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="IPDILocalVariableDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDILocalVariableDescriptor</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocalVariableDescriptors()">getLocalVariableDescriptors</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the visible variables in this stack frame.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../IPDILocator.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDILocator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLocator()">getLocator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the location of the instruction pointer in this stack frame.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="IPDITarget.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDITarget</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTarget()">getTarget</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the target this stackframe is contained in.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="IPDIThread.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIThread</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThread()">getThread</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the thread this stackframe is contained in.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.ptp.debug.core.pdi.IPDISessionObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.ptp.debug.core.pdi.<a href="../IPDISessionObject.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISessionObject</a></h3> |
| <code><a href="../IPDISessionObject.html#getSession()">getSession</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.ptp.debug.core.pdi.IPDISet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.eclipse.ptp.debug.core.pdi.<a href="../IPDISet.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDISet</a></h3> |
| <code><a href="../IPDISet.html#getTasks()">getTasks</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getLocator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocator</h4> |
| <pre class="methodSignature"><a href="../IPDILocator.html" title="interface in org.eclipse.ptp.debug.core.pdi">IPDILocator</a> getLocator()</pre> |
| <div class="block">Returns the location of the instruction pointer in this stack frame.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the location of the instruction pointer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLocalVariableDescriptors()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocalVariableDescriptors</h4> |
| <pre class="methodSignature"><a href="IPDILocalVariableDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDILocalVariableDescriptor</a>[] getLocalVariableDescriptors() |
| throws <a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></pre> |
| <div class="block">Returns the visible variables in this stack frame. An empty collection is returned if there are no visible variables.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a collection of visible variables</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></code> - on failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createArgument(org.eclipse.ptp.debug.core.pdi.model.IPDIArgumentDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createArgument</h4> |
| <pre class="methodSignature"><a href="IPDIArgument.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIArgument</a> createArgument​(<a href="IPDIArgumentDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIArgumentDescriptor</a> varDesc) |
| throws <a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></pre> |
| <div class="block">Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and |
| ChangedEvent will also be trigger when the variable is assign a new value. |
| DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>varDesc</code> - IPDIArgumentDescriptor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>argument</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></code> - on failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createLocalVariable(org.eclipse.ptp.debug.core.pdi.model.IPDILocalVariableDescriptor)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createLocalVariable</h4> |
| <pre class="methodSignature"><a href="IPDILocalVariable.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDILocalVariable</a> createLocalVariable​(<a href="IPDILocalVariableDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDILocalVariableDescriptor</a> varDesc) |
| throws <a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></pre> |
| <div class="block">Create a variable from the descriptor for evaluation. A CreatedEvent will be trigger and |
| ChangedEvent will also be trigger when the variable is assign a new value. |
| DestroyedEvent is fired when the variable is out of scope and automatically removed from the manager list.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>varDesc</code> - IPDILocalVariableDescriptor</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>local variable</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></code> - on failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getArgumentDescriptors()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArgumentDescriptors</h4> |
| <pre class="methodSignature"><a href="IPDIArgumentDescriptor.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIArgumentDescriptor</a>[] getArgumentDescriptors() |
| throws <a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></pre> |
| <div class="block">Returns the arguments in this stack frame. An empty collection is returned if there are no arguments.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a collection of arguments</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../PDIException.html" title="class in org.eclipse.ptp.debug.core.pdi">PDIException</a></code> - on failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getThread()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThread</h4> |
| <pre class="methodSignature"><a href="IPDIThread.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIThread</a> getThread()</pre> |
| <div class="block">Returns the thread this stackframe is contained in.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the thread</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTarget()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTarget</h4> |
| <pre class="methodSignature"><a href="IPDITarget.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDITarget</a> getTarget()</pre> |
| <div class="block">Returns the target this stackframe is contained in.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the target</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getLevel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLevel</h4> |
| <pre class="methodSignature">int getLevel()</pre> |
| <div class="block">Returns the level of the stack frame, 1 based.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the level of the stack frame</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="equals(org.eclipse.ptp.debug.core.pdi.model.IPDIStackFrame)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">boolean equals​(<a href="IPDIStackFrame.html" title="interface in org.eclipse.ptp.debug.core.pdi.model">IPDIStackFrame</a> stackframe)</pre> |
| <div class="block">Determines whether both stackframes are the same</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stackframe</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the frames are the same.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IPDIStackFrame.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>PTP</b><br>Release 7.0</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
