<!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: Argument 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>Argument Class Reference</h1><!-- doxytag: class="Argument" -->A mathematical function argument definition with free value and base class for all argument definitions.
<a href="#_details">More...</a>
<p>
<code>#include <Function.h></code>
<p>
<div class="dynheader">
Inheritance diagram for Argument:</div>
<div class="dynsection">
<p><center><img src="classArgument.png" usemap="#Argument_map" border="0" alt=""></center>
<map name="Argument_map">
<area href="classArgumentSet.html" alt="ArgumentSet" shape="rect" coords="160,56,310,80">
<area href="classBooleanArgument.html" alt="BooleanArgument" shape="rect" coords="160,112,310,136">
<area href="classDataObjectArgument.html" alt="DataObjectArgument" shape="rect" coords="160,168,310,192">
<area href="classDataPropertyArgument.html" alt="DataPropertyArgument" shape="rect" coords="160,224,310,248">
<area href="classDateArgument.html" alt="DateArgument" shape="rect" coords="160,280,310,304">
<area href="classExpressionItemArgument.html" alt="ExpressionItemArgument" shape="rect" coords="160,336,310,360">
<area href="classFunctionArgument.html" alt="FunctionArgument" shape="rect" coords="160,392,310,416">
<area href="classIntegerArgument.html" alt="IntegerArgument" shape="rect" coords="160,448,310,472">
<area href="classMatrixArgument.html" alt="MatrixArgument" shape="rect" coords="160,504,310,528">
<area href="classNumberArgument.html" alt="NumberArgument" shape="rect" coords="160,560,310,584">
<area href="classSymbolicArgument.html" alt="SymbolicArgument" shape="rect" coords="160,616,310,640">
<area href="classTextArgument.html" alt="TextArgument" shape="rect" coords="160,672,310,696">
<area href="classVectorArgument.html" alt="VectorArgument" shape="rect" coords="160,728,310,752">
</map>
</div>
<p>
<a href="classArgument-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#ea909b4efa29a4500448de2c2d2cbad5">Argument</a> (string name_="", bool does_test=true, bool does_error=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#a208a7a8e113cf3c789be6b0b20f2849">Argument</a> (const <a class="el" href="classArgument.html">Argument</a> *arg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#91317f50fc0f039c6f060994e9f4993d">~Argument</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#2a3cda124d233c5694a31a608d44cda3">set</a> (const <a class="el" href="classArgument.html">Argument</a> *arg)</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="classArgument.html#b3c1acf637efbe585bb716cb6ecf5829">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="classArgument.html#3d7c3969caf6b5e9dd70574bbbaffe3d">print</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#09d80da7b0eb5d0b63f31f4289425049">printlong</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#56535da601c8f8f46c2b9fa3cfe97730">test</a> (<a class="el" href="classMathStructure.html">MathStructure</a> &value, int index, <a class="el" href="classMathFunction.html">MathFunction</a> *f, const <a class="el" href="structEvaluationOptions.html">EvaluationOptions</a> &eo=default_evaluation_options) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classMathStructure.html">MathStructure</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#e2190743e4044574136ffd3a5b743f77">parse</a> (const string &str, const <a class="el" href="structParseOptions.html">ParseOptions</a> &po=default_parse_options) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#097320d6cdd8083ce44d0474d73eef8c">parse</a> (<a class="el" href="classMathStructure.html">MathStructure</a> *mstruct, const string &str, const <a class="el" href="structParseOptions.html">ParseOptions</a> &po=default_parse_options) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#baf3cdd49b81a62598cf814347e5a775">name</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#0fa9eaf486339f09cbbd0158f6f14f9c">setName</a> (string name_)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#4e334a301ebdd1d379df56e1a116f3d9">setCustomCondition</a> (string condition)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#2ea89ac3ddee20d6fa4756711f8ff209">getCustomCondition</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#f0f58f5e52c7aefae550d16845b00ce5">tests</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ef50f56a1457aa7ada7258e07c3f3e9a"></a><!-- doxytag: member="Argument::setTests" ref="ef50f56a1457aa7ada7258e07c3f3e9a" args="(bool does_error)" -->
void </td><td class="memItemRight" valign="bottom"><b>setTests</b> (bool does_error)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#5e84d406b580ff6c9ac46a33443c4c43">alerts</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="605fcf92a10eaac188de48b71a520e8e"></a><!-- doxytag: member="Argument::setAlerts" ref="605fcf92a10eaac188de48b71a520e8e" args="(bool does_error)" -->
void </td><td class="memItemRight" valign="bottom"><b>setAlerts</b> (bool does_error)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#44827812c9d1cb026cf4ac7963aa3239">zeroForbidden</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#48b04575f0e37c8dd5ae512d3065b2d0">setZeroForbidden</a> (bool forbid_zero)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b2bdb9bacb593e4d894fd18cf7e95ba"></a><!-- doxytag: member="Argument::matrixAllowed" ref="8b2bdb9bacb593e4d894fd18cf7e95ba" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>matrixAllowed</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7953dd9e30126dbdbf3e2b3872c550a8"></a><!-- doxytag: member="Argument::setMatrixAllowed" ref="7953dd9e30126dbdbf3e2b3872c550a8" args="(bool allow_matrix)" -->
void </td><td class="memItemRight" valign="bottom"><b>setMatrixAllowed</b> (bool allow_matrix)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#551f2653e0620d486f523c7dcc37e06c">rationalPolynomial</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4730d6cb5e3f4f2815f6ae3c180b00a9"></a><!-- doxytag: member="Argument::setRationalPolynomial" ref="4730d6cb5e3f4f2815f6ae3c180b00a9" args="(bool rational_polynomial)" -->
void </td><td class="memItemRight" valign="bottom"><b>setRationalPolynomial</b> (bool rational_polynomial)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd7c82b5eb132403f2b663eaca08354c"></a><!-- doxytag: member="Argument::suggestsQuotes" ref="dd7c82b5eb132403f2b663eaca08354c" args="() const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><b>suggestsQuotes</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classArgument.html#2709c0d89f7827fabb1c4d4a563cae1a">type</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="classArgument.html#c6e3f5ea55c3abe8fd7f978647589087">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="classArgument.html#ecb66daedc6826a33816652afb64e674">subprintlong</a> () const </td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6f99eb71dbbfc299a19a2ca490605d2e"></a><!-- doxytag: member="Argument::sname" ref="6f99eb71dbbfc299a19a2ca490605d2e" args="" -->
string </td><td class="memItemRight" valign="bottom"><b>sname</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eca681cb019a8387e1619ed99c88db90"></a><!-- doxytag: member="Argument::scondition" ref="eca681cb019a8387e1619ed99c88db90" args="" -->
string </td><td class="memItemRight" valign="bottom"><b>scondition</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e13f049d9625f3e8e44dca72e33dbcd5"></a><!-- doxytag: member="Argument::b_zero" ref="e13f049d9625f3e8e44dca72e33dbcd5" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_zero</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e3e689d6a71f9056d8b2c20cea676d32"></a><!-- doxytag: member="Argument::b_test" ref="e3e689d6a71f9056d8b2c20cea676d32" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_test</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5bf6188ef214b0e8286a8f60720217ca"></a><!-- doxytag: member="Argument::b_matrix" ref="5bf6188ef214b0e8286a8f60720217ca" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_matrix</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dbee739419b96f750b711c6cd656ce6c"></a><!-- doxytag: member="Argument::b_text" ref="dbee739419b96f750b711c6cd656ce6c" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_text</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce1cb46f5237639a8897b6bf27871aea"></a><!-- doxytag: member="Argument::b_error" ref="ce1cb46f5237639a8897b6bf27871aea" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_error</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a36913ff07195adfed0025279e9789da"></a><!-- doxytag: member="Argument::b_rational" ref="a36913ff07195adfed0025279e9789da" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>b_rational</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A mathematical function argument definition with free value and base class for all argument definitions.
<p>
Free arguments accepts any value. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ea909b4efa29a4500448de2c2d2cbad5"></a><!-- doxytag: member="Argument::Argument" ref="ea909b4efa29a4500448de2c2d2cbad5" args="(string name_="", bool does_test=true, bool does_error=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Argument::Argument </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"> <em>name_</em> = <code>""</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>does_test</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>does_error</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a new argument definition.<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>name</em> </td><td>Name/title of the argument definition. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>does_test</em> </td><td>If argument values will be tested. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>does_error</em> </td><td>If an error will issued if the value tests false. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a208a7a8e113cf3c789be6b0b20f2849"></a><!-- doxytag: member="Argument::Argument" ref="a208a7a8e113cf3c789be6b0b20f2849" args="(const Argument *arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Argument::Argument </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classArgument.html">Argument</a> * </td>
<td class="paramname"> <em>arg</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a copy of an argument definition.<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>arg</em> </td><td><a class="el" href="classArgument.html" title="A mathematical function argument definition with free value and base class for all...">Argument</a> to copy. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="91317f50fc0f039c6f060994e9f4993d"></a><!-- doxytag: member="Argument::~Argument" ref="91317f50fc0f039c6f060994e9f4993d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Argument::~Argument </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c6e3f5ea55c3abe8fd7f978647589087"></a><!-- doxytag: member="Argument::subtest" ref="c6e3f5ea55c3abe8fd7f978647589087" args="(MathStructure &value, const EvaluationOptions &eo) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Argument::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 in <a class="el" href="classDataPropertyArgument.html#ae83183110d14237ad88a415e4361db6">DataPropertyArgument</a>, <a class="el" href="classDataObjectArgument.html#50555a711375a791dd1c41f60732daad">DataObjectArgument</a>, <a class="el" href="classNumberArgument.html#bd55d57c787974c9e90a2a9aace0f2ff">NumberArgument</a>, <a class="el" href="classIntegerArgument.html#5dbc073d39c71eb263faa1cc124e7ec0">IntegerArgument</a>, <a class="el" href="classSymbolicArgument.html#eb1743e601ace91ac6b571fb714d91b8">SymbolicArgument</a>, <a class="el" href="classTextArgument.html#2181c4b3b554837a4656b1098f48168c">TextArgument</a>, <a class="el" href="classDateArgument.html#3568e57bd71b6359e4d16853da3b1d05">DateArgument</a>, <a class="el" href="classVectorArgument.html#955ca4af66f5b1aa64a3456c3dc29231">VectorArgument</a>, <a class="el" href="classMatrixArgument.html#4f9605f2d5db8eacbfa197b85fd24e2a">MatrixArgument</a>, <a class="el" href="classExpressionItemArgument.html#23c2514af5f6483cf78739966611428f">ExpressionItemArgument</a>, <a class="el" href="classFunctionArgument.html#2a1ee74dc40ca0aadce6bbdf85adeee3">FunctionArgument</a>, <a class="el" href="classBooleanArgument.html#19b9a27f65c804a0107260991b1ba01c">BooleanArgument</a>, and <a class="el" href="classArgumentSet.html#9b34ab596af06a8863f227cf0861b3da">ArgumentSet</a>.</p>
</div>
</div><p>
<a class="anchor" name="ecb66daedc6826a33816652afb64e674"></a><!-- doxytag: member="Argument::subprintlong" ref="ecb66daedc6826a33816652afb64e674" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string Argument::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 in <a class="el" href="classDataPropertyArgument.html#189cd18430892381d8a9b5282b0cfa6f">DataPropertyArgument</a>, <a class="el" href="classDataObjectArgument.html#6d2364614b3a14a31c63e139264376e7">DataObjectArgument</a>, <a class="el" href="classNumberArgument.html#31b7f01aedc8bb7f907086d35c5b67f1">NumberArgument</a>, <a class="el" href="classIntegerArgument.html#0f97d178c0ccb382794429cd43c69964">IntegerArgument</a>, <a class="el" href="classSymbolicArgument.html#d872629da92c7c79d4092704f419537f">SymbolicArgument</a>, <a class="el" href="classTextArgument.html#be7efd7355e44a2dc71783930b5b6c65">TextArgument</a>, <a class="el" href="classDateArgument.html#1056fb84015ae5d439eb1593c6da8c96">DateArgument</a>, <a class="el" href="classVectorArgument.html#699daca905aa9321609983ba8bf904c9">VectorArgument</a>, <a class="el" href="classMatrixArgument.html#64363e0ee0305e2e4a052004c8e4a031">MatrixArgument</a>, <a class="el" href="classExpressionItemArgument.html#d8086df4b5ed5833d5c778c3b9f713fc">ExpressionItemArgument</a>, <a class="el" href="classFunctionArgument.html#c58e84555b46c061d71012887304d53f">FunctionArgument</a>, <a class="el" href="classBooleanArgument.html#ea16beb0f86ba00b8d2db7c2625fed9d">BooleanArgument</a>, and <a class="el" href="classArgumentSet.html#a333123a717ccef0ec21cb4e6f034ed3">ArgumentSet</a>.</p>
</div>
</div><p>
<a class="anchor" name="2a3cda124d233c5694a31a608d44cda3"></a><!-- doxytag: member="Argument::set" ref="2a3cda124d233c5694a31a608d44cda3" args="(const Argument *arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Argument::set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classArgument.html">Argument</a> * </td>
<td class="paramname"> <em>arg</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the argument to a copy of an argument definition.<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>arg</em> </td><td><a class="el" href="classArgument.html" title="A mathematical function argument definition with free value and base class for all...">Argument</a> to copy. </td></tr>
</table>
</dl>
<p>Reimplemented in <a class="el" href="classNumberArgument.html#ab80211f0736c6e6dfa4351a5b0e243f">NumberArgument</a>, and <a class="el" href="classIntegerArgument.html#8c2679d730b883f6dc0aaa53300e8ace">IntegerArgument</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3c1acf637efbe585bb716cb6ecf5829"></a><!-- doxytag: member="Argument::copy" ref="b3c1acf637efbe585bb716cb6ecf5829" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classArgument.html">Argument</a>* Argument::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 in <a class="el" href="classDataPropertyArgument.html#3e702ce2ad2d6f81561d31153fd9603e">DataPropertyArgument</a>, <a class="el" href="classDataObjectArgument.html#1d1256a5dfe67f18cd686825aabd82ef">DataObjectArgument</a>, <a class="el" href="classNumberArgument.html#7955bf2595b6e3f2b114d43fa5cbc145">NumberArgument</a>, <a class="el" href="classIntegerArgument.html#994a3f5958f035cabe75c74b20fb039e">IntegerArgument</a>, <a class="el" href="classSymbolicArgument.html#e63a236b41fb671e01c16c0a33bd9d50">SymbolicArgument</a>, <a class="el" href="classTextArgument.html#1d0a744df15298401b9151b1b1da73be">TextArgument</a>, <a class="el" href="classDateArgument.html#277f026ca60078b6c6aef3a9f0af30a6">DateArgument</a>, <a class="el" href="classVectorArgument.html#27add182b91ee84484a355c4293ddf63">VectorArgument</a>, <a class="el" href="classMatrixArgument.html#2944a72f19dafb865c8a3a565c2e9950">MatrixArgument</a>, <a class="el" href="classExpressionItemArgument.html#9102d79d5f7575c9fff17ecfa74616e5">ExpressionItemArgument</a>, <a class="el" href="classFunctionArgument.html#8bc2db293e9dea22e420153f20401635">FunctionArgument</a>, <a class="el" href="classBooleanArgument.html#6348cebcbd76cc8aa442387a99f7b36e">BooleanArgument</a>, and <a class="el" href="classArgumentSet.html#06ab3fa4a3a48048fc91c352b94bc582">ArgumentSet</a>.</p>
</div>
</div><p>
<a class="anchor" name="3d7c3969caf6b5e9dd70574bbbaffe3d"></a><!-- doxytag: member="Argument::print" ref="3d7c3969caf6b5e9dd70574bbbaffe3d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string Argument::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 in <a class="el" href="classDataPropertyArgument.html#f4987b046357d3791220ff09b5b08355">DataPropertyArgument</a>, <a class="el" href="classDataObjectArgument.html#13bcec69456d53769f8075c25214a8e2">DataObjectArgument</a>, <a class="el" href="classNumberArgument.html#d1705dcedc0f6ff5f86b9d5b8cdb2f6f">NumberArgument</a>, <a class="el" href="classIntegerArgument.html#e5d07d0d35c89dc9183660c695cf4c4a">IntegerArgument</a>, <a class="el" href="classSymbolicArgument.html#30e2aff202a29955a1efa1370b4dc522">SymbolicArgument</a>, <a class="el" href="classTextArgument.html#5b9db7cf952b83a017cc91738f3f85cf">TextArgument</a>, <a class="el" href="classDateArgument.html#d5347f77100b2ae5abd1d95e8a061786">DateArgument</a>, <a class="el" href="classVectorArgument.html#9ba7c4f74c575fe80856ac09ef9e964c">VectorArgument</a>, <a class="el" href="classMatrixArgument.html#160d760cf6e5510ec4c5f56dcb30ccc0">MatrixArgument</a>, <a class="el" href="classExpressionItemArgument.html#ac0f58cf5fd0bfc2d1b477f35dfe5722">ExpressionItemArgument</a>, <a class="el" href="classFunctionArgument.html#415a9fcfcf48351afbe16018096e3ea6">FunctionArgument</a>, <a class="el" href="classBooleanArgument.html#00608fd0ef3803bb118d3d4eac87abba">BooleanArgument</a>, and <a class="el" href="classArgumentSet.html#3c653be29fdd101b94e4ec635455582f">ArgumentSet</a>.</p>
</div>
</div><p>
<a class="anchor" name="09d80da7b0eb5d0b63f31f4289425049"></a><!-- doxytag: member="Argument::printlong" ref="09d80da7b0eb5d0b63f31f4289425049" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Argument::printlong </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resturns a long description of the argument definition. Ex. "A real number > 2".<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Long description. </dd></dl>
</div>
</div><p>
<a class="anchor" name="56535da601c8f8f46c2b9fa3cfe97730"></a><!-- doxytag: member="Argument::test" ref="56535da601c8f8f46c2b9fa3cfe97730" args="(MathStructure &value, int index, MathFunction *f, const EvaluationOptions &eo=default_evaluation_options) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Argument::test </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">int </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMathFunction.html">MathFunction</a> * </td>
<td class="paramname"> <em>f</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> = <code>default_evaluation_options</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tests if a value fulfils the requirements of the argument definition. The value might change if it has not been fully evaluated.<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>f</em> </td><td>Mathematical function that the value is an argument for. </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>
</div>
</div><p>
<a class="anchor" name="e2190743e4044574136ffd3a5b743f77"></a><!-- doxytag: member="Argument::parse" ref="e2190743e4044574136ffd3a5b743f77" args="(const string &str, const ParseOptions &po=default_parse_options) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classMathStructure.html">MathStructure</a> Argument::parse </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structParseOptions.html">ParseOptions</a> & </td>
<td class="paramname"> <em>po</em> = <code>default_parse_options</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses an expression for an argument value. The default behavior is to use <a class="el" href="classCalculator.html#8324b84bd93abbf7bf1084c1853ed987">Calculator::parse()</a> directly.<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>str</em> </td><td>Expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>po</em> </td><td>Parse options. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new mathematical structure with the parsed expression. </dd></dl>
</div>
</div><p>
<a class="anchor" name="097320d6cdd8083ce44d0474d73eef8c"></a><!-- doxytag: member="Argument::parse" ref="097320d6cdd8083ce44d0474d73eef8c" args="(MathStructure *mstruct, const string &str, const ParseOptions &po=default_parse_options) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Argument::parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMathStructure.html">MathStructure</a> * </td>
<td class="paramname"> <em>mstruct</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structParseOptions.html">ParseOptions</a> & </td>
<td class="paramname"> <em>po</em> = <code>default_parse_options</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses an expression for an argument value. The default behavior is to use <a class="el" href="classCalculator.html#8324b84bd93abbf7bf1084c1853ed987">Calculator::parse()</a> directly.<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>mstruct</em> </td><td>Mathematical structure to set with the parsed expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Expression. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>po</em> </td><td>Parse options. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="baf3cdd49b81a62598cf814347e5a775"></a><!-- doxytag: member="Argument::name" ref="baf3cdd49b81a62598cf814347e5a775" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Argument::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the name/title of the argument definition.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Name/title. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0fa9eaf486339f09cbbd0158f6f14f9c"></a><!-- doxytag: member="Argument::setName" ref="0fa9eaf486339f09cbbd0158f6f14f9c" args="(string name_)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Argument::setName </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"> <em>name_</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the name/title of the argument definition.<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>name_</em> </td><td>New name/title. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4e334a301ebdd1d379df56e1a116f3d9"></a><!-- doxytag: member="Argument::setCustomCondition" ref="4e334a301ebdd1d379df56e1a116f3d9" args="(string condition)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Argument::setCustomCondition </td>
<td>(</td>
<td class="paramtype">string </td>
<td class="paramname"> <em>condition</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a custom condition for argument values. '' is replaced by the argument value in the expression.<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>condition</em> </td><td>Condition expression. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2ea89ac3ddee20d6fa4756711f8ff209"></a><!-- doxytag: member="Argument::getCustomCondition" ref="2ea89ac3ddee20d6fa4756711f8ff209" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string Argument::getCustomCondition </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the custom condition expression set for argument values.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Custom condition for argument values. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f0f58f5e52c7aefae550d16845b00ce5"></a><!-- doxytag: member="Argument::tests" ref="f0f58f5e52c7aefae550d16845b00ce5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Argument::tests </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the value for the argument will be tested. If not, the argument only works as an suggestion and any value is allowed.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the argument value will be tested. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5e84d406b580ff6c9ac46a33443c4c43"></a><!-- doxytag: member="Argument::alerts" ref="5e84d406b580ff6c9ac46a33443c4c43" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Argument::alerts </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If an error message will be presented to the user if the value for the argument is not allowed.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if error messages will be shown. </dd></dl>
</div>
</div><p>
<a class="anchor" name="44827812c9d1cb026cf4ac7963aa3239"></a><!-- doxytag: member="Argument::zeroForbidden" ref="44827812c9d1cb026cf4ac7963aa3239" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Argument::zeroForbidden </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If an argument value of zero is forbidden.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if zero argument value is forbidden. </dd></dl>
</div>
</div><p>
<a class="anchor" name="48b04575f0e37c8dd5ae512d3065b2d0"></a><!-- doxytag: member="Argument::setZeroForbidden" ref="48b04575f0e37c8dd5ae512d3065b2d0" args="(bool forbid_zero)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Argument::setZeroForbidden </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>forbid_zero</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets if a value of zero is forbidden for the argument value.<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>forbid_zero</em> </td><td>If zero shall be forbidden. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="551f2653e0620d486f523c7dcc37e06c"></a><!-- doxytag: member="Argument::rationalPolynomial" ref="551f2653e0620d486f523c7dcc37e06c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Argument::rationalPolynomial </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If only rational polynomials are allowed as argument value.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classMathStructure.html#5355d1ab88a86569305c1f72f4a957cb">MathStructure::isRationalPolynomial()</a> </dd></dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if only rational polynomials is allowed. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2709c0d89f7827fabb1c4d4a563cae1a"></a><!-- doxytag: member="Argument::type" ref="2709c0d89f7827fabb1c4d4a563cae1a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Argument::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 in <a class="el" href="classDataPropertyArgument.html#a4591383a75f11ec045362b8ec402521">DataPropertyArgument</a>, <a class="el" href="classDataObjectArgument.html#bd1362cd5638b2f64c3402c17bc27cb0">DataObjectArgument</a>, <a class="el" href="classNumberArgument.html#f3f6f631e35196cbae868c42d1269e30">NumberArgument</a>, <a class="el" href="classIntegerArgument.html#a8a85061dc6bb3bab5b93bfa09458c94">IntegerArgument</a>, <a class="el" href="classSymbolicArgument.html#bd660b04b05248ad9538bbb8387bbada">SymbolicArgument</a>, <a class="el" href="classTextArgument.html#a47446d79a3b490e672ebeec60fa111f">TextArgument</a>, <a class="el" href="classDateArgument.html#6935c191614538ae0289fa3dd06061f4">DateArgument</a>, <a class="el" href="classVectorArgument.html#8c0d66ca36fefcc836789ef3c041c7d2">VectorArgument</a>, <a class="el" href="classMatrixArgument.html#ce8d3d4816680ef1c38683471532720a">MatrixArgument</a>, <a class="el" href="classExpressionItemArgument.html#bb87fedaeacb9f90892d3e993977f105">ExpressionItemArgument</a>, <a class="el" href="classFunctionArgument.html#99da055b6c94bbe396dc99402fd6fff3">FunctionArgument</a>, <a class="el" href="classBooleanArgument.html#429b56f7f24c374d6c2f5361fd4e0e05">BooleanArgument</a>, and <a class="el" href="classArgumentSet.html#0accdb636c4f2cec234e63d69a6767f3">ArgumentSet</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>
