1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libqalculate-0.9.6: VectorArgument Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.3 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>VectorArgument Class Reference</h1><!-- doxytag: class=<VectorArgument> --><!-- doxytag: inherits=<Argument> -->A vector argument.
<a href="#_details">More...</a>
<p>
<code>#include <Function.h></code>
<p>
<p>Inheritance diagram for VectorArgument:
<p><center><img src="classVectorArgument.png" usemap="#VectorArgument_map" border="0" alt=""></center>
<map name="VectorArgument_map">
<area href="classArgument.html" alt="Argument" shape="rect" coords="0,0,104,24">
</map>
<a href="classVectorArgument-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="a0"></a><!-- doxytag: member=<VectorArgument::VectorArgument> ref=<a0> args=<(string name_="", bool does_test=true, bool allow_matrix=false, bool does_error=true)> -->
</td><td class="memItemRight" valign="bottom"><b>VectorArgument</b> (string name_="", bool does_test=true, bool allow_matrix=false, bool does_error=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member=<VectorArgument::VectorArgument> ref=<a1> args=<(const VectorArgument *arg)> -->
</td><td class="memItemRight" valign="bottom"><b>VectorArgument</b> (const <a class="el" href="classVectorArgument.html">VectorArgument</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="classVectorArgument.html#a3">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="classVectorArgument.html#a4">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="classVectorArgument.html#a5">print</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member=<VectorArgument::reoccuringArguments> ref=<a6> args=<() const > -->
bool </td><td class="memItemRight" valign="bottom"><b>reoccuringArguments</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member=<VectorArgument::setReoccuringArguments> ref=<a7> args=<(bool reocc)> -->
void </td><td class="memItemRight" valign="bottom"><b>setReoccuringArguments</b> (bool reocc)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member=<VectorArgument::addArgument> ref=<a8> args=<(Argument *arg)> -->
void </td><td class="memItemRight" valign="bottom"><b>addArgument</b> (<a class="el" href="classArgument.html">Argument</a> *arg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9"></a><!-- doxytag: member=<VectorArgument::delArgument> ref=<a9> args=<(size_t index)> -->
void </td><td class="memItemRight" valign="bottom"><b>delArgument</b> (size_t index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10"></a><!-- doxytag: member=<VectorArgument::countArguments> ref=<a10> args=<() const > -->
size_t </td><td class="memItemRight" valign="bottom"><b>countArguments</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11"></a><!-- doxytag: member=<VectorArgument::getArgument> ref=<a11> args=<(size_t index) const > -->
<a class="el" href="classArgument.html">Argument</a> * </td><td class="memItemRight" valign="bottom"><b>getArgument</b> (size_t index) 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="classVectorArgument.html#b0">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="classVectorArgument.html#b1">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="p0"></a><!-- doxytag: member=<VectorArgument::subargs> ref=<p0> args=<> -->
vector< <a class="el" href="classArgument.html">Argument</a> * > </td><td class="memItemRight" valign="bottom"><b>subargs</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="p1"></a><!-- doxytag: member=<VectorArgument::b_argloop> ref=<p1> args=<> -->
bool </td><td class="memItemRight" valign="bottom"><b>b_argloop</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A vector argument.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a4"></a><!-- doxytag: member=<VectorArgument::copy> ref=<a4> args=<() const > --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classArgument.html">Argument</a>* VectorArgument::copy </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns a copy of the argument definition.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A copy.</dd></dl>
<p>
Reimplemented from <a class="el" href="classArgument.html#a4">Argument</a>. </td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member=<VectorArgument::print> ref=<a5> args=<() const > --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual string VectorArgument::print </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Resturns a short description of the argument definition. Ex. "number" for <a class="el" href="classNumberArgument.html">NumberArgument</a>.<p>
<dl compact><dt><b>Returns:</b></dt><dd>Short description.</dd></dl>
<p>
Reimplemented from <a class="el" href="classArgument.html#a5">Argument</a>. </td>
</tr>
</table>
<a class="anchor" name="b1"></a><!-- doxytag: member=<VectorArgument::subprintlong> ref=<b1> args=<() const > --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual string VectorArgument::subprintlong </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called from <a class="el" href="classArgument.html#a6">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#b1">IntegerArgument::subprintlong()</a> might return "an integer" and <a class="el" href="classArgument.html#a6">Argument::printlong()</a> might append " that fulfills the condition: even(\x)".<p>
<dl compact><dt><b>Returns:</b></dt><dd>Long description.</dd></dl>
<p>
Reimplemented from <a class="el" href="classArgument.html#b1">Argument</a>. </td>
</tr>
</table>
<a class="anchor" name="b0"></a><!-- doxytag: member=<VectorArgument::subtest> ref=<b0> args=<(MathStructure &value, const EvaluationOptions &eo) const > --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool VectorArgument::subtest </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classMathStructure.html">MathStructure</a> & </td>
<td class="mdname" nowrap> <em>value</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="structEvaluationOptions.html">EvaluationOptions</a> & </td>
<td class="mdname" nowrap> <em>eo</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called from <a class="el" href="classArgument.html#a7">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 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#b0">Argument</a>. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member=<VectorArgument::type> ref=<a3> args=<() const > --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int VectorArgument::type </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the type of the argument, corresponding to which subclass the object belongs to.<p>
<dl compact><dt><b>Returns:</b></dt><dd><a class="el" href="Function_8h.html#a26">ArgumentType</a>.</dd></dl>
<p>
Reimplemented from <a class="el" href="classArgument.html#a25">Argument</a>. </td>
</tr>
</table>
<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>
<hr size="1"><address style="align: right;"><small>
Generated on 17 Jun 2007 for libqalculate-0.9.6 by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.3</small></address>
</body>
</html>
|