D4Opaque.h
// -*- mode: c++; c-basic-offset:4 -*-
// This file is part of libdap, A C++ implementation of the OPeNDAP Data
// Access Protocol.
// Copyright (c) 2013 OPeNDAP, Inc.
// Author: James Gallagher <jgallagher@opendap.org>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
#ifndef _d4_opaque_h
#define _d4_opaque_h 1
#include <vector>
#include "BaseType.h"
#include "InternalErr.h"
class Crc32;
namespace libdap
{
class D4Opaque: public BaseType
{
public:
typedef std::vector<uint8_t> dods_opaque;
protected:
dods_opaque d_buf;
public:
D4Opaque(const std::string &n) : BaseType(n, dods_opaque_c, true /*is_dap4*/), d_buf(0) { }
D4Opaque(const std::string &n, const std::string &d) : BaseType(n, d, dods_opaque_c, true /*is_dap4*/), d_buf(0) { }
virtual ~D4Opaque() { }
D4Opaque(const D4Opaque &copy_from) : BaseType(copy_from) {
d_buf = copy_from.d_buf;
}
D4Opaque &operator=(const D4Opaque &rhs);
virtual BaseType *ptr_duplicate() { return new D4Opaque(*this); }
virtual void clear_local_data();
virtual unsigned int width(bool = false) const { return sizeof(vector<uint8_t>); }
// Return the length of the stored data or zero if no string has been
// stored in the instance's internal buffer.
virtual int length() const { return d_buf.size(); }
// DAP2
virtual bool serialize(ConstraintEvaluator &, DDS &, Marshaller &, bool = true) {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
virtual bool deserialize(UnMarshaller &, DDS *, bool = false) {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
// DAP4
virtual void compute_checksum(Crc32 &checksum);
virtual void serialize(D4StreamMarshaller &m, DMR &dmr, /*ConstraintEvaluator &eval,*/ bool filter = false);
#if 0
virtual void serialize_no_release(D4StreamMarshaller &m, DMR &dmr, bool filter = false);
#endif
virtual void deserialize(D4StreamUnMarshaller &um, DMR &dmr);
virtual unsigned int val2buf(void *val, bool reuse = false);
virtual unsigned int buf2val(void **val);
virtual bool set_value(const dods_opaque &value);
virtual dods_opaque value() const;
virtual void print_val(FILE *, std::string = "", bool = true) {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
virtual void print_val(std::ostream &out, std::string space = "", bool print_decl_p = true);
//virtual void print_dap4(XMLWriter &xml, bool constrained = false);
virtual bool ops(BaseType *, int) {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
virtual std::vector<BaseType *> *transform_to_dap2(AttrTable *parent_attr_table);
virtual void dump(std::ostream &strm) const ;
};
} // namespace libdap
#endif // _d4_opaque_h
libdap::ConstraintEvaluator
Evaluate a constraint expression.
Definition: ConstraintEvaluator.h:42
libdap::D4Opaque::deserialize
virtual bool deserialize(UnMarshaller &, DDS *, bool=false)
Receive data from the net.
Definition: D4Opaque.h:72
libdap::UnMarshaller
abstract base class used to unmarshall/deserialize dap data objects
Definition: UnMarshaller.h:54
libdap::D4Opaque::length
virtual int length() const
How many elements are in this variable.
Definition: D4Opaque.h:66
libdap::InternalErr
A class for software fault reporting.
Definition: InternalErr.h:64
libdap::Marshaller
abstract base class used to marshal/serialize dap data objects
Definition: Marshaller.h:50
libdap::D4Opaque::transform_to_dap2
virtual std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table)
DAP4 to DAP2 transform.
Definition: D4Opaque.cc:149
libdap::D4Opaque::buf2val
virtual unsigned int buf2val(void **val)
Reads the class data.
Definition: D4Opaque.cc:102
libdap::BaseType::BaseType
BaseType(const string &n, const Type &t, bool is_dap4=false)
The BaseType constructor.
Definition: BaseType.cc:126
libdap::D4Opaque::set_value
virtual bool set_value(const dods_opaque &value)
Definition: D4Opaque.cc:132
libdap::D4Opaque::compute_checksum
virtual void compute_checksum(Crc32 &checksum)
include the data for this variable in the checksum DAP4 includes a checksum with every data response....
Definition: D4Opaque.cc:76
libdap::D4Opaque::width
virtual unsigned int width(bool=false) const
How many bytes does this variable use Return the number of bytes of storage this variable uses....
Definition: D4Opaque.h:62
libdap
top level DAP object to house generic methods
Definition: AlarmHandler.h:35
libdap::D4StreamUnMarshaller
Read data from the stream made by D4StreamMarshaller.
Definition: D4StreamUnMarshaller.h:65
libdap::AttrTable
Contains the attributes for a dataset.
Definition: AttrTable.h:142
libdap::D4Opaque::serialize
virtual bool serialize(ConstraintEvaluator &, DDS &, Marshaller &, bool=true)
Move data to the net, then remove them from the object.
Definition: D4Opaque.h:69
libdap::D4Opaque::dump
virtual void dump(std::ostream &strm) const
dumps information about this object
Definition: D4Opaque.cc:171
libdap::D4Opaque::clear_local_data
virtual void clear_local_data()
Definition: D4Opaque.cc:65
libdap::D4Opaque
Definition: D4Opaque.h:38
libdap::D4Opaque::value
virtual dods_opaque value() const
Definition: D4Opaque.cc:143
libdap::DMR
Definition: DMR.h:53
libdap::D4Opaque::ops
virtual bool ops(BaseType *, int)
Evaluate relational operators.
Definition: D4Opaque.h:97
libdap::DDS
Definition: DDS.h:183
libdap::D4Opaque::val2buf
virtual unsigned int val2buf(void *val, bool reuse=false)
Loads class data.
Definition: D4Opaque.cc:118
libdap::D4Opaque::ptr_duplicate
virtual BaseType * ptr_duplicate()
Definition: D4Opaque.h:58
libdap::BaseType
The basic data type for the DODS DAP types.
Definition: BaseType.h:117
Crc32
Definition: crc.h:76
libdap::D4Opaque::print_val
virtual void print_val(FILE *, std::string="", bool=true)
Prints the value of the variable.
Definition: D4Opaque.h:90
libdap::D4StreamMarshaller
Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4's receiv...
Definition: D4StreamMarshaller.h:71