diff options
Diffstat (limited to 'tclap-1.2.1/docs/html/classTCLAP_1_1ArgException.html')
| -rw-r--r-- | tclap-1.2.1/docs/html/classTCLAP_1_1ArgException.html | 237 |
1 files changed, 237 insertions, 0 deletions
diff --git a/tclap-1.2.1/docs/html/classTCLAP_1_1ArgException.html b/tclap-1.2.1/docs/html/classTCLAP_1_1ArgException.html new file mode 100644 index 0000000..f857cff --- /dev/null +++ b/tclap-1.2.1/docs/html/classTCLAP_1_1ArgException.html @@ -0,0 +1,237 @@ +<!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"> +<head> +<meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/> +<title>tclap: TCLAP::ArgException Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<!-- Generated by Doxygen 1.6.0 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> + <div class="navpath"><a class="el" href="namespaceTCLAP.html">TCLAP</a>::<a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a> + </div> +</div> +<div class="contents"> +<h1>TCLAP::ArgException Class Reference</h1><!-- doxytag: class="TCLAP::ArgException" --> +<p>A simple class that defines and argument exception. +<a href="#_details">More...</a></p> + +<p><code>#include <<a class="el" href="ArgException_8h_source.html">ArgException.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for TCLAP::ArgException:</div> +<div class="dynsection"> + <div class="center"> + <img src="classTCLAP_1_1ArgException.gif" usemap="#TCLAP::ArgException_map" alt=""/> + <map id="TCLAP::ArgException_map" name="TCLAP::ArgException_map"> +<area href="classTCLAP_1_1ArgParseException.html" alt="TCLAP::ArgParseException" shape="rect" coords="0,56,195,80"/> +<area href="classTCLAP_1_1CmdLineParseException.html" alt="TCLAP::CmdLineParseException" shape="rect" coords="205,56,400,80"/> +<area href="classTCLAP_1_1SpecificationException.html" alt="TCLAP::SpecificationException" shape="rect" coords="410,56,605,80"/> +</map> + </div> +</div> + +<p><a href="classTCLAP_1_1ArgException-members.html">List of all members.</a></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a67389912b628e95d530f8bb8de97b309">ArgException</a> (const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic <a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a>")</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a67389912b628e95d530f8bb8de97b309"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a5c5df6a814b05c623a01607fb82980f4">~ArgException</a> () throw ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a5c5df6a814b05c623a01607fb82980f4"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a0656dab88a7129bc288821bacd653d08">error</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the error text. <a href="#a0656dab88a7129bc288821bacd653d08"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#a18ffd1ad34c1799865f8e03df4ebdff1">argId</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the argument id. <a href="#a18ffd1ad34c1799865f8e03df4ebdff1"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#af51c89da2e4ae54fc9d05038ea484c83">what</a> () const throw ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the arg id and error text. <a href="#af51c89da2e4ae54fc9d05038ea484c83"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTCLAP_1_1ArgException.html#abd271955e1b808bb92f8db7a16ea7c95">typeDescription</a> () const </td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of the exception. <a href="#abd271955e1b808bb92f8db7a16ea7c95"></a><br/></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>A simple class that defines and argument exception. </p> +<p>Should be caught whenever a <a class="el" href="classTCLAP_1_1CmdLine.html" title="The base class that manages the command line definition and passes along the parsing...">CmdLine</a> is created and parsed. </p> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00036">36</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a67389912b628e95d530f8bb8de97b309"></a><!-- doxytag: member="TCLAP::ArgException::ArgException" ref="a67389912b628e95d530f8bb8de97b309" args="(const std::string &text="undefined exception", const std::string &id="undefined", const std::string &td="Generic ArgException")" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">TCLAP::ArgException::ArgException </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"> <em>text</em> = <code>"undefined exception"</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"> <em>id</em> = <code>"undefined"</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"> <em>td</em> = <code>"Generic <a class="el" href="classTCLAP_1_1ArgException.html">ArgException</a>"</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Constructor. </p> +<dl><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>- The text of the exception. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>- The text identifying the argument source. </td></tr> + <tr><td valign="top"></td><td valign="top"><em>td</em> </td><td>- Text describing the type of <a class="el" href="classTCLAP_1_1ArgException.html" title="A simple class that defines and argument exception.">ArgException</a> it is. of the exception. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00047">47</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a5c5df6a814b05c623a01607fb82980f4"></a><!-- doxytag: member="TCLAP::ArgException::~ArgException" ref="a5c5df6a814b05c623a01607fb82980f4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual TCLAP::ArgException::~ArgException </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> throw ()<code> [inline, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Destructor. </p> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00059">59</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="a18ffd1ad34c1799865f8e03df4ebdff1"></a><!-- doxytag: member="TCLAP::ArgException::argId" ref="a18ffd1ad34c1799865f8e03df4ebdff1" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TCLAP::ArgException::argId </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the argument id. </p> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00069">69</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> + +<p>Referenced by <a class="el" href="StdOutput_8h_source.html#l00131">TCLAP::StdOutput::failure()</a>.</p> + +</div> +</div> +<a class="anchor" id="a0656dab88a7129bc288821bacd653d08"></a><!-- doxytag: member="TCLAP::ArgException::error" ref="a0656dab88a7129bc288821bacd653d08" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TCLAP::ArgException::error </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the error text. </p> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00064">64</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> + +<p>Referenced by <a class="el" href="ValueArg_8h_source.html#l00400">TCLAP::ValueArg< T >::_extractValue()</a>, <a class="el" href="MultiArg_8h_source.html#l00398">TCLAP::MultiArg< T >::_extractValue()</a>, and <a class="el" href="StdOutput_8h_source.html#l00131">TCLAP::StdOutput::failure()</a>.</p> + +</div> +</div> +<a class="anchor" id="abd271955e1b808bb92f8db7a16ea7c95"></a><!-- doxytag: member="TCLAP::ArgException::typeDescription" ref="abd271955e1b808bb92f8db7a16ea7c95" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string TCLAP::ArgException::typeDescription </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the type of the exception. </p> +<p>Used to explain and distinguish between different child exceptions. </p> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00091">91</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af51c89da2e4ae54fc9d05038ea484c83"></a><!-- doxytag: member="TCLAP::ArgException::what" ref="af51c89da2e4ae54fc9d05038ea484c83" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* TCLAP::ArgException::what </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td> const throw ()<code> [inline]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Returns the arg id and error text. </p> + +<p>Definition at line <a class="el" href="ArgException_8h_source.html#l00080">80</a> of file <a class="el" href="ArgException_8h_source.html">ArgException.h</a>.</p> + +<p>Referenced by <a class="el" href="ZshCompletionOutput_8h_source.html#l00129">TCLAP::ZshCompletionOutput::failure()</a>, and <a class="el" href="DocBookOutput_8h_source.html#l00174">TCLAP::DocBookOutput::failure()</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="ArgException_8h_source.html">ArgException.h</a></li> +</ul> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Sat Apr 16 15:34:25 2011 for tclap by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.0 </small></address> +</body> +</html> |