libdap Updated for version 3.20.8
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
117 dynamic_cast < BaseType & >(*this) = rhs;
118
119 d_buf = rhs.d_buf;
120
121 return *this;
122}
123
124unsigned int Byte::width(bool) const
125{
126 return sizeof(dods_byte);
127}
128
139bool Byte::serialize(ConstraintEvaluator & eval, DDS & dds, Marshaller &m, bool ce_eval)
140{
141#if USE_LOCAL_TIMEOUT_SCHEME
142 dds.timeout_on();
143#endif
144 if (!read_p())
145 read(); // read() throws Error and InternalErr
146
147 if (ce_eval && !eval.eval_selection(dds, dataset()))
148 return true;
149#if USE_LOCAL_TIMEOUT_SCHEME
150 dds.timeout_off();
151#endif
152 m.put_byte( d_buf ) ;
153
154 return true;
155}
156
161{
162 um.get_byte( d_buf ) ;
163
164 return false;
165}
166
167void
169{
170 checksum.AddData(reinterpret_cast<uint8_t*>(&d_buf), sizeof(d_buf));
171}
172
181void
182Byte::serialize(D4StreamMarshaller &m, DMR &, /*ConstraintEvaluator &,*/ bool)
183{
184 if (!read_p())
185 read(); // read() throws Error
186
187 m.put_byte( d_buf ) ;
188}
189
190void
192{
193 um.get_byte( d_buf ) ;
194}
195
201unsigned int Byte::val2buf(void *val, bool)
202{
203 // Jose Garcia
204 // This method is public therefore and I believe it has being designed
205 // to be use by read which must be implemented on the surrogate library,
206 // thus if the pointer val is NULL, is an Internal Error.
207 if (!val)
208 throw InternalErr("the incoming pointer does not contain any data.");
209
210 d_buf = *(dods_byte *) val;
211
212 return width();
213}
214
215unsigned int Byte::buf2val(void **val)
216{
217 // Jose Garcia
218 // The same comment justifying throwing an Error in val2buf applies here.
219 if (!val)
220 throw InternalErr("NULL pointer");
221
222 if (!*val)
223 *val = new dods_byte;
224
225 *(dods_byte *) * val = d_buf;
226
227 return width();
228}
229
234bool Byte::set_value(dods_byte value)
235{
236 d_buf = value;
237 set_read_p(true);
238
239 return true;
240}
241
244dods_byte Byte::value() const
245{
246 return d_buf;
247}
248
249void Byte::print_val(FILE * out, string space, bool print_decl_p)
250{
251 ostringstream oss;
252 print_val(oss, space, print_decl_p);
253 fwrite(oss.str().data(), sizeof(char), oss.str().length(), out);
254}
255
256void Byte::print_val(ostream &out, string space, bool print_decl_p)
257{
258 if (print_decl_p) {
259 print_decl(out, space, false);
260 out << " = " << (int) d_buf << ";\n";
261 }
262 else
263 out << (int) d_buf;
264}
265
266bool Byte::ops(BaseType * b, int op)
267{
268
269 // Extract the Byte arg's value.
270 if (!read_p() && !read()) {
271 // Jose Garcia
272 // Since the read method is virtual and implemented outside
273 // libdap++ if we cannot read the data that is the problem
274 // of the user or of whoever wrote the surrogate library
275 // implementing read therefore it is an internal error.
276 throw InternalErr("This value not read!");
277 }
278 // Extract the second arg's value.
279 if (!b || !(b->read_p() || b->read())) {
280 // Jose Garcia
281 // Since the read method is virtual and implemented outside
282 // libdap++ if we cannot read the data that is the problem
283 // of the user or of whoever wrote the surrogate library
284 // implementing read therefore it is an internal error.
285 throw InternalErr("This value not read!");
286 }
287
288 // By using the same operator code numbers for both the DAP2 and DAP4
289 // parser/evaluator we can use the same evaluation code.
290 return d4_ops(b, op);
291}
292
296bool Byte::d4_ops(BaseType *b, int op)
297{
298 switch (b->type()) {
299 case dods_int8_c:
300 return Cmp<dods_byte, dods_int8>(op, d_buf, static_cast<Int8*>(b)->value());
301 case dods_byte_c:
302 return Cmp<dods_byte, dods_byte>(op, d_buf, static_cast<Byte*>(b)->value());
303 case dods_int16_c:
304 return Cmp<dods_byte, dods_int16>(op, d_buf, static_cast<Int16*>(b)->value());
305 case dods_uint16_c:
306 return Cmp<dods_byte, dods_uint16>(op, d_buf, static_cast<UInt16*>(b)->value());
307 case dods_int32_c:
308 return Cmp<dods_byte, dods_int32>(op, d_buf, static_cast<Int32*>(b)->value());
309 case dods_uint32_c:
310 return Cmp<dods_byte, dods_uint32>(op, d_buf, static_cast<UInt32*>(b)->value());
311 case dods_int64_c:
312 return Cmp<dods_byte, dods_int64>(op, d_buf, static_cast<Int64*>(b)->value());
313 case dods_uint64_c:
314 return Cmp<dods_byte, dods_uint64>(op, d_buf, static_cast<UInt64*>(b)->value());
315 case dods_float32_c:
316 return Cmp<dods_byte, dods_float32>(op, d_buf, static_cast<Float32*>(b)->value());
317 case dods_float64_c:
318 return Cmp<dods_byte, dods_float64>(op, d_buf, static_cast<Float64*>(b)->value());
319 case dods_str_c:
320 case dods_url_c:
321 throw Error(malformed_expr, "Relational operators can only compare compatible types (number, string).");
322 default:
323 throw Error(malformed_expr, "Relational operators only work with scalar types.");
324 }
325}
326
327
328
329
345std::vector<BaseType *> *
347{
348 DBG(cerr << __func__ << "() - BEGIN" << endl;);
349 vector<BaseType *> *vec = BaseType::transform_to_dap2(parent_attr_table);
350 if(vec->size()!=1){
351 ostringstream oss;
352 oss << __func__ << "() - Something Bad Happened. This transform should produce only ";
353 oss << " a single BaseType yet it produced " << vec->size();
354 throw Error(internal_error,oss.str());
355 }
356
357 BaseType *dest = (*vec)[0];
358 DBG(cerr << __func__ << "() - type(): " << type() << endl;);
359 DBG(cerr << __func__ << "() - dest->type(): " << dest->type() << endl;);
360
361 // This little bit of magic ensures that the DAP4 shenanigans
362 // in which UInt8, Char , and Byte are synonymous is reduced
363 // to the DAP2 simplicity of Byte.
364 if(type()!=dods_byte_c){
365 dest->set_type(dods_byte_c);
366 }
367 DBG (dest->get_attr_table().print(cerr););
368
369 DBG(cerr << __func__ << "() - END" << endl;);
370 return vec;
371}
372
381void Byte::dump(ostream & strm) const
382{
383 strm << DapIndent::LMarg << "Byte::dump - ("
384 << (void *) this << ")" << endl;
385 DapIndent::Indent();
386 BaseType::dump(strm);
387 strm << DapIndent::LMarg << "value: " << d_buf << endl;
388 DapIndent::UnIndent();
389}
390
391} // 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.
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:899
virtual AttrTable & get_attr_table()
Definition BaseType.cc:582
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:1003
virtual bool read_p()
Has this variable been read?
Definition BaseType.cc:480
virtual void set_read_p(bool state)
Sets the value of the read_p property.
Definition BaseType.cc:516
virtual string dataset() const
Returns the name of the dataset used to create this instance.
Definition BaseType.cc:358
virtual void dump(ostream &strm) const
dumps information about this object
Definition BaseType.cc:291
virtual void set_type(const Type &t)
Sets the type of the class instance.
Definition BaseType.cc:372
virtual Type type() const
Returns the type of the class instance.
Definition BaseType.cc:365
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition BaseType.cc:259
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:160
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition Byte.cc:346
virtual unsigned int buf2val(void **val)
Reads the class data.
Definition Byte.cc:215
virtual void dump(ostream &strm) const
dumps information about this object
Definition Byte.cc:381
virtual bool d4_ops(BaseType *b, int op)
Definition Byte.cc:296
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:124
virtual void print_val(FILE *out, string space="", bool print_decl_p=true)
Prints the value of the variable.
Definition Byte.cc:249
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:201
virtual dods_byte value() const
Definition Byte.cc:244
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:168
virtual bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval)
Definition Byte.cc:139
virtual bool set_value(const dods_byte value)
Definition Byte.cc:234
virtual bool ops(BaseType *b, int op)
Evaluate relational operators.
Definition Byte.cc:266
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
top level DAP object to house generic methods