source: XIOS/trunk/src/parse_expr/filter_expr_node.hpp @ 895

#ifndef __XIOS_FILTER_EXPR_NODE_HPP__
#define __XIOS_FILTER_EXPR_NODE_HPP__

#include <string>
#include <boost/shared_ptr.hpp>
#include <boost/smart_ptr/scoped_ptr.hpp>
#include "scalar_expr_node.hpp"

namespace xios
{
  class COutputPin;
  class CGarbageCollector;
  class CField;

  /*!
   * Interface implemented by all the nodes of a tree representing an expression
   * which can be transformed into a filter graph representation.
   */
  struct IFilterExprNode 
  {
    /*!
     * Builds a filter graph corresponding to the expression tree.
     *
     * \param gc the garbage collector to associated with the filter graph
     * \param thisField the field to which the expression is attached
     * \return the output pin of the filter producing the result of the expression 
     */
    virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const = 0;
  };

  /*!
   * Expression node corresponding to a field.
   */
  class CFilterFieldExprNode : public IFilterExprNode
  {
    public:
      /*!
       * Constructs an expression node corresponding
       * to the field whose id is provided.
       *
       * \param fieldId the identifier of the field
       */
      CFilterFieldExprNode(const std::string& fieldId);

      virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const;

    private:
      std::string fieldId; //!< The identifier of the field
  };

  /*!
   * Expression node corresponding to a field for which the result of
   * the temporal operation is requested instead of the instant value.
   */
  class CFilterTemporalFieldExprNode : public IFilterExprNode
  {
    public:
      /*!
       * Constructs an expression node corresponding
       * to the field whose id is provided.
       *
       * \param fieldId the identifier of the field
       */
      CFilterTemporalFieldExprNode(const std::string& fieldId);

      virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const;

    private:
      std::string fieldId; //!< The identifier of the field
  };

  /*!
   * Expression node corresponding to a unary operation on a field.
   */
  class CFilterUnaryOpExprNode : public IFilterExprNode
  {
    public:
      /*!
       * Constructs an expression node corresponding to the specified unary operation
       * applied to the provided child node.
       * Note that the child node will be destroyed automatically when the parent node
       * is destroyed.
       *
       * \param opId the identifier of the operator
       * \param child the child node to which the operator is applied
       */
      CFilterUnaryOpExprNode(const std::string& opId, IFilterExprNode* child);

      virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const;

    private:
      std::string opId; //!< The identifier of the field
      boost::scoped_ptr<IFilterExprNode> child; //!< The child node to which the operator is applied
  };

  /*!
   * Expression node corresponding to a binary operation on a scalar and a field.
   */
  class CFilterScalarFieldOpExprNode : public IFilterExprNode
  {
    public:
      /*!
       * Constructs an expression node corresponding to the specified binary operation
       * applied to the provided scalar and field child nodes.
       * Note that the child nodes will be destroyed automatically when the parent node
       * is destroyed.
       *
       * \param child1 the scalar child node to which the operator is applied
       * \param opId the identifier of the operator
       * \param child2 the field child node to which the operator is applied
       */
      CFilterScalarFieldOpExprNode(IScalarExprNode* child1, const std::string& opId, IFilterExprNode* child2);

      virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const;

    private:
      std::string opId; //!< The identifier of the field
      boost::scoped_ptr<IScalarExprNode> child1; //!< The scalar child node to which the operator is applied
      boost::scoped_ptr<IFilterExprNode> child2; //!< The field child node to which the operator is applied
  };

  /*!
   * Expression node corresponding to a binary operation on a field and a scalar.
   */
  class CFilterFieldScalarOpExprNode : public IFilterExprNode
  {
    public:
      /*!
       * Constructs an expression node corresponding to the specified binary operation
       * applied to the provided field and scalar child nodes.
       * Note that the child nodes will be destroyed automatically when the parent node
       * is destroyed.
       *
       * \param child1 the field child node to which the operator is applied
       * \param opId the identifier of the operator
       * \param child2 the scalar child node to which the operator is applied
       */
      CFilterFieldScalarOpExprNode(IFilterExprNode* child1, const std::string& opId, IScalarExprNode* child2);

      virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const;

    private:
      std::string opId; //!< The identifier of the field
      boost::scoped_ptr<IFilterExprNode> child1; //!< The field child node to which the operator is applied
      boost::scoped_ptr<IScalarExprNode> child2; //!< The scalar child node to which the operator is applied
  };

  /*!
   * Expression node corresponding to a binary operation on two fields.
   */
  class CFilterFieldFieldOpExprNode : public IFilterExprNode
  {
    public:
      /*!
       * Constructs an expression node corresponding to the specified binary operation
       * applied to the provided field child nodes.
       * Note that the child nodes will be destroyed automatically when the parent node
       * is destroyed.
       *
       * \param opId the identifier of the operator
       * \param child1, child2 the field child nodes to which the operator is applied
       */
      CFilterFieldFieldOpExprNode(IFilterExprNode* child1, const std::string& opId, IFilterExprNode* child2);

      virtual boost::shared_ptr<COutputPin> reduce(CGarbageCollector& gc, CField& thisField) const;

    private:
      std::string opId; //!< The identifier of the field
      boost::scoped_ptr<IFilterExprNode> child1, child2; //!< The field child nodes to which the operator is applied
  };
}

#endif // __XIOS_FILTER_EXPR_NODE_HPP__