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