casacore
Loading...
Searching...
No Matches
CanonicalDataConversion.h
Go to the documentation of this file.
1//# CanonicalDataConversion.h: A class with virtual functions to convert canonical format
2//# Copyright (C) 1996,1999,2001
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: casa-feedback@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25
26#ifndef CASA_CANONICALDATACONVERSION_H
27#define CASA_CANONICALDATACONVERSION_H
28
29//# Includes
30#include <casacore/casa/aips.h>
31#include <casacore/casa/OS/DataConversion.h>
32
33
34namespace casacore { //# NAMESPACE CASACORE - BEGIN
35
36// <summary>
37// A class with virtual functions to convert canonical format.
38// </summary>
39
40// <use visibility=export>
41
42// <reviewed reviewer="Friso Olnon" date="1996/11/06" tests="tDataConversion" demos="">
43// </reviewed>
44
45// <synopsis>
46// This class is a specialization of the abstract base class
47// <linkto class=DataConversion>DataConversion</linkto>.
48// It contains functions to convert data from/to the canonical format
49// using the static functions in class <linkto class=CanonicalConversion>
50// CanonicalConversion</linkto>.
51// </synopsis>
52
53// <example>
54// See example in class <linkto class=DataConversion>DataConversion</linkto>.
55// </example>
56
57// <motivation>
58// This class is an addition to <linkto class=CanonicalConversion>
59// CanonicalConversion</linkto>
60// to be able to use the conversion functions in a polymorphic way.
61// </motivation>
62
63// <todo asof="$DATE$">
64// <li> Support data type long double.
65// </todo>
66
67
69{
70public:
71 // Construct the object.
73
75
76 // Convert one value from canonical format to local format.
77 // The from and to buffer should not overlap.
78 // <group>
79 size_t toLocal (char& to, const void* from) const override;
80 size_t toLocal (unsigned char& to, const void* from) const override;
81 size_t toLocal (short& to, const void* from) const override;
82 size_t toLocal (unsigned short& to, const void* from) const override;
83 size_t toLocal (int& to, const void* from) const override;
84 size_t toLocal (unsigned int& to, const void* from) const override;
85 size_t toLocal (Int64& to, const void* from) const override;
86 size_t toLocal (uInt64& to, const void* from) const override;
87 size_t toLocal (float& to, const void* from) const override;
88 size_t toLocal (double& to, const void* from) const override;
89 // </group>
90
91 // Convert nr values from canonical format to local format.
92 // The from and to buffer should not overlap.
93 // <group>
94 size_t toLocal (char* to, const void* from,
95 size_t nr) const override;
96 size_t toLocal (unsigned char* to, const void* from,
97 size_t nr) const override;
98 size_t toLocal (short* to, const void* from,
99 size_t nr) const override;
100 size_t toLocal (unsigned short* to, const void* from,
101 size_t nr) const override;
102 size_t toLocal (int* to, const void* from,
103 size_t nr) const override;
104 size_t toLocal (unsigned int* to, const void* from,
105 size_t nr) const override;
106 size_t toLocal (Int64* to, const void* from,
107 size_t nr) const override;
108 size_t toLocal (uInt64* to, const void* from,
109 size_t nr) const override;
110 size_t toLocal (float* to, const void* from,
111 size_t nr) const override;
112 size_t toLocal (double* to, const void* from,
113 size_t nr) const override;
114 // </group>
115
116 // Convert one value from local format to canonical format.
117 // The from and to buffer should not overlap.
118 // <group>
119 size_t fromLocal (void* to, char from) const override;
120 size_t fromLocal (void* to, unsigned char from) const override;
121 size_t fromLocal (void* to, short from) const override;
122 size_t fromLocal (void* to, unsigned short from) const override;
123 size_t fromLocal (void* to, int from) const override;
124 size_t fromLocal (void* to, unsigned int from) const override;
125 size_t fromLocal (void* to, Int64 from) const override;
126 size_t fromLocal (void* to, uInt64 from) const override;
127 size_t fromLocal (void* to, float from) const override;
128 size_t fromLocal (void* to, double from) const override;
129 // </group>
130
131 // Convert nr values from local format to canonical format.
132 // The from and to buffer should not overlap.
133 // <group>
134 size_t fromLocal (void* to, const char* from,
135 size_t nr) const override;
136 size_t fromLocal (void* to, const unsigned char* from,
137 size_t nr) const override;
138 size_t fromLocal (void* to, const short* from,
139 size_t nr) const override;
140 size_t fromLocal (void* to, const unsigned short* from,
141 size_t nr) const override;
142 size_t fromLocal (void* to, const int* from,
143 size_t nr) const override;
144 size_t fromLocal (void* to, const unsigned int* from,
145 size_t nr) const override;
146 size_t fromLocal (void* to, const Int64* from,
147 size_t nr) const override;
148 size_t fromLocal (void* to, const uInt64* from,
149 size_t nr) const override;
150 size_t fromLocal (void* to, const float* from,
151 size_t nr) const override;
152 size_t fromLocal (void* to, const double* from,
153 size_t nr) const override;
154 // </group>
155
156 // Determine if the data for a data type can be simply copied, thus
157 // if no conversion is needed.
158 // <group>
159 Bool canCopy (const char*) const override;
160 Bool canCopy (const unsigned char*) const override;
161 Bool canCopy (const short*) const override;
162 Bool canCopy (const unsigned short*) const override;
163 Bool canCopy (const int*) const override;
164 Bool canCopy (const unsigned int*) const override;
165 Bool canCopy (const Int64*) const override;
166 Bool canCopy (const uInt64*) const override;
167 Bool canCopy (const float*) const override;
168 Bool canCopy (const double*) const override;
169 // </group>
170
171 // Get the external size of the data type.
172 // <group>
173 unsigned int externalSize (const char*) const override;
174 unsigned int externalSize (const unsigned char*) const override;
175 unsigned int externalSize (const short*) const override;
176 unsigned int externalSize (const unsigned short*) const override;
177 unsigned int externalSize (const int*) const override;
178 unsigned int externalSize (const unsigned int*) const override;
179 unsigned int externalSize (const Int64*) const override;
180 unsigned int externalSize (const uInt64*) const override;
181 unsigned int externalSize (const float*) const override;
182 unsigned int externalSize (const double*) const override;
183 // </group>
184};
185
186
189
190
191
192} //# NAMESPACE CASACORE - END
193
194#endif
size_t toLocal(float &to, const void *from) const override
size_t fromLocal(void *to, Int64 from) const override
size_t toLocal(char &to, const void *from) const override
Convert one value from canonical format to local format.
size_t toLocal(float *to, const void *from, size_t nr) const override
unsigned int externalSize(const short *) const override
unsigned int externalSize(const Int64 *) const override
unsigned int externalSize(const double *) const override
size_t toLocal(unsigned short *to, const void *from, size_t nr) const override
size_t toLocal(uInt64 &to, const void *from) const override
Bool canCopy(const Int64 *) const override
size_t fromLocal(void *to, const double *from, size_t nr) const override
unsigned int externalSize(const char *) const override
Get the external size of the data type.
size_t fromLocal(void *to, double from) const override
size_t toLocal(unsigned char &to, const void *from) const override
size_t toLocal(unsigned short &to, const void *from) const override
size_t toLocal(unsigned char *to, const void *from, size_t nr) const override
size_t toLocal(short *to, const void *from, size_t nr) const override
size_t fromLocal(void *to, const unsigned short *from, size_t nr) const override
size_t fromLocal(void *to, const short *from, size_t nr) const override
size_t fromLocal(void *to, const char *from, size_t nr) const override
Convert nr values from local format to canonical format.
size_t fromLocal(void *to, const uInt64 *from, size_t nr) const override
size_t toLocal(Int64 *to, const void *from, size_t nr) const override
size_t fromLocal(void *to, const unsigned char *from, size_t nr) const override
size_t fromLocal(void *to, int from) const override
unsigned int externalSize(const int *) const override
size_t toLocal(uInt64 *to, const void *from, size_t nr) const override
size_t toLocal(double &to, const void *from) const override
unsigned int externalSize(const unsigned short *) const override
size_t fromLocal(void *to, const Int64 *from, size_t nr) const override
size_t fromLocal(void *to, unsigned char from) const override
size_t toLocal(unsigned int *to, const void *from, size_t nr) const override
size_t toLocal(Int64 &to, const void *from) const override
Bool canCopy(const short *) const override
size_t toLocal(int *to, const void *from, size_t nr) const override
Bool canCopy(const uInt64 *) const override
size_t fromLocal(void *to, uInt64 from) const override
size_t toLocal(char *to, const void *from, size_t nr) const override
Convert nr values from canonical format to local format.
size_t fromLocal(void *to, short from) const override
Bool canCopy(const char *) const override
Determine if the data for a data type can be simply copied, thus if no conversion is needed.
Bool canCopy(const unsigned int *) const override
size_t fromLocal(void *to, char from) const override
Convert one value from local format to canonical format.
size_t fromLocal(void *to, unsigned int from) const override
Bool canCopy(const float *) const override
unsigned int externalSize(const unsigned int *) const override
Bool canCopy(const unsigned char *) const override
Bool canCopy(const unsigned short *) const override
size_t fromLocal(void *to, const float *from, size_t nr) const override
Bool canCopy(const int *) const override
size_t toLocal(double *to, const void *from, size_t nr) const override
Bool canCopy(const double *) const override
unsigned int externalSize(const float *) const override
size_t toLocal(unsigned int &to, const void *from) const override
size_t fromLocal(void *to, float from) const override
size_t toLocal(int &to, const void *from) const override
size_t fromLocal(void *to, unsigned short from) const override
size_t fromLocal(void *to, const unsigned int *from, size_t nr) const override
size_t fromLocal(void *to, const int *from, size_t nr) const override
unsigned int externalSize(const unsigned char *) const override
size_t toLocal(short &to, const void *from) const override
unsigned int externalSize(const uInt64 *) const override
this file contains all the compiler specific defines
Definition mainpage.dox:28
long long Int64
Define the extra non-standard types used by Casacore (like proposed uSize, Size)
Definition aipsxtype.h:36
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
unsigned long long uInt64
Definition aipsxtype.h:37