DDS.h

Go to the documentation of this file.

// -*- 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 1994-1999
// Please read the full copyright statement in the file COPYRIGHT_URI.
//
// Authors:
//      jhrg,jimg       James Gallagher <jgallagher@gso.uri.edu>
 
// Provide access to the DDS. This class is used to parse DDS text files, to
// produce a printed representation of the in-memory variable table, and to
// update the table on a per-variable basis.
//
// jhrg 9/8/94
 
#ifndef _dds_h
#define _dds_h 1
 
#include <cstdio>
#include <iostream>
#include <string>
#include <vector>
 
#ifndef _basetype_h
#include "BaseType.h"
#endif
 
#ifndef _constructor_h
#include "Constructor.h"
#endif
 
#ifndef base_type_factory_h
#include "BaseTypeFactory.h"
#endif
 
#ifndef _das_h
#include "DAS.h"
#endif
 
#ifndef A_DapObj_h
#include "DapObj.h"
#endif
 
#ifndef XMLWRITER_H_
#include "XMLWriter.h"
#endif
 
namespace libdap {
 
bool has_dap2_attributes(BaseType *btp);
bool has_dap2_attributes(AttrTable &a);

 
class DDS : public DapObj {
private:
    BaseTypeFactory *d_factory;
 
    string d_name;           // The dataset d_name
    string d_filename;       // File d_name (or other OS identifier) for
    string d_container_name; // d_name of container structure
    Structure *d_container;  // current container for container d_name
                             // dataset or part of dataset.
 
    int d_dap_major;      // The protocol major version number
    int d_dap_minor;      // ... and minor version number
    string d_dap_version; // String version of the protocol
    string d_request_xml_base;
    string d_namespace;
 
    AttrTable d_attr; // Global attributes.
 
    vector<BaseType *> vars; // Variables at the top level
 
    int d_timeout; // alarm time in seconds. If greater than
                   // zero, raise the alarm signal if more than
                   // d_timeout seconds are spent reading data.
 
    uint64_t d_max_response_size_kb; // In kilobytes...
 
    friend class DDSTest;
 
protected:
    void duplicate(const DDS &dds);
    BaseType *leaf_match(const string &name, BaseType::btp_stack *s = 0);
    BaseType *exact_match(const string &name, BaseType::btp_stack *s = 0);
 
public:
    typedef std::vector<BaseType *>::const_iterator Vars_citer;
    typedef std::vector<BaseType *>::iterator Vars_iter;
    typedef std::vector<BaseType *>::reverse_iterator Vars_riter;
 
    DDS(BaseTypeFactory *factory, const string &name = "");
    DDS(BaseTypeFactory *factory, const string &name, const string &version);
    DDS(const DDS &dds);
 
    virtual ~DDS();
 
    DDS &operator=(const DDS &rhs);
 
    virtual void transfer_attributes(DAS *das);
 
    string get_dataset_name() const;
    void set_dataset_name(const string &n);

    BaseTypeFactory *get_factory() const { return d_factory; }

    BaseTypeFactory *set_factory(BaseTypeFactory *factory) {
        BaseTypeFactory *t = d_factory;
        d_factory = factory;
        return t;
    }
 
    virtual AttrTable &get_attr_table();
 
    string filename() const;
    void filename(const string &fn);

    int get_dap_major() const { return d_dap_major; }
    int get_dap_minor() const { return d_dap_minor; }
 
    void set_dap_version(const string &version_string = "2.0");
    string get_dap_version() const { return d_dap_version; }
    string get_dmr_version() const { return "1.0"; }

    void set_dap_major(int p);
    void set_dap_minor(int p);
    void set_dap_version(double d);

    string get_request_xml_base() const { return d_request_xml_base; }

    void set_request_xml_base(const string &xb) { d_request_xml_base = xb; }

    string get_namespace() const { return d_namespace; }

    void set_namespace(const string &ns) { d_namespace = ns; }

    long get_response_limit() { return (long)(d_max_response_size_kb * 1024); }

    uint64_t get_response_limit_kb() const { return d_max_response_size_kb; }

    void set_response_limit(long size) { d_max_response_size_kb = size; }

    void set_response_limit_kb(uint64_t size) { d_max_response_size_kb = size; }

    bool too_big() { return d_max_response_size_kb != 0 && get_request_size_kb(true) > d_max_response_size_kb; }

    int get_request_size(bool constrained);

    uint64_t get_request_size_kb(bool constrained);
 
    string container_name();
    void container_name(const string &cn);
    Structure *container();
 
    void add_var(BaseType *bt);
    void add_var_nocopy(BaseType *bt);

    void del_var(const string &n);
 
    BaseType *var(const string &n, BaseType::btp_stack &s);
    BaseType *var(const string &n, BaseType::btp_stack *s = 0);
    int num_var();

    const vector<BaseType *> &variables() const { return vars; }

    Vars_iter var_begin() { return vars.begin(); }
    Vars_riter var_rbegin() { return vars.rbegin(); }

    Vars_iter var_end() { return vars.end(); }
    Vars_riter var_rend() { return vars.rend(); }

    Vars_iter get_vars_iter(int i) { return vars.begin() + i; }
    BaseType *get_var_index(int i) { return *(vars.begin() + i); }

    void insert_var(Vars_iter i, BaseType *ptr);
    void insert_var_nocopy(Vars_iter i, BaseType *ptr);
    void del_var(Vars_iter i);
    void del_var(Vars_iter i1, Vars_iter i2);

    void timeout_on();
    void timeout_off();
    void set_timeout(int t);
    int get_timeout();
 
    // These parse the DAP2 curly-brace document and make a C++ object.
    void parse(string fname);
    void parse(int fd);
    void parse(FILE *in = stdin);
 
    // These print the Binary object in either the curly-brace or XML reps
    void print(FILE *out);
    void print_constrained(FILE *out);
    void print_xml(FILE *out, bool constrained, const string &blob = "");
 
    // Same as above, but using C++ i/o streams
    void print(ostream &out);
    void print_constrained(ostream &out);
    void print_xml(ostream &out, bool constrained, const string &blob = "");
 
    // Print the XML using libxml2; the other print_xml methods use this impl.
    void print_xml_writer(ostream &out, bool constrained, const string &blob = "");
 
    // Print the DAP4 DMR 'object'
    void print_dmr(ostream &out, bool constrained);
 
    void print_das(ostream &out);
    DAS *get_das();
    void get_das(DAS *das);
 
    void mark_all(bool state);
    bool mark(const string &name, bool state);
    bool check_semantics(bool all = false);
 
    void tag_nested_sequences();
 
    bool is_dap4_projected(std::vector<string> &inventory);
 
    virtual void dump(ostream &strm) const;
};
 
} // namespace libdap
 
#endif // _dds_h