<!--
* 
*
*  ProLinga-Calc
*
*  Copyright (C) 2002-2008 Xobas Software
*  All rights reserved.
*  
*  This file is part of ProLinga-Calc.
*
*  ProLinga-Calc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Calc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Calc. If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->

<refentry id="prolinga-calc-Expression-Calculator">
  <refmeta>
    <refentrytitle>Expression Calculator</refentrytitle>
    <manvolnum>3</manvolnum>
  <refmiscinfo>ProLinga Calc Library</refmiscinfo>
</refmeta>

<refnamediv>
  <refname>Expression Calculator</refname>
  <refpurpose>Class used to perform C expression calculations.</refpurpose>
</refnamediv>

<refsynopsisdiv>
  <title>Synopsis</title>

  <synopsis>

#include &lt;prolinga/Calc.hpp&gt;

class <anchor id="class_PlCalc"/>PlCalc
{
        public:
                <link linkend="PlCalc">PlCalc</link>();
                ~<link linkend="PlCalc">PlCalc</link>();
                <link linkend="char">char</link>*       <link linkend="PlCalc__getCalc">getCalc</link>          (<link linkend="char">char</link> *expression);
                ...
};
typedef <link linkend="class_PlCalc">PlCalc</link> *PlCalcPtr;

  </synopsis>
</refsynopsisdiv>

<refsect1>
  <title>Description</title>
    <para>
    This class is used to calculate the result of an expression.
    </para>
</refsect1>

<refsect1>
  <title>Details</title>
    <refsect2>
      <title><anchor id="PlCalc__getCalc"/>PlCalc::getCalc ()</title>
        <indexterm>
          <primary>PlCalc::getCalc</primary>
        </indexterm>
        <programlisting><link linkend="char">char</link>*       PlCalc::getCalc                      (<link linkend="char">char</link> *expression);</programlisting>
        <para>
        This function is the calculation expression function. A string containing a calculation expression will be processed
        and the result of this calculation will be returned.
        </para>

        <para>
        </para>
        <variablelist role="params">
          <varlistentry>
            <term><parameter>expression</parameter>&nbsp;:</term>
            <listitem>
              <simpara> the calculation expression string.</simpara>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><emphasis>Returns</emphasis>&nbsp;:</term>
            <listitem>
              <simpara> the result of the expression.</simpara>
            </listitem>
          </varlistentry>
        </variablelist>
    </refsect2>

  </refsect1>
</refentry>
