DoubleConverters.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/datatype/DoubleConverters.h
22 
23  \brief A set of function that convert a Double type to other types.
24 */
25 
26 #ifndef __TERRALIB_DATATYPE_INTERNAL_DOUBLECONVERTERS_H
27 #define __TERRALIB_DATATYPE_INTERNAL_DOUBLECONVERTERS_H
28 
29 // TerraLib
30 #include "Exception.h"
31 #include "Config.h"
32 
33 namespace te
34 {
35  namespace dt
36  {
37 // Forward declarations
38  class AbstractData;
39 
40  /** @name Double Methods
41  * Methods related to Double conversion.
42  */
43  //@{
44 
45  /*!
46  \brief It converts an Double data value to a char data value.
47 
48  \param d The input data value.
49 
50  \return A new data value converted to char data type. The caller will take the ownership of the returned data.
51 
52  \exception Exception It throws an exception if the input abstract data is not an Double type.
53  */
54  TEDATATYPEEXPORT AbstractData* DoubleToCharConverter(AbstractData* d) ;
55 
56  /*!
57  \brief It converts an Double data value to an unsigned char data value.
58 
59  \param d The input data value.
60 
61  \return A new data value converted to unsigned char data type. The caller will take the ownership of the returned data.
62 
63  \exception Exception It throws an exception if the input abstract data is not an Double type.
64  */
65  TEDATATYPEEXPORT AbstractData* DoubleToUCharConverter(AbstractData* d) ;
66 
67  /*!
68  \brief It converts an Double data value to a Int16 data value.
69 
70  \param d The input data value.
71 
72  \return A new data value converted to Int16 data type. The caller will take the ownership of the returned data.
73 
74  \exception Exception It throws an exception if the input abstract data is not an Double type.
75  */
76  TEDATATYPEEXPORT AbstractData* DoubleToInt16Converter(AbstractData* d) ;
77 
78  /*!
79  \brief It converts an Double data value to an unsigned Int16 data value.
80 
81  \param d The input data value.
82 
83  \return A new data value converted to unsigned Int16 data type. The caller will take the ownership of the returned data.
84 
85  \exception Exception It throws an exception if the input abstract data is not an Double type.
86  */
87  TEDATATYPEEXPORT AbstractData* DoubleToUInt16Converter(AbstractData* d) ;
88 
89  /*!
90  \brief It converts an Double data value to an Int32 data value.
91 
92  \param d The input data value.
93 
94  \return A new data value converted to Int32 data type. The caller will take the ownership of the returned data.
95 
96  \exception Exception It throws an exception if the input abstract data is not an Double type.
97  */
98  TEDATATYPEEXPORT AbstractData* DoubleToInt32Converter(AbstractData* d) ;
99 
100  /*!
101  \brief It converts an Double data value to an unsigned Int32 data value.
102 
103  \param d The input data value.
104 
105  \return A new data value converted to unsigned Int32 data type. The caller will take the ownership of the returned data.
106 
107  \exception Exception It throws an exception if the input abstract data is not an Double type.
108  */
109  TEDATATYPEEXPORT AbstractData* DoubleToUInt32Converter(AbstractData* d) ;
110 
111  /*!
112  \brief It converts an Double data value to a Int64 data value.
113 
114  \param d The input data value.
115 
116  \return A new data value converted to Int64 data type. The caller will take the ownership of the returned data.
117 
118  \exception Exception It throws an exception if the input abstract data is not an Double type.
119  */
120  TEDATATYPEEXPORT AbstractData* DoubleToInt64Converter(AbstractData* d) ;
121 
122  /*!
123  \brief It converts an Double data value to an unsigned Int64 data value.
124 
125  \param d The input data value.
126 
127  \return A new data value converted to unsigned Int64 data type. The caller will take the ownership of the returned data.
128 
129  \exception Exception It throws an exception if the input abstract data is not an Double type.
130  */
131  TEDATATYPEEXPORT AbstractData* DoubleToUInt64Converter(AbstractData* d) ;
132 
133  /*!
134  \brief It converts an Double data value to a boolean data value.
135 
136  \param d The input data value.
137 
138  \return A new data value converted to boolean data type. The caller will take the ownership of the returned data.
139 
140  \exception Exception It throws an exception if the input abstract data is not an Double type.
141  */
142  TEDATATYPEEXPORT AbstractData* DoubleToBooleanConverter(AbstractData* d) ;
143 
144  /*!
145  \brief It converts an Double data value to a float value.
146 
147  \param d The input data value.
148 
149  \return A new data value converted to float data type. The caller will take the ownership of the returned data.
150 
151  \exception Exception It throws an exception if the input abstract data is not an Double type.
152  */
153  TEDATATYPEEXPORT AbstractData* DoubleToFloatConverter(AbstractData* d) ;
154 
155  /*!
156  \brief It converts an Double data value to a double value.
157 
158  \param d The input data value.
159 
160  \return A new data value converted to double data type. The caller will take the ownership of the returned data.
161 
162  \exception Exception It throws an exception if the input abstract data is not an Double type.
163  */
164  TEDATATYPEEXPORT AbstractData* DoubleToDoubleConverter(AbstractData* d) ;
165 
166  /*!
167  \brief It converts an Double data value to Numeric data value.
168 
169  \param d The input data value.
170 
171  \return A new data value converted to Numeric data type. The caller will take the ownership of the returned data.
172 
173  \exception Exception It throws an exception if the input abstract data is not an Double type.
174  */
175  TEDATATYPEEXPORT AbstractData* DoubleToNumericConverter(AbstractData* d) ;
176 
177  /*!
178  \brief It converts an Double data value to a string data value.
179 
180  \param d The input data value.
181 
182  \return A new data value converted to string data type. The caller will take the ownership of the returned data.
183 
184  \exception Exception It throws an exception if the input abstract data is not an Double type.
185  */
186  TEDATATYPEEXPORT AbstractData* DoubleToStringConverter(AbstractData* d) ;
187 
188  /*!
189  \brief Auxiliary method that asserts that the given data is an Double type.
190 
191  \param d The input data value.
192 
193  \exception Exception It throws an exception if the input abstract data is not an Double type.
194  */
195  TEDATATYPEEXPORT void AssertDouble(AbstractData* d) ;
196 
197  //@}
198 
199  } // end namespace dt
200 } // end namespace te
201 
202 #endif // __TERRALIB_DATATYPE_INTERNAL_DOUBLECONVERTERS_H
te::dt::AbstractData
A base class for values that can be retrieved from the data access module.
Definition: AbstractData.h:56
te::dt::DoubleToDoubleConverter
TEDATATYPEEXPORT AbstractData * DoubleToDoubleConverter(AbstractData *d)
It converts an Double data value to a double value.
te::dt::DoubleToInt64Converter
TEDATATYPEEXPORT AbstractData * DoubleToInt64Converter(AbstractData *d)
It converts an Double data value to a Int64 data value.
te::dt::DoubleToUInt64Converter
TEDATATYPEEXPORT AbstractData * DoubleToUInt64Converter(AbstractData *d)
It converts an Double data value to an unsigned Int64 data value.
te::dt::DoubleToStringConverter
TEDATATYPEEXPORT AbstractData * DoubleToStringConverter(AbstractData *d)
It converts an Double data value to a string data value.
te::dt::DoubleToUInt16Converter
TEDATATYPEEXPORT AbstractData * DoubleToUInt16Converter(AbstractData *d)
It converts an Double data value to an unsigned Int16 data value.
te::dt::DoubleToBooleanConverter
TEDATATYPEEXPORT AbstractData * DoubleToBooleanConverter(AbstractData *d)
It converts an Double data value to a boolean data value.
te::dt::DoubleToUCharConverter
TEDATATYPEEXPORT AbstractData * DoubleToUCharConverter(AbstractData *d)
It converts an Double data value to an unsigned char data value.
te::dt::DoubleToNumericConverter
TEDATATYPEEXPORT AbstractData * DoubleToNumericConverter(AbstractData *d)
It converts an Double data value to Numeric data value.
te::dt::DoubleToCharConverter
TEDATATYPEEXPORT AbstractData * DoubleToCharConverter(AbstractData *d)
It converts an Double data value to a char data value.
te::dt::DoubleToUInt32Converter
TEDATATYPEEXPORT AbstractData * DoubleToUInt32Converter(AbstractData *d)
It converts an Double data value to an unsigned Int32 data value.
te::dt::DoubleToFloatConverter
TEDATATYPEEXPORT AbstractData * DoubleToFloatConverter(AbstractData *d)
It converts an Double data value to a float value.
te::dt::DoubleToInt16Converter
TEDATATYPEEXPORT AbstractData * DoubleToInt16Converter(AbstractData *d)
It converts an Double data value to a Int16 data value.
te::dt::AssertDouble
TEDATATYPEEXPORT void AssertDouble(AbstractData *d)
Auxiliary method that asserts that the given data is an Double type.
te::dt::DoubleToInt32Converter
TEDATATYPEEXPORT AbstractData * DoubleToInt32Converter(AbstractData *d)
It converts an Double data value to an Int32 data value.
te
TerraLib.
Definition: AddressGeocodingOp.h:52
TEDATATYPEEXPORT
#define TEDATATYPEEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:61
Config.h
Proxy configuration file for TerraView (see terraview_config.h).
Exception.h
An exception class for the XML module.