ST_Relate.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/dataaccess/query/ST_Relate.h
22 
23  \brief Spatial relation function.
24 */
25 
26 #ifndef __TERRALIB_DATAACCESS_INTERNAL_ST_RELATE_H
27 #define __TERRALIB_DATAACCESS_INTERNAL_ST_RELATE_H
28 
29 // TerraLib
30 #include "Function.h"
31 
32 namespace te
33 {
34  namespace da
35  {
36 // Forward declarations
37  class LiteralString;
38 
39  /*!
40  \class ST_Relate
41 
42  \brief Spatial relation function.
43 
44  This function is just a syntatic-suggar.
45 
46  \sa Function
47  */
49  {
50  public:
51 
53 
54  /*!
55  \brief Constructor.
56 
57  \param g1 The first geometric argument.
58  \param g2 The second geometric argument.
59  \param intersectionMatrix A intersection matrix.
60 
61  \note The third parameter is optional. If omitted the function result is a intersection matrix otherwise the result is a boolean.
62 
63  \note The operator will take the ownership of the given arguments.
64  */
65  ST_Relate(Expression* g1, Expression* g2, LiteralString* intersectionMatrix = 0);
66 
67  /*!
68  \brief Constructor.
69 
70  \param g1 The first geometric argument.
71  \param g2 The second geometric argument.
72  \param intersectionMatrix A intersection matrix.
73 
74  \note The third parameter is optional. If omitted the function result is a intersection matrix otherwise the result is a boolean.
75  */
76  ST_Relate(const Expression& g1, const Expression& g2, const std::string& intersectionMatrix = std::string(""));
77 
78  /*! \brief Copy constructor. */
79  ST_Relate(const ST_Relate& rhs);
80 
81  /*! \brief Destructor. */
83 
84  /*! Assignment operator. */
85  ST_Relate& operator=(const ST_Relate& rhs);
86 
87  /*! \brief It creates a new copy of this expression. */
88  Expression* clone() const;
89  };
90 
91  } // end namespace da
92 } // end namespace te
93 
94 #endif // __TERRALIB_DATAACCESS_INTERNAL_ST_RELATE_H
95 
A class that models a Function expression.
This is an abstract class that models a query expression.
Definition: Expression.h:47
TerraLib.
A class that models a Function expression.
Definition: Function.h:47
#define TE_DEFINE_VISITABLE
Definition: BaseVisitable.h:75
~ST_Relate()
Destructor.
Definition: ST_Relate.h:82
Spatial relation function.
Definition: ST_Relate.h:48
#define TEDATAACCESSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:97
This class models a string Literal value.
Definition: LiteralString.h:46