File: structOpenMS_1_1Internal_1_1ToolDescription.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (214 lines) | stat: -rw-r--r-- 17,874 bytes
<HTML>
<HEAD>
<TITLE>ToolDescription Struct Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="namespaceOpenMS_1_1Internal.html">Internal</a></li><li class="navelem"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structOpenMS_1_1Internal_1_1ToolDescription-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ToolDescription Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="ToolDescription_8h_source.html">OpenMS/DATASTRUCTURES/ToolDescription.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ToolDescription:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structOpenMS_1_1Internal_1_1ToolDescription.png" usemap="#ToolDescription_map" alt=""/>
  <map id="ToolDescription_map" name="ToolDescription_map">
<area href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html" title="ToolDescription Class. " alt="ToolDescriptionInternal" shape="rect" coords="0,0,142,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a815224568b6128a11eff5ac1b456bd0f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html#a815224568b6128a11eff5ac1b456bd0f">ToolDescription</a> ()</td></tr>
<tr class="separator:a815224568b6128a11eff5ac1b456bd0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0a909d819e9d218a2c607d01880cee0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html#ad0a909d819e9d218a2c607d01880cee0">ToolDescription</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;p_name, const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;p_category, const <a class="el" href="classOpenMS_1_1StringList.html">StringList</a> &amp;p_types=<a class="el" href="classOpenMS_1_1StringList.html">StringList</a>())</td></tr>
<tr class="separator:ad0a909d819e9d218a2c607d01880cee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc171675488671f3a0610ace36ec1d87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html#acc171675488671f3a0610ace36ec1d87">addExternalType</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;type, const <a class="el" href="structOpenMS_1_1Internal_1_1ToolExternalDetails.html">ToolExternalDetails</a> &amp;details)</td></tr>
<tr class="separator:acc171675488671f3a0610ace36ec1d87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac52f71e89ad0af682d33aef3bc6002fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html#ac52f71e89ad0af682d33aef3bc6002fe">append</a> (const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> &amp;other)</td></tr>
<tr class="separator:ac52f71e89ad0af682d33aef3bc6002fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae365797619c2c20e7ac1db6d99078f12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html#ae365797619c2c20e7ac1db6d99078f12">operator=</a> (const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> &amp;rhs)</td></tr>
<tr class="separator:ae365797619c2c20e7ac1db6d99078f12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html">ToolDescriptionInternal</a></td></tr>
<tr class="memitem:a6345aabfc4ac5e4a6dc475c80d5bedb2 inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a6345aabfc4ac5e4a6dc475c80d5bedb2">ToolDescriptionInternal</a> ()</td></tr>
<tr class="separator:a6345aabfc4ac5e4a6dc475c80d5bedb2 inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec43ea564bef4ae886a6bd104e75063a inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#aec43ea564bef4ae886a6bd104e75063a">ToolDescriptionInternal</a> (const bool p_is_internal, const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;p_name, const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;p_category, const <a class="el" href="classOpenMS_1_1StringList.html">StringList</a> &amp;p_types)</td></tr>
<tr class="separator:aec43ea564bef4ae886a6bd104e75063a inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb35b504be62eb09efdc9e4d64a46696 inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#abb35b504be62eb09efdc9e4d64a46696">ToolDescriptionInternal</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;p_name, const <a class="el" href="classOpenMS_1_1StringList.html">StringList</a> &amp;p_types)</td></tr>
<tr class="separator:abb35b504be62eb09efdc9e4d64a46696 inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02aaed04a6bca914d92776055e535359 inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html">ToolDescriptionInternal</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a02aaed04a6bca914d92776055e535359">operator=</a> (const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html">ToolDescriptionInternal</a> &amp;rhs)</td></tr>
<tr class="separator:a02aaed04a6bca914d92776055e535359 inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e75422fa97949d9d743cc6d0b78857c inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a8e75422fa97949d9d743cc6d0b78857c">operator==</a> (const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html">ToolDescriptionInternal</a> &amp;rhs) const </td></tr>
<tr class="separator:a8e75422fa97949d9d743cc6d0b78857c inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3389b48490c6e50c52f7d009b71277bb inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a3389b48490c6e50c52f7d009b71277bb">operator&lt;</a> (const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html">ToolDescriptionInternal</a> &amp;rhs) const </td></tr>
<tr class="separator:a3389b48490c6e50c52f7d009b71277bb inherit pub_methods_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aca9dfc295d1bb680c92d06d20051b2eb"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structOpenMS_1_1Internal_1_1ToolExternalDetails.html">ToolExternalDetails</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html#aca9dfc295d1bb680c92d06d20051b2eb">external_details</a></td></tr>
<tr class="separator:aca9dfc295d1bb680c92d06d20051b2eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html">ToolDescriptionInternal</a></td></tr>
<tr class="memitem:aab699e604962539cc9305c4e496032a5 inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#aab699e604962539cc9305c4e496032a5">is_internal</a></td></tr>
<tr class="separator:aab699e604962539cc9305c4e496032a5 inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a2326f35466e54c36c070829245c557 inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a9a2326f35466e54c36c070829245c557">name</a></td></tr>
<tr class="separator:a9a2326f35466e54c36c070829245c557 inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a536550816628993ec6969fd80fadf522 inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a536550816628993ec6969fd80fadf522">category</a></td></tr>
<tr class="separator:a536550816628993ec6969fd80fadf522 inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f3a6729bd30019e2b5169b6b8098f7e inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1StringList.html">StringList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescriptionInternal.html#a7f3a6729bd30019e2b5169b6b8098f7e">types</a></td></tr>
<tr class="separator:a7f3a6729bd30019e2b5169b6b8098f7e inherit pub_attribs_structOpenMS_1_1Internal_1_1ToolDescriptionInternal"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used for internal and external tools </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a815224568b6128a11eff5ac1b456bd0f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ad0a909d819e9d218a2c607d01880cee0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>p_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>p_category</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1StringList.html">StringList</a> &amp;&#160;</td>
          <td class="paramname"><em>p_types</em> = <code><a class="el" href="classOpenMS_1_1StringList.html">StringList</a>()</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acc171675488671f3a0610ace36ec1d87"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void addExternalType </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1Internal_1_1ToolExternalDetails.html">ToolExternalDetails</a> &amp;&#160;</td>
          <td class="paramname"><em>details</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ac52f71e89ad0af682d33aef3bc6002fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void append </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ae365797619c2c20e7ac1db6d99078f12"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a>&amp; operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structOpenMS_1_1Internal_1_1ToolDescription.html">ToolDescription</a> &amp;&#160;</td>
          <td class="paramname"><em>rhs</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aca9dfc295d1bb680c92d06d20051b2eb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt;<a class="el" href="structOpenMS_1_1Internal_1_1ToolExternalDetails.html">ToolExternalDetails</a>&gt; external_details</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:37 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>