ST_Perimeter.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_Perimeter.h
22 
23  \brief Spatial perimeter operator.
24 */
25 
26 #ifndef __TERRALIB_DATAACCESS_INTERNAL_ST_PERIMETER_H
27 #define __TERRALIB_DATAACCESS_INTERNAL_ST_PERIMETER_H
28 
29 // TerraLib
30 #include "Function.h"
31 #include "FunctionNames.h"
32 
33 namespace te
34 {
35 
36  // Forward declarations
37  namespace gm { class Geometry; }
38 
39  namespace da
40  {
41  /*!
42  \class ST_Perimeter
43 
44  \brief Spatial perimeter operator.
45 
46  This function is just a syntatic-suggar.
47 
48  \sa Function
49  */
50  class TEDATAACCESSEXPORT ST_Perimeter : public Function
51  {
52  public:
53 
54  TE_DEFINE_VISITABLE
55 
56  /*!
57  \brief Constructor.
58 
59  \param g The geometry literal.
60  */
61  ST_Perimeter(const te::gm::Geometry& g);
62 
63  /*!
64  \brief Constructor.
65 
66  \param prop The geometry property name.
67  */
68  ST_Perimeter(const te::da::PropertyName& prop);
69 
70  /*!
71  \brief Constructor.
72 
73  \param g The geometry literal.
74  \param p Precision.
75  */
76  ST_Perimeter(const te::gm::Geometry& g, const bool& p);
77 
78  /*!
79  \brief Constructor.
80 
81  \param prop The geometry property name.
82  \param p Precision.
83  */
84  ST_Perimeter(const te::da::PropertyName& prop, const bool& p);
85 
86  /*!
87  \brief Constructor.
88 
89  \param e The expression.
90  */
91  ST_Perimeter(const Expression& e);
92 
93  /*!
94  \brief Constructor.
95 
96  \param e The expression.
97  \param p Precision.
98  */
99  ST_Perimeter(const Expression& e, const bool& p);
100 
101  /*! \brief Destructor. */
102  ~ST_Perimeter();
103 
104  /*! Assignment operator. */
105  ST_Perimeter& operator=(const ST_Perimeter& rhs);
106 
107  /*! \brief It creates a new copy of this expression. */
108  Expression* clone() const;
109  };
110 
111  } // end namespace da
112 } // end namespace te
113 
114 #endif // __TERRALIB_DATAACCESS_INTERNAL_ST_PERIMETER_H
115 
Function.h
A class that models a Function expression.
te::da::PropertyName
A class that models the name of any property of an object.
Definition: PropertyName.h:50
te::da::Expression
This is an abstract class that models a query expression.
Definition: Expression.h:47
te::da::ST_Perimeter
Spatial perimeter operator.
Definition: ST_Perimeter.h:50
te
URI C++ Library.
Definition: AddressGeocodingOp.h:51
te::da::Function
A class that models a Function expression.
Definition: Function.h:47
TE_DEFINE_VISITABLE
#define TE_DEFINE_VISITABLE
Definition: BaseVisitable.h:75
te::gm::Geometry
Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.
Definition: Geometry.h:74
FunctionNames.h
A static class with global function name definitions.
TEDATAACCESSEXPORT
#define TEDATAACCESSEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:97