libdap Updated for version 3.20.11
libdap4 is an implementation of OPeNDAP's DAP protocol.
Byte.cc
1
2// -*- mode: c++; c-basic-offset:4 -*-
3
4// This file is part of libdap, A C++ implementation of the OPeNDAP Data
5// Access Protocol.
6
7// Copyright (c) 2002,2003 OPeNDAP, Inc.
8// Author: James Gallagher <jgallagher@opendap.org>
9//
10// This library is free software; you can redistribute it and/or
11// modify it under the terms of the GNU Lesser General Public
12// License as published by the Free Software Foundation; either
13// version 2.1 of the License, or (at your option) any later version.
14//
15// This library is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18// Lesser General Public License for more details.
19//
20// You should have received a copy of the GNU Lesser General Public
21// License along with this library; if not, write to the Free Software
22// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23//
24// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
25
26// (c) COPYRIGHT URI/MIT 1994-1999
27// Please read the full copyright statement in the file COPYRIGHT_URI.
28//
29// Authors:
30// jhrg,jimg James Gallagher <jgallagher@gso.uri.edu>
31
32// Implementation for Byte.
33//
34// jhrg 9/7/94
35
36//#define DODS_DEBUG
37
38#include "config.h"
39
40#include <sstream>
41
42#include "Byte.h" // synonymous with UInt8 and Char
43#include "Int8.h"
44#include "Int16.h"
45#include "UInt16.h"
46#include "Int32.h"
47#include "UInt32.h"
48#include "Int64.h"
49#include "UInt64.h"
50#include "Float32.h"
51#include "Float64.h"
52#include "Str.h"
53#include "Url.h"
54
55#include "DDS.h"
56#include "Operators.h"
57#include "Marshaller.h"
58#include "UnMarshaller.h"
59
60#include "DMR.h"
61#include "D4Attributes.h"
62#include "D4StreamMarshaller.h"
63#include "D4StreamUnMarshaller.h"
64
65#include "debug.h"
66#include "util.h"
67#include "parser.h"
68#include "dods-limits.h"
69#include "InternalErr.h"
70#include "DapIndent.h"
71
72using std::cerr;
73using std::endl;
74
75namespace libdap {
76
86Byte::Byte(const string & n): BaseType(n, dods_byte_c), d_buf(0)
87{}
88
99Byte::Byte(const string &n, const string &d): BaseType(n, d, dods_byte_c), d_buf(0)
100{}
101
102Byte::Byte(const Byte & copy_from): BaseType(copy_from)
103{
104 d_buf = copy_from.d_buf;
105}
106
108{
109 return new Byte(*this);
110}
111
112Byte & Byte::operator=(const Byte & rhs)
113{
114 if (this == &rhs)
115 return *this;
116 BaseType::operator=(rhs);
117 d_buf = rhs.d_buf;
118 return *this;
119}
120
121unsigned int Byte::width(bool) const
122{
123 return sizeof(dods_byte);
124}
125
136bool Byte::serialize(ConstraintEvaluator & eval, DDS & dds, Marshaller &m, bool ce_eval)
137{
138#if USE_LOCAL_TIMEOUT_SCHEME
139 dds.timeout_on();
140#endif
141 if (!read_p())
142 read(); // read() throws Error and InternalErr
143
144 if (ce_eval && !eval.eval_selection(dds, dataset()))
145 return true;
146#if USE_LOCAL_TIMEOUT_SCHEME
147 dds.timeout_off();
148#endif
149 m.put_byte( d_buf ) ;
150
151 return true;
152}
153
158{
159 um.get_byte( d_buf ) ;
160
161 return false;
162}
163
164void
166{
167 checksum.AddData(reinterpret_cast<uint8_t*>(&d_buf), sizeof(d_buf));
168}
169
178void
179Byte::serialize(D4StreamMarshaller &m, DMR &, /*ConstraintEvaluator &,*/ bool)
180{
181 if (!read_p())
182 read(); // read() throws Error
183
184 m.put_byte( d_buf ) ;
185}
186
187void
189{
190 um.get_byte( d_buf ) ;
191}
192
198unsigned int Byte::val2buf(void *val, bool)
199{
200 // Jose Garcia
201 // This method is public therefore and I believe it has being designed
202 // to be use by read which must be implemented on the surrogate library,
203 // thus if the pointer val is NULL, is an Internal Error.
204 if (!val)
205 throw InternalErr("the incoming pointer does not contain any data.");
206
207 d_buf = *(dods_byte *) val;
208
209 return width();
210}
211
212unsigned int Byte::buf2val(void **val)
213{
214 // Jose Garcia
215 // The same comment justifying throwing an Error in val2buf applies here.
216 if (!val)
217 throw InternalErr("NULL pointer");
218
219 if (!*val)
220 *val = new dods_byte;
221
222 *(dods_byte *) * val = d_buf;
223
224 return width();
225}
226
231bool Byte::set_value(dods_byte value)
232{
233 d_buf = value;
234 set_read_p(true);
235
236 return true;
237}
238
241dods_byte Byte::value() const
242{
243 return d_buf;
244}
245
246void Byte::print_val(FILE * out, string space, bool print_decl_p)
247{
248 ostringstream oss;
249 print_val(oss, space, print_decl_p);
250 fwrite(oss.str().data(), sizeof(char), oss.str().length(), out);
251}
252
253void Byte::print_val(ostream &out, string space, bool print_decl_p)
254{
255 if (print_decl_p) {
256 print_decl(out, space, false);
257 out << " = " << (int) d_buf << ";\n";
258 }
259 else
260 out << (int) d_buf;
261}
262
263bool Byte::ops(BaseType * b, int op)
264{
265
266 // Extract the Byte arg's value.
267 if (!read_p() && !read()) {
268 // Jose Garcia
269 // Since the read method is virtual and implemented outside
270 // libdap++ if we cannot read the data that is the problem
271 // of the user or of whoever wrote the surrogate library
272 // implementing read therefore it is an internal error.
273 throw InternalErr("This value not read!");
274 }
275 // Extract the second arg's value.
276 if (!b || !(b->read_p() || b->read())) {
277 // Jose Garcia
278 // Since the read method is virtual and implemented outside
279 // libdap++ if we cannot read the data that is the problem
280 // of the user or of whoever wrote the surrogate library
281 // implementing read therefore it is an internal error.
282 throw InternalErr("This value not read!");
283 }
284
285 // By using the same operator code numbers for both the DAP2 and DAP4
286 // parser/evaluator we can use the same evaluation code.
287 return d4_ops(b, op);
288}
289
293bool Byte::d4_ops(BaseType *b, int op)
294{
295 switch (b->type()) {
296 case dods_int8_c:
297 return Cmp<dods_byte, dods_int8>(op, d_buf, static_cast<Int8*>(b)->value());
298 case dods_byte_c:
299 return Cmp<dods_byte, dods_byte>(op, d_buf, static_cast<Byte*>(b)->value());
300 case dods_int16_c:
301 return Cmp<dods_byte, dods_int16>(op, d_buf, static_cast<Int16*>(b)->value());
302 case dods_uint16_c:
303 return Cmp<dods_byte, dods_uint16>(op, d_buf, static_cast<UInt16*>(b)->value());
304 case dods_int32_c:
305 return Cmp<dods_byte, dods_int32>(op, d_buf, static_cast<Int32*>(b)->value());
306 case dods_uint32_c:
307 return Cmp<dods_byte, dods_uint32>(op, d_buf, static_cast<UInt32*>(b)->value());
308 case dods_int64_c:
309 return Cmp<dods_byte, dods_int64>(op, d_buf, static_cast<Int64*>(b)->value());
310 case dods_uint64_c:
311 return Cmp<dods_byte, dods_uint64>(op, d_buf, static_cast<UInt64*>(b)->value());
312 case dods_float32_c:
313 return Cmp<dods_byte, dods_float32>(op, d_buf, static_cast<Float32*>(b)->value());
314 case dods_float64_c:
315 return Cmp<dods_byte, dods_float64>(op, d_buf, static_cast<Float64*>(b)->value());
316 case dods_str_c:
317 case dods_url_c:
318 throw Error(malformed_expr, "Relational operators can only compare compatible types (number, string).");
319 default:
320 throw Error(malformed_expr, "Relational operators only work with scalar types.");
321 }
322}
323
324
325
326
342std::vector<BaseType *> *
344{
345 DBG(cerr << __func__ << "() - BEGIN" << endl;);
346 vector<BaseType *> *vec = BaseType::transform_to_dap2(parent_attr_table);
347 if(vec->size()!=1){
348 ostringstream oss;
349 oss << __func__ << "() - Something Bad Happened. This transform should produce only ";
350 oss << " a single BaseType yet it produced " << vec->size();
351 throw Error(internal_error,oss.str());
352 }
353
354 BaseType *dest = (*vec)[0];
355 DBG(cerr << __func__ << "() - type(): " << type() << endl;);
356 DBG(cerr << __func__ << "() - dest->type(): " << dest->type() << endl;);
357
358 // This little bit of magic ensures that the DAP4 shenanigans
359 // in which UInt8, Char , and Byte are synonymous is reduced
360 // to the DAP2 simplicity of Byte.
361 if(type()!=dods_byte_c){
362 dest->set_type(dods_byte_c);
363 }
364 DBG (dest->get_attr_table().print(cerr););
365
366 DBG(cerr << __func__ << "() - END" << endl;);
367 return vec;
368}
369
378void Byte::dump(ostream & strm) const
379{
380 strm << DapIndent::LMarg << "Byte::dump - ("
381 << (void *) this << ")" << endl;
382 DapIndent::Indent();
383 BaseType::dump(strm);
384 strm << DapIndent::LMarg << "value: " << d_buf << endl;
385 DapIndent::UnIndent();
386}
387
388} // namespace libdap
Definition: crc.h:77
void AddData(const uint8_t *pData, const uint32_t length)
Definition: crc.h:98
Contains the attributes for a dataset.
Definition: AttrTable.h:143
virtual void print(FILE *out, string pad=" ", bool dereference=false)
Prints the attribute table.
Definition: AttrTable.cc:1243
The basic data type for the DODS DAP types.
Definition: BaseType.h:118
virtual bool read()
Read data into a local buffer.
Definition: BaseType.cc:895
virtual AttrTable & get_attr_table()
Definition: BaseType.cc:578
virtual void print_decl(FILE *out, string space=" ", bool print_semi=true, bool constraint_info=false, bool constrained=false)
Print an ASCII representation of the variable structure.
Definition: BaseType.cc:999
virtual bool read_p()
Has this variable been read?
Definition: BaseType.cc:476
virtual void set_read_p(bool state)
Sets the value of the read_p property.
Definition: BaseType.cc:512
virtual string dataset() const
Returns the name of the dataset used to create this instance.
Definition: BaseType.cc:354
void dump(ostream &strm) const override
dumps information about this object
Definition: BaseType.cc:287
virtual void set_type(const Type &t)
Sets the type of the class instance.
Definition: BaseType.cc:368
virtual Type type() const
Returns the type of the class instance.
Definition: BaseType.cc:361
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition: BaseType.cc:255
Holds a single byte.
Definition: Byte.h:61
virtual bool deserialize(UnMarshaller &um, DDS *, bool)
Deserialize the char on stdin and put the result in _BUF.
Definition: Byte.cc:157
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition: Byte.cc:343
virtual unsigned int buf2val(void **val)
Reads the class data.
Definition: Byte.cc:212
virtual void dump(ostream &strm) const
dumps information about this object
Definition: Byte.cc:378
virtual bool d4_ops(BaseType *b, int op)
Definition: Byte.cc:293
virtual unsigned int width(bool constrained=false) const
How many bytes does this variable use Return the number of bytes of storage this variable uses....
Definition: Byte.cc:121
virtual void print_val(FILE *out, string space="", bool print_decl_p=true)
Prints the value of the variable.
Definition: Byte.cc:246
virtual BaseType * ptr_duplicate()
Definition: Byte.cc:107
Byte(const string &n)
The Byte constructor.
Definition: Byte.cc:86
virtual unsigned int val2buf(void *val, bool reuse=false)
Definition: Byte.cc:198
virtual dods_byte value() const
Definition: Byte.cc:241
virtual void compute_checksum(Crc32 &checksum)
include the data for this variable in the checksum DAP4 includes a checksum with every data response....
Definition: Byte.cc:165
virtual bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval)
Definition: Byte.cc:136
virtual bool set_value(const dods_byte value)
Definition: Byte.cc:231
virtual bool ops(BaseType *b, int op)
Evaluate relational operators.
Definition: Byte.cc:263
Evaluate a constraint expression.
bool eval_selection(DDS &dds, const std::string &dataset)
Evaluate a boolean-valued constraint expression. This is main method for the evaluator and is called ...
Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4's receiv...
Read data from the stream made by D4StreamMarshaller.
A class for error processing.
Definition: Error.h:94
Holds a 32-bit floating point value.
Definition: Float32.h:62
Holds a 64-bit (double precision) floating point value.
Definition: Float64.h:61
Holds a 16-bit signed integer value.
Definition: Int16.h:60
Holds a 32-bit signed integer.
Definition: Int32.h:66
Holds a64-bit signed integer.
Definition: Int64.h:50
Holds an 8-bit signed integer value.
Definition: Int8.h:43
A class for software fault reporting.
Definition: InternalErr.h:65
abstract base class used to marshal/serialize dap data objects
Definition: Marshaller.h:50
Holds an unsigned 16-bit integer.
Definition: UInt16.h:58
Holds a 32-bit unsigned integer.
Definition: UInt32.h:60
Holds a 64-bit unsigned integer.
Definition: UInt64.h:50
abstract base class used to unmarshall/deserialize dap data objects
Definition: UnMarshaller.h:55
top level DAP object to house generic methods
Definition: AlarmHandler.h:36