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) {}
~D4Opaque() override {}
D4Opaque(const D4Opaque &copy_from) : BaseType(copy_from) { d_buf = copy_from.d_buf; }
D4Opaque &operator=(const D4Opaque &rhs);
BaseType *ptr_duplicate() override { return new D4Opaque(*this); }
void clear_local_data() override;
unsigned int width(bool = false) const override { return sizeof(vector<uint8_t>); }
int64_t width_ll(bool = false) const override { 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.
int length() const override { return d_buf.size(); }
// DAP2
bool serialize(ConstraintEvaluator &, DDS &, Marshaller &, bool = true) override {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
bool deserialize(UnMarshaller &, DDS *, bool = false) override {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
// DAP4
void compute_checksum(Crc32 &checksum) override;
void serialize(D4StreamMarshaller &m, DMR &dmr, /*ConstraintEvaluator &eval,*/ bool filter = false) override;
#if 0
virtual void serialize_no_release(D4StreamMarshaller &m, DMR &dmr, bool filter = false);
#endif
void deserialize(D4StreamUnMarshaller &um, DMR &dmr) override;
unsigned int val2buf(void *val, bool reuse = false) override;
unsigned int buf2val(void **val) override;
virtual bool set_value(const dods_opaque &value);
virtual dods_opaque value() const;
void print_val(FILE *, std::string = "", bool = true) override {
throw InternalErr(__FILE__, __LINE__, "Unimplemented method");
}
void print_val(std::ostream &out, std::string space = "", bool print_decl_p = true) override;
// virtual void print_dap4(XMLWriter &xml, bool constrained = false);
bool ops(BaseType *, int) override { throw InternalErr(__FILE__, __LINE__, "Unimplemented method"); }
std::vector<BaseType *> *transform_to_dap2(AttrTable *parent_attr_table) override;
void dump(std::ostream &strm) const override;
};
} // namespace libdap
#endif // _d4_opaque_h
Crc32
Definition crc.h:45
libdap::AttrTable
Contains the attributes for a dataset.
Definition AttrTable.h:150
libdap::BaseType
The basic data type for the DODS DAP types.
Definition BaseType.h:118
libdap::ConstraintEvaluator
Evaluate a constraint expression.
Definition ConstraintEvaluator.h:41
libdap::D4Opaque
Definition D4Opaque.h:37
libdap::D4Opaque::ops
bool ops(BaseType *, int) override
Evaluate relational operators.
Definition D4Opaque.h:95
libdap::D4Opaque::width
unsigned int width(bool=false) const override
How many bytes does this variable use Return the number of bytes of storage this variable uses....
Definition D4Opaque.h:58
libdap::D4Opaque::transform_to_dap2
std::vector< BaseType * > * transform_to_dap2(AttrTable *parent_attr_table) override
DAP4 to DAP2 transform.
Definition D4Opaque.cc:119
libdap::D4Opaque::print_val
void print_val(FILE *, std::string="", bool=true) override
Prints the value of the variable.
Definition D4Opaque.h:88
libdap::D4Opaque::dump
void dump(std::ostream &strm) const override
dumps information about this object
Definition D4Opaque.cc:139
libdap::D4Opaque::ptr_duplicate
BaseType * ptr_duplicate() override
Definition D4Opaque.h:54
libdap::D4Opaque::length
int length() const override
How many elements are in this variable? Uses -1 in places.
Definition D4Opaque.h:64
libdap::D4Opaque::compute_checksum
void compute_checksum(Crc32 &checksum) override
include the data for this variable in the checksum DAP4 includes a checksum with every data response....
Definition D4Opaque.cc:67
libdap::D4Opaque::clear_local_data
void clear_local_data() override
Definition D4Opaque.cc:58
libdap::D4Opaque::value
virtual dods_opaque value() const
Definition D4Opaque.cc:117
libdap::D4Opaque::buf2val
unsigned int buf2val(void **val) override
Reads the class data.
Definition D4Opaque.cc:82
libdap::D4Opaque::val2buf
unsigned int val2buf(void *val, bool reuse=false) override
Loads class data.
Definition D4Opaque.cc:96
libdap::D4Opaque::deserialize
bool deserialize(UnMarshaller &, DDS *, bool=false) override
Receive data from the net.
Definition D4Opaque.h:70
libdap::D4Opaque::set_value
virtual bool set_value(const dods_opaque &value)
Definition D4Opaque.cc:108
libdap::D4Opaque::serialize
bool serialize(ConstraintEvaluator &, DDS &, Marshaller &, bool=true) override
Move data to the net, then remove them from the object.
Definition D4Opaque.h:67
libdap::D4StreamMarshaller
Marshaller that knows how to marshal/serialize dap data objects to a C++ iostream using DAP4's receiv...
Definition D4StreamMarshaller.h:71
libdap::D4StreamUnMarshaller
Read data from the stream made by D4StreamMarshaller.
Definition D4StreamUnMarshaller.h:65
libdap::DDS
Definition DDS.h:176
libdap::DMR
Definition DMR.h:56
libdap::InternalErr
A class for software fault reporting.
Definition InternalErr.h:61
libdap::Marshaller
abstract base class used to marshal/serialize dap data objects
Definition Marshaller.h:50
libdap::UnMarshaller
abstract base class used to unmarshall/deserialize dap data objects
Definition UnMarshaller.h:53
libdap
top level DAP object to house generic methods
Definition AlarmHandler.h:35