<!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: IntegerArgument 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>IntegerArgument Class Reference</h1><!-- doxytag: class="IntegerArgument" --><!-- doxytag: inherits="Argument" -->A definition for integer arguments.
<a href="#_details">More...</a>
<p>
<code>#include <Function.h></code>
<p>
<div class="dynheader">
Inheritance diagram for IntegerArgument:</div>
<div class="dynsection">
<p><center><img src="classIntegerArgument.png" usemap="#IntegerArgument_map" border="0" alt=""></center>
<map name="IntegerArgument_map">
<area href="classArgument.html" alt="Argument" shape="rect" coords="0,0,105,24">
</map>
</div>
<p>
<a href="classIntegerArgument-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="d639eb55b976e8249c1c5f2976f688d7"></a><!-- doxytag: member="IntegerArgument::IntegerArgument" ref="d639eb55b976e8249c1c5f2976f688d7" args="(string name_="", ArgumentMinMaxPreDefinition minmax=ARGUMENT_MIN_MAX_NONE, bool does_test=true, bool does_error=true)" -->
</td><td class="memItemRight" valign="bottom"><b>IntegerArgument</b> (string name_="", <a class="el" href="Function_8h.html#d0a30ebdef87198658988eb0817dd6b3">ArgumentMinMaxPreDefinition</a> minmax=ARGUMENT_MIN_MAX_NONE, bool does_test=true, bool does_error=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7dbe432ed869933cbc6d8870eb463ecc"></a><!-- doxytag: member="IntegerArgument::IntegerArgument" ref="7dbe432ed869933cbc6d8870eb463ecc" args="(const IntegerArgument *arg)" -->
</td><td class="memItemRight" valign="bottom"><b>IntegerArgument</b> (const <a class="el" href="classIntegerArgument.html">IntegerArgument</a> *arg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIntegerArgument.html#8c2679d730b883f6dc0aaa53300e8ace">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="classIntegerArgument.html#994a3f5958f035cabe75c74b20fb039e">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="classIntegerArgument.html#e5d07d0d35c89dc9183660c695cf4c4a">print</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87a72ad191d93c66a323938cea279269"></a><!-- doxytag: member="IntegerArgument::setMin" ref="87a72ad191d93c66a323938cea279269" args="(const Number *nmin)" -->
void </td><td class="memItemRight" valign="bottom"><b>setMin</b> (const <a class="el" href="classNumber.html">Number</a> *nmin)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18be4d817796dc3380ae7bf768cd53b"></a><!-- doxytag: member="IntegerArgument::min" ref="a18be4d817796dc3380ae7bf768cd53b" args="() const " -->
const <a class="el" href="classNumber.html">Number</a> * </td><td class="memItemRight" valign="bottom"><b>min</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a51805e23fc9df92953f0ca7272b3d30"></a><!-- doxytag: member="IntegerArgument::setMax" ref="a51805e23fc9df92953f0ca7272b3d30" args="(const Number *nmax)" -->
void </td><td class="memItemRight" valign="bottom"><b>setMax</b> (const <a class="el" href="classNumber.html">Number</a> *nmax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1568e981cd2dc28e2d5cf26f9cb1533c"></a><!-- doxytag: member="IntegerArgument::max" ref="1568e981cd2dc28e2d5cf26f9cb1533c" args="() const " -->
const <a class="el" href="classNumber.html">Number</a> * </td><td class="memItemRight" valign="bottom"><b>max</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="classIntegerArgument.html#a8a85061dc6bb3bab5b93bfa09458c94">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="classIntegerArgument.html#5dbc073d39c71eb263faa1cc124e7ec0">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="classIntegerArgument.html#0f97d178c0ccb382794429cd43c69964">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="10cc45063985367f6758b3912e7ee9e2"></a><!-- doxytag: member="IntegerArgument::imin" ref="10cc45063985367f6758b3912e7ee9e2" args="" -->
<a class="el" href="classNumber.html">Number</a> * </td><td class="memItemRight" valign="bottom"><b>imin</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="460a135d2dbbbe2042d29670c339eb86"></a><!-- doxytag: member="IntegerArgument::imax" ref="460a135d2dbbbe2042d29670c339eb86" args="" -->
<a class="el" href="classNumber.html">Number</a> * </td><td class="memItemRight" valign="bottom"><b>imax</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A definition for integer arguments.
<p>
These arguments allows numerical integer values. The value can be restricted to a max and/or min value. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5dbc073d39c71eb263faa1cc124e7ec0"></a><!-- doxytag: member="IntegerArgument::subtest" ref="5dbc073d39c71eb263faa1cc124e7ec0" args="(MathStructure &value, const EvaluationOptions &eo) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool IntegerArgument::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="0f97d178c0ccb382794429cd43c69964"></a><!-- doxytag: member="IntegerArgument::subprintlong" ref="0f97d178c0ccb382794429cd43c69964" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string IntegerArgument::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="8c2679d730b883f6dc0aaa53300e8ace"></a><!-- doxytag: member="IntegerArgument::set" ref="8c2679d730b883f6dc0aaa53300e8ace" args="(const Argument *arg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void IntegerArgument::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 from <a class="el" href="classArgument.html#2a3cda124d233c5694a31a608d44cda3">Argument</a>.</p>
</div>
</div><p>
<a class="anchor" name="994a3f5958f035cabe75c74b20fb039e"></a><!-- doxytag: member="IntegerArgument::copy" ref="994a3f5958f035cabe75c74b20fb039e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classArgument.html">Argument</a>* IntegerArgument::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="e5d07d0d35c89dc9183660c695cf4c4a"></a><!-- doxytag: member="IntegerArgument::print" ref="e5d07d0d35c89dc9183660c695cf4c4a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual string IntegerArgument::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>
<a class="anchor" name="a8a85061dc6bb3bab5b93bfa09458c94"></a><!-- doxytag: member="IntegerArgument::type" ref="a8a85061dc6bb3bab5b93bfa09458c94" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int IntegerArgument::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>
<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
>
89
