DDD_ConvertExpression.h

Go to the documentation of this file.

#ifndef _EXPRESSION_CONVERTER_H_
#define _EXPRESSION_CONVERTER_H_

/*! \file DDD_ConvertExpression.h
  \brief  The DDD_ConvertExpression class.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/


#include "DDD_ConvertBase.h"
#include "DDD_AttributeString.h"
#include "DDD_ConnectionEndpoint.h"
#include "expreval.h"

namespace disti
{

class DDD_EXPORT DDD_ConvertExpression : public DDD_ConvertBase, public DDD_AttributeObserver
{
public:

    /* Function that implements the  DDD_AttributeObserver interface
     * \param attribute  Pointer to the attribute whose value just 
     * changed
     */
    virtual void OnAttributeChanged(DDD_AttributeBase *attribute);

    /** Constructor 
      * \param observer  An attribute observer that will observer the parameters of the converter
      * All converter parameters must use this observer for the converter to work right in the
      * Data Director GUI.
      */
    DDD_ConvertExpression(DDD_AttributeObserver *observer);

    /** Destructor */
    virtual ~DDD_ConvertExpression();
    
    // Overrides from DDD_ConvertBase
    virtual bool Convert(DDD_EndpointList& inputs, DDD_EndpointList& outputs);

    /** \return Returns true if the converter's configuration is valid
      * \param inputs  List of converter inputs 
      * \param outputs  List of converter outputs
      */
    virtual bool ConfigurationValid(DDD_EndpointList& inputs, DDD_EndpointList& outputs);

    /** Initializes the converter, if necessary
      * \param paramString 
      * \return True if the converter was successfully initialized.
      */
    virtual bool Init(const std::string &params);
    
    virtual int MinInputs();
    virtual int MaxInputs();
    virtual int MinOutputs();
    virtual int MaxOutputs();

    /** \return Returns the class name of this converter
      */
    virtual const char* ClassName() { return CONVERT_EXPRESSION_CLASSNAME; }

    /** Used by the GUI to explain what this converter does
      * \return Returns a string for the GUI to use
      */
    virtual const char* Description();

    static const char* CONVERT_EXPRESSION_CLASSNAME; /**< Classname string constant.  Needed by the ConverterFactory */

protected:

    /** Parse the input expression and convert it into a parse tree 
      */
    void ParseExpression();

    /** Evaluate the stored parse tree, updating the inputs
      * \param inputs  The list of inputs for the connnection
      * \param outputs  The list of outputs for the connnection
      */
    virtual void Evaluate(DDD_EndpointList& inputs, DDD_EndpointList& outputs);

    DDD_AttributeString  *_expression;       /**< The C expression to interpret */

    bool                  _expressionValid;  /**< True if the C expression is valid */
    ExprEval::Expression *_parsedExpression; /**< The C expression as a parse tree */
    ExprEval::ValueList  *_vList;            /**< The list of C variables */
};

class DDD_EXPORT DDD_ConvertSubroutine : public DDD_ConvertExpression
{
public:
    /** ctor */
    DDD_ConvertSubroutine(DDD_AttributeObserver *observer);

    static const char* CONVERT_SUBROUTINE_CLASSNAME; /**< Classname string constant.  Needed by the ConverterFactory */

    /** \return Returns the class name of this converter
      */
    virtual const char* ClassName() { return CONVERT_SUBROUTINE_CLASSNAME; }

    /** Used by the GUI to explain what this converter does
      * \return Returns a string for the GUI to use
      */
    virtual const char* Description();

    /** Initializes the converter, if necessary
      * \param paramString 
      * \return True if the converter was successfully initialized.
      */
    virtual bool Init(const std::string &params);

protected:

    /** Evaluate the stored parse tree, updating the inputs
      * \param inputs  The list of inputs for the connnection
      * \param outputs  The list of outputs for the connnection
      */
    virtual void Evaluate(DDD_EndpointList& inputs, DDD_EndpointList& outputs);

    /** Read the inputs to the subroutine
      * \param inputs  The list of inputs for the connnection
      */
    void ReadSubroutineInputs(DDD_EndpointList& inputs);

    /** Write the subroutine outputs to the attributes
      * \param outputs  The list of outputs for the connnection
      */
    void WriteSubroutineOutputs(DDD_EndpointList& outputs);


};

}   // end namespace disti
#endif