ST_Contains.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

    TerraLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License,
    or (at your option) any later version.

    TerraLib 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
  \file terralib/dataaccess/query/ST_Contains.h

  \brief Spatial contains operation.
*/

#ifndef __TERRALIB_DATAACCESS_INTERNAL_ST_CONTAINS_H
#define __TERRALIB_DATAACCESS_INTERNAL_ST_CONTAINS_H

// TerraLib
#include "BinaryFunction.h"
#include "FunctionNames.h"

namespace te
{
  namespace da
  {
    /*!
      \class ST_Contains
      
      \brief Spatial contains operator.

      This function is just a syntatic-suggar.

      \sa BinaryFunction
    */
    class TEDATAACCESSEXPORT ST_Contains : public BinaryFunction
    {
      public:

        TE_DEFINE_VISITABLE

        /*!
          \brief Constructor.

          \param arg1 The first argument.
          \param arg2 The second argument.

          \note The operator will take the ownership of the given arguments.
        */
        ST_Contains(Expression* arg1, Expression* arg2) : BinaryFunction(FunctionNames::sm_ST_Contains, arg1, arg2) {}

        /*!
          \brief Constructor.

          \param arg1 The first argument.
          \param arg2 The second argument.

          \note The addition operator will take the ownership of the given arguments.
        */
        ST_Contains(const Expression& arg1, const Expression& arg2) : BinaryFunction(FunctionNames::sm_ST_Contains, arg1, arg2) {}

        /*! \brief Copy constructor. */
        ST_Contains(const ST_Contains& rhs);

        /*! \brief Destructor. */
        ~ST_Contains() {}

        /*! Assignment operator.  */
        ST_Contains& operator=(const ST_Contains& rhs);

        /*! \brief It creates a new copy of this expression. */
        Expression* clone() const;
    };

  } // end namespace da
}   // end namespace te

#endif  // __TERRALIB_DATAACCESS_INTERNAL_ST_CONTAINS_H