Str.h
// -*- mode: c++; c-basic-offset:4 -*-
// This file is part of libdap, A C++ implementation of the OPeNDAP Data
// Access Protocol.
// Copyright (c) 2002,2003 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.
// (c) COPYRIGHT URI/MIT 1995-1999
// Please read the full copyright statement in the file COPYRIGHT_URI.
//
// Authors:
// jhrg,jimg James Gallagher <jgallagher@gso.uri.edu>
// Interface for Str type.
//
// jhrg 9/7/94
#ifndef _str_h
#define _str_h 1
#include <string>
#include "dods-limits.h"
#include "BaseType.h"
namespace libdap
{
// max_str_len should be large since we always send strings with length bytes
// as a prefix (so xdr_string will always know how much memory to malloc) but
// if deserialize gets confused and thinks a ctor (in particular) is a string
// xdr_string in turn will max_str_len if it cannot get a length byte. A long
// term solution is to fix libdap, but strings should not routinely be > 32k
// for the time being... jhrg 4/30/97
const unsigned int max_str_len = DODS_USHRT_MAX - 1;
class Str: public BaseType {
protected:
string d_buf;
public:
Str(const string &n);
Str(const string &n, const string &d);
virtual ~Str()
{}
Str(const Str &copy_from);
Str &operator=(const Str &rhs);
BaseType *ptr_duplicate() override;
unsigned int width(bool = false) const override
{
return sizeof(string);
}
int64_t width_ll(bool = false) const override
{
return sizeof(string);
}
// Return the length of the stored string or zero if no string has been
// stored in the instance's internal buffer.
int length() const override;
int64_t length_ll() const override;
// DAP2
bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval = true) override;
bool deserialize(UnMarshaller &um, DDS *dds, bool reuse = false) override;
// DAP4
void compute_checksum(Crc32 &checksum) override;
void serialize(D4StreamMarshaller &m, DMR &dmr, /*ConstraintEvaluator &eval,*/ bool filter = false) override;
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 string &value);
virtual string value() const;
virtual string esc_string_variable_value(const string &s);
void print_val(FILE *out, string space = "",
bool print_decl_p = true) override;
void print_val(ostream &out, string space = "",
bool print_decl_p = true) override;
bool ops(BaseType *b, int op) override;
bool d4_ops(BaseType *b, int op) override;
void dump(ostream &strm) const override;
};
} // namespace libdap
#endif // _str_h
Crc32
Definition crc.h:79
libdap::BaseType
The basic data type for the DODS DAP types.
Definition BaseType.h:120
libdap::Str
Holds character string data.
Definition Str.h:62
libdap::Str::buf2val
unsigned int buf2val(void **val) override
Definition Str.cc:210
libdap::Str::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 Str.cc:172
libdap::Str::length_ll
int64_t length_ll() const override
Get the number of elements in this variable This version of the function deprecates length() which is...
Definition Str.cc:133
libdap::Str::d4_ops
bool d4_ops(BaseType *b, int op) override
Definition Str.cc:335
libdap::Str::length
int length() const override
How many elements are in this variable? Uses -1 in places.
Definition Str.cc:127
libdap::Str::serialize
bool serialize(ConstraintEvaluator &eval, DDS &dds, Marshaller &m, bool ce_eval=true) override
Move data to the net, then remove them from the object.
Definition Str.cc:139
libdap::Str::deserialize
bool deserialize(UnMarshaller &um, DDS *dds, bool reuse=false) override
Receive data from the net.
Definition Str.cc:164
libdap::Str::value
virtual string value() const
Definition Str.cc:268
libdap::Str::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 Str.h:79
libdap::Str::dump
void dump(ostream &strm) const override
dumps information about this object
Definition Str.cc:367
libdap::Str::ptr_duplicate
BaseType * ptr_duplicate() override
Definition Str.cc:111
libdap::Str::val2buf
unsigned int val2buf(void *val, bool reuse=false) override
Definition Str.cc:238
libdap::Str::set_value
virtual bool set_value(const string &value)
Definition Str.cc:257
libdap::Str::print_val
void print_val(FILE *out, string space="", bool print_decl_p=true) override
Prints the value of the variable.
Definition Str.cc:274
libdap::Str::esc_string_variable_value
virtual string esc_string_variable_value(const string &s)
Escape non-printable characters and quotes from a Str variable value. The value printed is used mostl...
Definition Str.cc:289
libdap
top level DAP object to house generic methods
Definition AlarmHandler.h:36