<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libqalculate-0.9.7: FunctionArgument Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<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>
<div class="contents">
<h1>FunctionArgument Class Reference</h1><!-- doxytag: class="FunctionArgument" --><!-- doxytag: inherits="Argument" -->A function argument.
<a href="#_details">More...</a>
<p>
<code>#include <Function.h></code>
<p>
<div class="dynheader">
Inheritance diagram for FunctionArgument:</div>
<div class="dynsection">
<p><center><img src="classFunctionArgument.png" usemap="#FunctionArgument_map" border="0" alt=""></center>
<map name="FunctionArgument_map">
<area href="classArgument.html" alt="Argument" shape="rect" coords="0,0,115,24">
</map>
</div>
<p>
<a href="classFunctionArgument-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99e91da83692ebc6f8aa057f165abcba"></a><!-- doxytag: member="FunctionArgument::FunctionArgument" ref="99e91da83692ebc6f8aa057f165abcba" args="(string name_="", bool does_test=true, bool does_error=true)" -->
</td><td class="memItemRight" valign="bottom"><b>FunctionArgument</b> (string name_="", bool does_test=true, bool does_error=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5184a688601ef15f95963653410ec55b"></a><!-- doxytag: member="FunctionArgument::FunctionArgument" ref="5184a688601ef15f95963653410ec55b" args="(const FunctionArgument *arg)" -->
</td><td class="memItemRight" valign="bottom"><b>FunctionArgument</b> (const <a class="el" href="classFunctionArgument.html">FunctionArgument</a> *arg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFunctionArgument.html#99da055b6c94bbe396dc99402fd6fff3">type</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classArgument.html">Argument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFunctionArgument.html#8bc2db293e9dea22e420153f20401635">copy</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFunctionArgument.html#415a9fcfcf48351afbe16018096e3ea6">print</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFunctionArgument.html#2a1ee74dc40ca0aadce6bbdf85adeee3">subtest</a> (<a class="el" href="classMathStructure.html">MathStructure</a> &value, const <a class="el" href="structEvaluationOptions.html">EvaluationOptions</a> &eo) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFunctionArgument.html#c58e84555b46c061d71012887304d53f">subprintlong</a> () const </td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A function argument. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2a1ee74dc40ca0aadce6bbdf85adeee3"></a><!-- doxytag: member="FunctionArgument::subtest" ref="2a1ee74dc40ca0aadce6bbdf85adeee3" args="(MathStructure &value, const EvaluationOptions &eo) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FunctionArgument::subtest </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMathStructure.html">MathStructure</a> & </td>
<td class="paramname"> <em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structEvaluationOptions.html">EvaluationOptions</a> & </td>
<td class="paramname"> <em>eo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function is called from <a class="el" href="classArgument.html#56535da601c8f8f46c2b9fa3cfe97730">Argument::test()</a> and performs validation specific to the argument definition type. Should be reimplemented by all subclasses.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value to test. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eo</em> </td><td>Evaluation options to use if the value needs to be evaluated. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the value is valid for the argument definition. </dd></dl>
<p>Reimplemented from <a class="el" href="classArgument.html#c6e3f5ea55c3abe8fd7f978647589087">Argument</a>.</p>
</div>
</div><p>
<a class="anchor" name="c58e84555b46c061d71012887304d53f"></a><!-- doxytag: member="FunctionArgument::subprintlong" ref="c58e84555b46c061d71012887304d53f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string FunctionArgument::subprintlong </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This function is called from <a class="el" href="classArgument.html#09d80da7b0eb5d0b63f31f4289425049">Argument::printlong()</a> and returns description specific the argument definition type. Should be reimplemented by all subclasses. For example <a class="el" href="classIntegerArgument.html#0f97d178c0ccb382794429cd43c69964">IntegerArgument::subprintlong()</a> might return "an integer" and <a class="el" href="classArgument.html#09d80da7b0eb5d0b63f31f4289425049">Argument::printlong()</a> might append " that fulfills the condition: even(\x)".<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Long description. </dd></dl>
<p>Reimplemented from <a class="el" href="classArgument.html#ecb66daedc6826a33816652afb64e674">Argument</a>.</p>
</div>
</div><p>
<a class="anchor" name="99da055b6c94bbe396dc99402fd6fff3"></a><!-- doxytag: member="FunctionArgument::type" ref="99da055b6c94bbe396dc99402fd6fff3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int FunctionArgument::type </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the type of the argument, corresponding to which subclass the object belongs to.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="Function_8h.html#a15f3f718db408445afc1b93c12294c5" title="Argument types.">ArgumentType</a>. </dd></dl>
<p>Reimplemented from <a class="el" href="classArgument.html#2709c0d89f7827fabb1c4d4a563cae1a">Argument</a>.</p>
</div>
</div><p>
<a class="anchor" name="8bc2db293e9dea22e420153f20401635"></a><!-- doxytag: member="FunctionArgument::copy" ref="8bc2db293e9dea22e420153f20401635" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classArgument.html">Argument</a>* FunctionArgument::copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a copy of the argument definition.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A copy. </dd></dl>
<p>Reimplemented from <a class="el" href="classArgument.html#b3c1acf637efbe585bb716cb6ecf5829">Argument</a>.</p>
</div>
</div><p>
<a class="anchor" name="415a9fcfcf48351afbe16018096e3ea6"></a><!-- doxytag: member="FunctionArgument::print" ref="415a9fcfcf48351afbe16018096e3ea6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string FunctionArgument::print </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resturns a short description of the argument definition. Ex. "number" for <a class="el" href="classNumberArgument.html" title="A definition for numerical arguments.">NumberArgument</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Short description. </dd></dl>
<p>Reimplemented from <a class="el" href="classArgument.html#3d7c3969caf6b5e9dd70574bbbaffe3d">Argument</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>libqalculate/<a class="el" href="Function_8h.html">Function.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 5 08:26:29 2010 for libqalculate-0.9.7 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
3ef76ad7219246424c2f43bbe981fa80
>
files
>
86
