libdap++  Updated for version 3.14.0
Byte.cc
Go to the documentation of this file.
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 
37 #include "config.h"
38 
39 #include <sstream>
40 
41 #include "Byte.h" // synonymous with UInt8 and Char
42 #include "Int8.h"
43 #include "Int16.h"
44 #include "UInt16.h"
45 #include "Int32.h"
46 #include "UInt32.h"
47 #include "Int64.h"
48 #include "UInt64.h"
49 #include "Float32.h"
50 #include "Float64.h"
51 #include "Str.h"
52 #include "Url.h"
53 
54 #include "DDS.h"
55 #include "Operators.h"
56 #include "Marshaller.h"
57 #include "UnMarshaller.h"
58 
59 #include "DMR.h"
60 #include "D4StreamMarshaller.h"
61 #include "D4StreamUnMarshaller.h"
62 
63 #include "util.h"
64 #include "parser.h"
65 #include "dods-limits.h"
66 #include "InternalErr.h"
67 
68 using std::cerr;
69 using std::endl;
70 
71 namespace libdap {
72 
82 Byte::Byte(const string & n): BaseType(n, dods_byte_c)
83 {}
84 
95 Byte::Byte(const string &n, const string &d): BaseType(n, d, dods_byte_c)
96 {}
97 
98 Byte::Byte(const Byte & copy_from): BaseType(copy_from)
99 {
100  d_buf = copy_from.d_buf;
101 }
102 
104 {
105  return new Byte(*this);
106 }
107 
108 Byte & Byte::operator=(const Byte & rhs)
109 {
110  if (this == &rhs)
111  return *this;
112 
113  dynamic_cast < BaseType & >(*this) = rhs;
114 
115  d_buf = rhs.d_buf;
116 
117  return *this;
118 }
119 
120 unsigned int Byte::width(bool) const
121 {
122  return sizeof(dods_byte);
123 }
124 
135 bool Byte::serialize(ConstraintEvaluator & eval, DDS & dds, Marshaller &m, bool ce_eval)
136 {
137  dds.timeout_on();
138 
139  if (!read_p())
140  read(); // read() throws Error and InternalErr
141 
142  if (ce_eval && !eval.eval_selection(dds, dataset()))
143  return true;
144 
145  dds.timeout_off();
146 
147  m.put_byte( d_buf ) ;
148 
149  return true;
150 }
151 
156 {
157  um.get_byte( d_buf ) ;
158 
159  return false;
160 }
161 
162 void
164 {
165  checksum.AddData(reinterpret_cast<uint8_t*>(&d_buf), sizeof(d_buf));
166 }
167 
176 void
177 Byte::serialize(D4StreamMarshaller &m, DMR &, /*ConstraintEvaluator &,*/ bool)
178 {
179  if (!read_p())
180  read(); // read() throws Error
181 
182  m.put_byte( d_buf ) ;
183 }
184 
185 void
187 {
188  um.get_byte( d_buf ) ;
189 }
190 
196 unsigned int Byte::val2buf(void *val, bool)
197 {
198  // Jose Garcia
199  // This method is public therefore and I believe it has being designed
200  // to be use by read which must be implemented on the surrogate library,
201  // thus if the pointer val is NULL, is an Internal Error.
202  if (!val)
203  throw InternalErr("the incoming pointer does not contain any data.");
204 
205  d_buf = *(dods_byte *) val;
206 
207  return width();
208 }
209 
210 unsigned int Byte::buf2val(void **val)
211 {
212  // Jose Garcia
213  // The same comment justifying throwing an Error in val2buf applies here.
214  if (!val)
215  throw InternalErr("NULL pointer");
216 
217  if (!*val)
218  *val = new dods_byte;
219 
220  *(dods_byte *) * val = d_buf;
221 
222  return width();
223 }
224 
230 {
231  d_buf = value;
232  set_read_p(true);
233 
234  return true;
235 }
236 
240 {
241  return d_buf;
242 }
243 
244 void Byte::print_val(FILE * out, string space, bool print_decl_p)
245 {
246  ostringstream oss;
247  print_val(oss, space, print_decl_p);
248  fwrite(oss.str().data(), sizeof(char), oss.str().length(), out);
249 }
250 
251 void Byte::print_val(ostream &out, string space, bool print_decl_p)
252 {
253  if (print_decl_p) {
254  print_decl(out, space, false);
255  out << " = " << (int) d_buf << ";\n";
256  }
257  else
258  out << (int) d_buf;
259 }
260 
261 bool Byte::ops(BaseType * b, int op)
262 {
263 
264  // Extract the Byte arg's value.
265  if (!read_p() && !read()) {
266  // Jose Garcia
267  // Since the read method is virtual and implemented outside
268  // libdap++ if we cannot read the data that is the problem
269  // of the user or of whoever wrote the surrogate library
270  // implementing read therefore it is an internal error.
271  throw InternalErr("This value not read!");
272  }
273  // Extract the second arg's value.
274  if (!b || !(b->read_p() || b->read())) {
275  // Jose Garcia
276  // Since the read method is virtual and implemented outside
277  // libdap++ if we cannot read the data that is the problem
278  // of the user or of whoever wrote the surrogate library
279  // implementing read therefore it is an internal error.
280  throw InternalErr("This value not read!");
281  }
282 
283  switch (b->type()) {
284  case dods_int8_c:
285  return USCmp<dods_byte, dods_int8>(op, d_buf, static_cast<Int8*>(b)->value());
286  case dods_byte_c:
287  return Cmp<dods_byte, dods_byte>(op, d_buf, static_cast<Byte*>(b)->value());
288  case dods_int16_c:
289  return USCmp<dods_byte, dods_int16>(op, d_buf, static_cast<Int16*>(b)->value());
290  case dods_uint16_c:
291  return Cmp<dods_byte, dods_uint16>(op, d_buf, static_cast<UInt16*>(b)->value());
292  case dods_int32_c:
293  return USCmp<dods_byte, dods_int32>(op, d_buf, static_cast<Int32*>(b)->value());
294  case dods_uint32_c:
295  return Cmp<dods_byte, dods_uint32>(op, d_buf, static_cast<UInt32*>(b)->value());
296  case dods_int64_c:
297  return USCmp<dods_byte, dods_int64>(op, d_buf, static_cast<Int64*>(b)->value());
298  case dods_uint64_c:
299  return Cmp<dods_byte, dods_uint64>(op, d_buf, static_cast<UInt64*>(b)->value());
300  case dods_float32_c:
301  return USCmp<dods_byte, dods_float32>(op, d_buf, static_cast<Float32*>(b)->value());
302  case dods_float64_c:
303  return USCmp<dods_byte, dods_float64>(op, d_buf, static_cast<Float64*>(b)->value());
304  default:
305  return false;
306  }
307 }
308 
317 void Byte::dump(ostream & strm) const
318 {
319  strm << DapIndent::LMarg << "Byte::dump - ("
320  << (void *) this << ")" << endl;
322  BaseType::dump(strm);
323  strm << DapIndent::LMarg << "value: " << d_buf << endl;
325 }
326 
327 } // namespace libdap
virtual bool read()
Read data into a local buffer.
Definition: BaseType.cc:805
Holds an 8-bit signed integer value.
Definition: Int8.h:42
virtual void get_byte(dods_byte &val)=0
Holds a64-bit signed integer.
Definition: Int64.h:49
virtual bool read_p()
Has this variable been read?
Definition: BaseType.cc:421
virtual dods_byte value() const
Definition: Byte.cc:239
static void UnIndent()
Definition: DapIndent.cc:51
abstract base class used to unmarshall/deserialize dap data objects
Definition: UnMarshaller.h:54
virtual unsigned int buf2val(void **val)
Reads the class data.
Definition: Byte.cc:210
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:905
uint8_t dods_byte
virtual bool deserialize(UnMarshaller &um, DDS *, bool)
Deserialize the char on stdin and put the result in _BUF.
Definition: Byte.cc:155
Byte(const string &n)
The Byte constructor.
Definition: Byte.cc:82
virtual bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval)
Definition: Byte.cc:135
virtual void get_byte(dods_byte &val)
Read data from the stream made by D4StreamMarshaller.
Holds an unsigned 16-bit integer.
Definition: UInt16.h:57
Definition: crc.h:76
virtual void put_byte(dods_byte val)
dods_byte d_buf
Definition: Byte.h:63
void timeout_off()
Definition: DDS.cc:894
Type type() const
Returns the type of the class instance.
Definition: BaseType.cc:306
Holds a 32-bit floating point value.
Definition: Float32.h:61
A class for software fault reporting.
Definition: InternalErr.h:64
string dataset() const
Returns the name of the dataset used to create this instance.
Definition: BaseType.cc:299
virtual unsigned int val2buf(void *val, bool reuse=false)
Definition: Byte.cc:196
Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4's receiv...
Holds a 16-bit signed integer value.
Definition: Int16.h:59
static void Indent()
Definition: DapIndent.cc:45
Byte & operator=(const Byte &rhs)
Definition: Byte.cc:108
virtual void dump(ostream &strm) const
dumps information about this object
Definition: BaseType.cc:237
virtual void set_read_p(bool state)
Sets the value of the read_p property.
Definition: BaseType.cc:454
virtual bool set_value(const dods_byte value)
Definition: Byte.cc:229
virtual void dump(ostream &strm) const
dumps information about this object
Definition: Byte.cc:317
Holds a 64-bit unsigned integer.
Definition: UInt64.h:49
void AddData(const uint8_t *pData, const uint32_t length)
Definition: crc.h:84
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:120
void timeout_on()
Definition: DDS.cc:886
virtual void print_val(FILE *out, string space="", bool print_decl_p=true)
Prints the value of the variable.
Definition: Byte.cc:244
Evaluate a constraint expression.
virtual void put_byte(dods_byte val)=0
static ostream & LMarg(ostream &strm)
Definition: DapIndent.cc:80
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:53
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 ans is called ...
virtual bool ops(BaseType *b, int op)
Evaluate relational operators.
Definition: Byte.cc:261
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:163
Holds a 32-bit unsigned integer.
Definition: UInt32.h:59
Holds a 32-bit signed integer.
Definition: Int32.h:65
virtual BaseType * ptr_duplicate()
Definition: Byte.cc:103