<!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: Variable 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>Variable Class Reference</h1><!-- doxytag: class="Variable" --><!-- doxytag: inherits="ExpressionItem" -->Abstract base class for variables. <a href="#_details">More...</a> <p> <code>#include <Variable.h></code> <p> <div class="dynheader"> Inheritance diagram for Variable:</div> <div class="dynsection"> <p><center><img src="classVariable.png" usemap="#Variable_map" border="0" alt=""></center> <map name="Variable_map"> <area href="classExpressionItem.html" alt="ExpressionItem" shape="rect" coords="60,0,171,24"> <area href="classKnownVariable.html" alt="KnownVariable" shape="rect" coords="0,112,111,136"> <area href="classUnknownVariable.html" alt="UnknownVariable" shape="rect" coords="121,112,232,136"> <area href="classDynamicVariable.html" alt="DynamicVariable" shape="rect" coords="0,168,111,192"> </map> </div> <p> <a href="classVariable-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="7b639f0de7ff97842fd09f826309e248"></a><!-- doxytag: member="Variable::Variable" ref="7b639f0de7ff97842fd09f826309e248" args="(string cat_, string name_, string title_="", bool is_local=true, bool is_builtin=false, bool is_active=true)" --> </td><td class="memItemRight" valign="bottom"><b>Variable</b> (string cat_, string name_, string title_="", bool is_local=true, bool is_builtin=false, bool is_active=true)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3879a399e6b16351f451c08bc4b3810d"></a><!-- doxytag: member="Variable::Variable" ref="3879a399e6b16351f451c08bc4b3810d" args="(const Variable *variable)" --> </td><td class="memItemRight" valign="bottom"><b>Variable</b> (const <a class="el" href="classVariable.html">Variable</a> *variable)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9f08d3d7e2f60233fbd38750fbbddb74"></a><!-- doxytag: member="Variable::copy" ref="9f08d3d7e2f60233fbd38750fbbddb74" args="() const =0" --> virtual <a class="el" href="classExpressionItem.html">ExpressionItem</a> * </td><td class="memItemRight" valign="bottom"><b>copy</b> () const =0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae1cdf25bb2bc74abbd21ee2f22cf8b8"></a><!-- doxytag: member="Variable::set" ref="ae1cdf25bb2bc74abbd21ee2f22cf8b8" args="(const ExpressionItem *item)" --> virtual void </td><td class="memItemRight" valign="bottom"><b>set</b> (const <a class="el" href="classExpressionItem.html">ExpressionItem</a> *item)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVariable.html#5b91a013e6873f658e25da59f08d8991">type</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVariable.html#3e6d81fe2467b8627b09af909e835742">subtype</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVariable.html#1d3615b28d01c5a84346a63a97b64316">isKnown</a> () const =0</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classVariable.html#4b34b6e7e72601c7915613498ef69744">representsPositive</a> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42622397b65a5c360e18089a9bf9332a"></a><!-- doxytag: member="Variable::representsNegative" ref="42622397b65a5c360e18089a9bf9332a" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsNegative</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="daa2e64f7dd580791355abc7f3329d81"></a><!-- doxytag: member="Variable::representsNonNegative" ref="daa2e64f7dd580791355abc7f3329d81" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsNonNegative</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4e4dc774d83a75d99a7872e2f139287d"></a><!-- doxytag: member="Variable::representsNonPositive" ref="4e4dc774d83a75d99a7872e2f139287d" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsNonPositive</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f0e11f720c7aaf2d42b288d334029114"></a><!-- doxytag: member="Variable::representsInteger" ref="f0e11f720c7aaf2d42b288d334029114" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsInteger</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f57c0c486d0b3faf3cfa7bc45d9461ac"></a><!-- doxytag: member="Variable::representsNumber" ref="f57c0c486d0b3faf3cfa7bc45d9461ac" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsNumber</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4aeb3ad5b8da037bc0534952a9b0a485"></a><!-- doxytag: member="Variable::representsRational" ref="4aeb3ad5b8da037bc0534952a9b0a485" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsRational</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df8260e146cbabf07b4d21e3c59f164b"></a><!-- doxytag: member="Variable::representsReal" ref="df8260e146cbabf07b4d21e3c59f164b" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsReal</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9fef5900854220e259d545a08152611d"></a><!-- doxytag: member="Variable::representsComplex" ref="9fef5900854220e259d545a08152611d" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsComplex</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5074ab24ba0c0e7481b03aa1434bfd88"></a><!-- doxytag: member="Variable::representsNonZero" ref="5074ab24ba0c0e7481b03aa1434bfd88" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsNonZero</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d189873d006e3aca4186ba0bf4f2958"></a><!-- doxytag: member="Variable::representsEven" ref="3d189873d006e3aca4186ba0bf4f2958" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsEven</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63239db01fb9f04a65bc5e5428db8352"></a><!-- doxytag: member="Variable::representsOdd" ref="63239db01fb9f04a65bc5e5428db8352" args="(bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsOdd</b> (bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="392140037feee5c04960938ebccabdbd"></a><!-- doxytag: member="Variable::representsUndefined" ref="392140037feee5c04960938ebccabdbd" args="(bool=false, bool=false, bool=false)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsUndefined</b> (bool=false, bool=false, bool=false)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb0e8f3b1dd46b2a4e0b400306aceda8"></a><!-- doxytag: member="Variable::representsBoolean" ref="cb0e8f3b1dd46b2a4e0b400306aceda8" args="()" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsBoolean</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5411f7e996019fa033fd86760f138538"></a><!-- doxytag: member="Variable::representsNonMatrix" ref="5411f7e996019fa033fd86760f138538" args="()" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>representsNonMatrix</b> ()</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Abstract base class for variables. <p> A variable is an alpha-numerical representation of a known or unknown value. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="5b91a013e6873f658e25da59f08d8991"></a><!-- doxytag: member="Variable::type" ref="5b91a013e6873f658e25da59f08d8991" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int Variable::type </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the type of the expression item, corresponding to which subclass the object belongs to.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="includes_8h.html#05f1c0afe6f10792534dbd98fbb7541f" title="Type of ExpressionItem.">ExpressionItemType</a>. </dd></dl> <p>Implements <a class="el" href="classExpressionItem.html#53cbb21250c1c8cc66c6f18a22aa69cf">ExpressionItem</a>.</p> <p>References <a class="el" href="includes_8h-source.html#l00086">TYPE_VARIABLE</a>.</p> </div> </div><p> <a class="anchor" name="3e6d81fe2467b8627b09af909e835742"></a><!-- doxytag: member="Variable::subtype" ref="3e6d81fe2467b8627b09af909e835742" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int Variable::subtype </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the subtype of the variable, corresponding to which subsubclass the object belongs to.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="Variable_8h.html#0f580b0f6ebc7c28d007d2ce18a78474" title="Type of variable.">VariableSubtype</a>. </dd></dl> <p>Implements <a class="el" href="classExpressionItem.html#b502d8d46b75f60b45e8bcf7dcbf655a">ExpressionItem</a>.</p> <p>Reimplemented in <a class="el" href="classUnknownVariable.html#946ed345fa92c88eb05395bf37542855">UnknownVariable</a>, and <a class="el" href="classKnownVariable.html#dbccee6770fa72d8074e70337871cc5b">KnownVariable</a>.</p> <p>References <a class="el" href="Variable_8h-source.html#l00064">SUBTYPE_VARIABLE</a>.</p> </div> </div><p> <a class="anchor" name="1d3615b28d01c5a84346a63a97b64316"></a><!-- doxytag: member="Variable::isKnown" ref="1d3615b28d01c5a84346a63a97b64316" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Variable::isKnown </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns if the variable has a known value (as oppossed to assumptions).<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the variable is of class <a class="el" href="classKnownVariable.html" title="A variable with a known value.">KnownVariable</a>, false if <a class="el" href="classUnknownVariable.html" title="A variable with unknown value.">UnknownVariable</a>. </dd></dl> <p>Implemented in <a class="el" href="classUnknownVariable.html#11e4842430f445c8fce65396929bd8e2">UnknownVariable</a>, and <a class="el" href="classKnownVariable.html#76552c2fc02c6e9c41c9ba10acdc0efc">KnownVariable</a>.</p> </div> </div><p> <a class="anchor" name="4b34b6e7e72601c7915613498ef69744"></a><!-- doxytag: member="Variable::representsPositive" ref="4b34b6e7e72601c7915613498ef69744" args="(bool=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Variable::representsPositive </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> = <code>false</code> </td> <td> ) </td> <td width="100%"><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns if the variable represents a positive value. <p>Reimplemented in <a class="el" href="classUnknownVariable.html#0adc38fa4c8c6e515eee63a2a737ebe2">UnknownVariable</a>, <a class="el" href="classKnownVariable.html#bb6707edd7e47c78b5dba7e840428523">KnownVariable</a>, and <a class="el" href="classDynamicVariable.html#3219611453495b5e6125c2da970077ca">DynamicVariable</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>libqalculate/<a class="el" href="Variable_8h.html">Variable.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>