libdap  Updated for version 3.19.1
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 
71 using std::cerr;
72 using std::endl;
73 
74 namespace libdap {
75 
85 Byte::Byte(const string & n): BaseType(n, dods_byte_c), d_buf(0)
86 {}
87 
98 Byte::Byte(const string &n, const string &d): BaseType(n, d, dods_byte_c), d_buf(0)
99 {}
100 
101 Byte::Byte(const Byte & copy_from): BaseType(copy_from)
102 {
103  d_buf = copy_from.d_buf;
104 }
105 
107 {
108  return new Byte(*this);
109 }
110 
111 Byte & Byte::operator=(const Byte & rhs)
112 {
113  if (this == &rhs)
114  return *this;
115 
116  dynamic_cast < BaseType & >(*this) = rhs;
117 
118  d_buf = rhs.d_buf;
119 
120  return *this;
121 }
122 
123 unsigned int Byte::width(bool) const
124 {
125  return sizeof(dods_byte);
126 }
127 
138 bool Byte::serialize(ConstraintEvaluator & eval, DDS & dds, Marshaller &m, bool ce_eval)
139 {
140 #if USE_LOCAL_TIMEOUT_SCHEME
141  dds.timeout_on();
142 #endif
143  if (!read_p())
144  read(); // read() throws Error and InternalErr
145 
146  if (ce_eval && !eval.eval_selection(dds, dataset()))
147  return true;
148 #if USE_LOCAL_TIMEOUT_SCHEME
149  dds.timeout_off();
150 #endif
151  m.put_byte( d_buf ) ;
152 
153  return true;
154 }
155 
160 {
161  um.get_byte( d_buf ) ;
162 
163  return false;
164 }
165 
166 void
168 {
169  checksum.AddData(reinterpret_cast<uint8_t*>(&d_buf), sizeof(d_buf));
170 }
171 
180 void
181 Byte::serialize(D4StreamMarshaller &m, DMR &, /*ConstraintEvaluator &,*/ bool)
182 {
183  if (!read_p())
184  read(); // read() throws Error
185 
186  m.put_byte( d_buf ) ;
187 }
188 
189 void
191 {
192  um.get_byte( d_buf ) ;
193 }
194 
200 unsigned int Byte::val2buf(void *val, bool)
201 {
202  // Jose Garcia
203  // This method is public therefore and I believe it has being designed
204  // to be use by read which must be implemented on the surrogate library,
205  // thus if the pointer val is NULL, is an Internal Error.
206  if (!val)
207  throw InternalErr("the incoming pointer does not contain any data.");
208 
209  d_buf = *(dods_byte *) val;
210 
211  return width();
212 }
213 
214 unsigned int Byte::buf2val(void **val)
215 {
216  // Jose Garcia
217  // The same comment justifying throwing an Error in val2buf applies here.
218  if (!val)
219  throw InternalErr("NULL pointer");
220 
221  if (!*val)
222  *val = new dods_byte;
223 
224  *(dods_byte *) * val = d_buf;
225 
226  return width();
227 }
228 
233 bool Byte::set_value(dods_byte value)
234 {
235  d_buf = value;
236  set_read_p(true);
237 
238  return true;
239 }
240 
243 dods_byte Byte::value() const
244 {
245  return d_buf;
246 }
247 
248 void Byte::print_val(FILE * out, string space, bool print_decl_p)
249 {
250  ostringstream oss;
251  print_val(oss, space, print_decl_p);
252  fwrite(oss.str().data(), sizeof(char), oss.str().length(), out);
253 }
254 
255 void Byte::print_val(ostream &out, string space, bool print_decl_p)
256 {
257  if (print_decl_p) {
258  print_decl(out, space, false);
259  out << " = " << (int) d_buf << ";\n";
260  }
261  else
262  out << (int) d_buf;
263 }
264 
265 bool Byte::ops(BaseType * b, int op)
266 {
267 
268  // Extract the Byte arg's value.
269  if (!read_p() && !read()) {
270  // Jose Garcia
271  // Since the read method is virtual and implemented outside
272  // libdap++ if we cannot read the data that is the problem
273  // of the user or of whoever wrote the surrogate library
274  // implementing read therefore it is an internal error.
275  throw InternalErr("This value not read!");
276  }
277  // Extract the second arg's value.
278  if (!b || !(b->read_p() || b->read())) {
279  // Jose Garcia
280  // Since the read method is virtual and implemented outside
281  // libdap++ if we cannot read the data that is the problem
282  // of the user or of whoever wrote the surrogate library
283  // implementing read therefore it is an internal error.
284  throw InternalErr("This value not read!");
285  }
286 
287  // By using the same operator code numbers for both the DAP2 and DAP4
288  // parser/evaluator we can use the same evaluation code.
289  return d4_ops(b, op);
290 }
291 
295 bool Byte::d4_ops(BaseType *b, int op)
296 {
297  switch (b->type()) {
298  case dods_int8_c:
299  return USCmp<dods_byte, dods_int8>(op, d_buf, static_cast<Int8*>(b)->value());
300  case dods_byte_c:
301  return Cmp<dods_byte, dods_byte>(op, d_buf, static_cast<Byte*>(b)->value());
302  case dods_int16_c:
303  return USCmp<dods_byte, dods_int16>(op, d_buf, static_cast<Int16*>(b)->value());
304  case dods_uint16_c:
305  return Cmp<dods_byte, dods_uint16>(op, d_buf, static_cast<UInt16*>(b)->value());
306  case dods_int32_c:
307  return USCmp<dods_byte, dods_int32>(op, d_buf, static_cast<Int32*>(b)->value());
308  case dods_uint32_c:
309  return Cmp<dods_byte, dods_uint32>(op, d_buf, static_cast<UInt32*>(b)->value());
310  case dods_int64_c:
311  return USCmp<dods_byte, dods_int64>(op, d_buf, static_cast<Int64*>(b)->value());
312  case dods_uint64_c:
313  return Cmp<dods_byte, dods_uint64>(op, d_buf, static_cast<UInt64*>(b)->value());
314  case dods_float32_c:
315  return USCmp<dods_byte, dods_float32>(op, d_buf, static_cast<Float32*>(b)->value());
316  case dods_float64_c:
317  return USCmp<dods_byte, dods_float64>(op, d_buf, static_cast<Float64*>(b)->value());
318  case dods_str_c:
319  case dods_url_c:
320  throw Error(malformed_expr, "Relational operators can only compare compatible types (number, string).");
321  default:
322  throw Error(malformed_expr, "Relational operators only work with scalar types.");
323  }
324 }
325 
326 
327 
328 
344 std::vector<BaseType *> *
346 {
347  DBG(cerr << __func__ << "() - BEGIN" << endl;);
348  vector<BaseType *> *vec = BaseType::transform_to_dap2(parent_attr_table);
349  if(vec->size()!=1){
350  ostringstream oss;
351  oss << __func__ << "() - Something Bad Happened. This transform should produce only ";
352  oss << " a single BaseType yet it produced " << vec->size();
353  throw new Error(internal_error,oss.str());
354  }
355 
356  BaseType *dest = (*vec)[0];
357  DBG(cerr << __func__ << "() - type(): " << type() << endl;);
358  DBG(cerr << __func__ << "() - dest->type(): " << dest->type() << endl;);
359 
360  // This little bit of magic ensures that the DAP4 shenanigans
361  // in which UInt8, Char , and Byte are synonymous is reduced
362  // to the DAP2 simplicity of Byte.
363  if(type()!=dods_byte_c){
364  dest->set_type(dods_byte_c);
365  }
366  DBG (dest->get_attr_table().print(cerr););
367 
368  DBG(cerr << __func__ << "() - END" << endl;);
369  return vec;
370 }
371 
380 void Byte::dump(ostream & strm) const
381 {
382  strm << DapIndent::LMarg << "Byte::dump - ("
383  << (void *) this << ")" << endl;
384  DapIndent::Indent();
385  BaseType::dump(strm);
386  strm << DapIndent::LMarg << "value: " << d_buf << endl;
387  DapIndent::UnIndent();
388 }
389 
390 } // namespace libdap
virtual bool read()
Read data into a local buffer.
Definition: BaseType.cc:890
Holds an 8-bit signed integer value.
Definition: Int8.h:42
Holds a64-bit signed integer.
Definition: Int64.h:49
virtual bool read_p()
Has this variable been read?
Definition: BaseType.cc:471
abstract base class used to unmarshall/deserialize dap data objects
Definition: UnMarshaller.h:54
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition: Byte.cc:345
virtual unsigned int buf2val(void **val)
Reads the class data.
Definition: Byte.cc:214
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:994
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BaseType.cc:282
Contains the attributes for a dataset.
Definition: AttrTable.h:142
virtual bool deserialize(UnMarshaller &um, DDS *, bool)
Deserialize the char on stdin and put the result in _BUF.
Definition: Byte.cc:159
Byte(const string &n)
The Byte constructor.
Definition: Byte.cc:85
virtual bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval)
Definition: Byte.cc:138
Read data from the stream made by D4StreamMarshaller.
Holds an unsigned 16-bit integer.
Definition: UInt16.h:57
Definition: crc.h:76
virtual dods_byte value() const
Definition: Byte.cc:243
virtual void print(FILE *out, string pad=" ", bool dereference=false)
Prints the attribute table.
Definition: AttrTable.cc:1242
Holds a 32-bit floating point value.
Definition: Float32.h:61
A class for software fault reporting.
Definition: InternalErr.h:64
virtual unsigned int val2buf(void *val, bool reuse=false)
Definition: Byte.cc:200
Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4&#39;s receiv...
Holds a 16-bit signed integer value.
Definition: Int16.h:59
virtual Type type() const
Returns the type of the class instance.
Definition: BaseType.cc:356
virtual bool d4_ops(BaseType *b, int op)
Definition: Byte.cc:295
virtual void set_type(const Type &t)
Sets the type of the class instance.
Definition: BaseType.cc:363
virtual void set_read_p(bool state)
Sets the value of the read_p property.
Definition: BaseType.cc:507
virtual bool set_value(const dods_byte value)
Definition: Byte.cc:233
virtual unsigned int width(bool constrained=false) const
How many bytes does this use Return the number of bytes of storage this variable uses. For scalar types, this is pretty simple (an int32 uses 4 bytes, etc.). For arrays and Constructors, it is a bit more complex. Note that a scalar String variable uses sizeof(String*) bytes, not the length of the string. In other words, the value returned is independent of the type. Also note width() of a String array returns the number of elements in the array times sizeof(String*). That is, each different array size is a different data type.
Definition: Byte.cc:123
Holds a 64-bit unsigned integer.
Definition: UInt64.h:49
void AddData(const uint8_t *pData, const uint32_t length)
Definition: crc.h:98
virtual void print_val(FILE *out, string space="", bool print_decl_p=true)
Prints the value of the variable.
Definition: Byte.cc:248
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition: BaseType.cc:258
Evaluate a constraint expression.
virtual AttrTable & get_attr_table()
Definition: BaseType.cc:573
The basic data type for the DODS DAP types.
Definition: BaseType.h:117
abstract base class used to marshal/serialize dap data objects
Definition: Marshaller.h:50
Holds a 64-bit (double precision) floating point value.
Definition: Float64.h:60
Holds a single byte.
Definition: Byte.h:60
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 ...
virtual bool ops(BaseType *b, int op)
Evaluate relational operators.
Definition: Byte.cc:265
A class for error processing.
Definition: Error.h:90
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:167
Holds a 32-bit unsigned integer.
Definition: UInt32.h:59
virtual void dump(ostream &strm) const
dumps information about this object
Definition: Byte.cc:380
Holds a 32-bit signed integer.
Definition: Int32.h:65
virtual BaseType * ptr_duplicate()
Definition: Byte.cc:106
virtual string dataset() const
Returns the name of the dataset used to create this instance.
Definition: BaseType.cc:349