| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.5) on Tue Jan 21 20:13:53 EST 2020 --> |
| <title>ETFWUtils (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="ETFWUtils (PTP API Specification)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/ETFWUtils.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.etfw</a></div> |
| <h2 title="Class ETFWUtils" class="title">Class ETFWUtils</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.ptp.etfw.ETFWUtils</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ETFWUtils</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utilities for accessing ETFW tools</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ETFWUtils</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>static java.util.ArrayList<<a href="AbstractToolDataManager.html" title="class in org.eclipse.ptp.etfw">AbstractToolDataManager</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerfConfManagers()">getPerfConfManagers</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Initializes the list of user defined performance data managers if necessary and returns the list.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="AbstractToolDataManager.html" title="class in org.eclipse.ptp.etfw">AbstractToolDataManager</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerfDataManager(java.lang.String)">getPerfDataManager</a></span>​(java.lang.String name)</code></th> |
| <td class="colLast"> |
| <div class="block">Given the name of a user defined performance data manager, returns the associatd AbstractToolDataManager object, or null if it is not found</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static java.util.ArrayList<<a href="ui/AbstractToolConfigurationTab.html" title="class in org.eclipse.ptp.etfw.ui">AbstractToolConfigurationTab</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPerfTabs()">getPerfTabs</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the list of user defined performance tool configuration tab objects.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="toolopts/ExternalToolProcess.html" title="class in org.eclipse.ptp.etfw.toolopts">ExternalToolProcess</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTool(int)">getTool</a></span>​(int dex)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the performance tool at index dex in the performance tools array</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="toolopts/ExternalToolProcess.html" title="class in org.eclipse.ptp.etfw.toolopts">ExternalToolProcess</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTool(java.lang.String)">getTool</a></span>​(java.lang.String toolName)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the performance tool with the given name from the performance tools array, or null if not found</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="toolopts/IToolUITab.html" title="interface in org.eclipse.ptp.etfw.toolopts">IToolUITab</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getToolPanes()">getToolPanes</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array of all of the non-virtual tool panes defined in available tool definition xml files |
| Panes are ordered by tool, and within each tool by compilation, execution and analysis step</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="toolopts/ExternalToolProcess.html" title="class in org.eclipse.ptp.etfw.toolopts">ExternalToolProcess</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTools()">getTools</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an array of the ETFw tool objects defined in plugins or loaded from xml by the user</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static java.util.ArrayList<<a href="toolopts/IToolUITab.html" title="interface in org.eclipse.ptp.etfw.toolopts">IToolUITab</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getToolUITabs()">getToolUITabs</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a list of the tool UI tab objects defined by available tool workflows.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#refreshTools(org.eclipse.jface.preference.IPreferenceStore)">refreshTools</a></span>​(org.eclipse.jface.preference.IPreferenceStore store)</code></th> |
| <td class="colLast"> |
| <div class="block">Reinitializes the performance tool data structures from the given XML definition file(s).</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ETFWUtils</h4> |
| <pre>public ETFWUtils()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getPerfConfManagers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerfConfManagers</h4> |
| <pre class="methodSignature">public static java.util.ArrayList<<a href="AbstractToolDataManager.html" title="class in org.eclipse.ptp.etfw">AbstractToolDataManager</a>> getPerfConfManagers()</pre> |
| <div class="block">Initializes the list of user defined performance data managers if necessary and returns the list.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPerfDataManager(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerfDataManager</h4> |
| <pre class="methodSignature">public static <a href="AbstractToolDataManager.html" title="class in org.eclipse.ptp.etfw">AbstractToolDataManager</a> getPerfDataManager​(java.lang.String name)</pre> |
| <div class="block">Given the name of a user defined performance data manager, returns the associatd AbstractToolDataManager object, or null if it is not found</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - of the performance data manager</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>selected performance data manager</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPerfTabs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPerfTabs</h4> |
| <pre class="methodSignature">public static java.util.ArrayList<<a href="ui/AbstractToolConfigurationTab.html" title="class in org.eclipse.ptp.etfw.ui">AbstractToolConfigurationTab</a>> getPerfTabs()</pre> |
| <div class="block">Returns the list of user defined performance tool configuration tab objects. Initializes the list first if necessary.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTool(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTool</h4> |
| <pre class="methodSignature">public static <a href="toolopts/ExternalToolProcess.html" title="class in org.eclipse.ptp.etfw.toolopts">ExternalToolProcess</a> getTool​(int dex)</pre> |
| <div class="block">Returns the performance tool at index dex in the performance tools array</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dex</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTool(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTool</h4> |
| <pre class="methodSignature">public static <a href="toolopts/ExternalToolProcess.html" title="class in org.eclipse.ptp.etfw.toolopts">ExternalToolProcess</a> getTool​(java.lang.String toolName)</pre> |
| <div class="block">Returns the performance tool with the given name from the performance tools array, or null if not found</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>toolName</code> - </dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getToolPanes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getToolPanes</h4> |
| <pre class="methodSignature">public static <a href="toolopts/IToolUITab.html" title="interface in org.eclipse.ptp.etfw.toolopts">IToolUITab</a>[] getToolPanes()</pre> |
| <div class="block">Returns an array of all of the non-virtual tool panes defined in available tool definition xml files |
| Panes are ordered by tool, and within each tool by compilation, execution and analysis step</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getTools()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTools</h4> |
| <pre class="methodSignature">public static <a href="toolopts/ExternalToolProcess.html" title="class in org.eclipse.ptp.etfw.toolopts">ExternalToolProcess</a>[] getTools()</pre> |
| <div class="block">Returns an array of the ETFw tool objects defined in plugins or loaded from xml by the user</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| </dl> |
| </li> |
| </ul> |
| <a id="getToolUITabs()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getToolUITabs</h4> |
| <pre class="methodSignature">public static java.util.ArrayList<<a href="toolopts/IToolUITab.html" title="interface in org.eclipse.ptp.etfw.toolopts">IToolUITab</a>> getToolUITabs()</pre> |
| <div class="block">Returns a list of the tool UI tab objects defined by available tool workflows. Initializes the list if necessary.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="refreshTools(org.eclipse.jface.preference.IPreferenceStore)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>refreshTools</h4> |
| <pre class="methodSignature">public static void refreshTools​(org.eclipse.jface.preference.IPreferenceStore store)</pre> |
| <div class="block">Reinitializes the performance tool data structures from the given XML definition file(s).</div> |
| </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/ETFWUtils.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
