D4Dimensions.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) 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
 
#ifndef D4DIMENSIONS_H_
#define D4DIMENSIONS_H_
 
#include <string>
#include <vector>
 
// #include "XMLWriter.h"
 
using namespace std;
 
namespace libdap {
 
class D4Group;
class D4Dimensions;
class XMLWriter;
 
class D4Dimension {
    string d_name;
    unsigned long long d_size;
 
    D4Dimensions *d_parent; // This is used to get the Dimensions and then the Group object
 
    bool d_constrained;
    int64_t d_c_start, d_c_stride, d_c_stop;
 
    bool d_used_by_projected_var;
 
public:
    D4Dimension()
        : d_name(""), d_size(0), d_parent(0), d_constrained(false), d_c_start(0), d_c_stride(0), d_c_stop(0),
          d_used_by_projected_var(false) {}
    D4Dimension(const string &name, unsigned long long size, D4Dimensions *d = 0)
        : d_name(name), d_size(size), d_parent(d), d_constrained(false), d_c_start(0), d_c_stride(0), d_c_stop(0),
          d_used_by_projected_var(false) {}
 
    string name() const { return d_name; }
    void set_name(const string &name) { d_name = name; }
    string fully_qualified_name() const;
 
    unsigned long long size() const { return d_size; }
    void set_size(unsigned long long size) { d_size = size; }
    // Because we build these in the XML parser and it's all text...
    void set_size(const string &size);
 
    D4Dimensions *parent() const { return d_parent; }
    void set_parent(D4Dimensions *d) { d_parent = d; }
 
    bool constrained() const { return d_constrained; }
    int64_t c_start() const { return d_c_start; }
    int64_t c_stride() const { return d_c_stride; }
    int64_t c_stop() const { return d_c_stop; }
 
    bool used_by_projected_var() const { return d_used_by_projected_var; }
    void set_used_by_projected_var(bool state) { d_used_by_projected_var = state; }

    void set_constraint(int64_t start, int64_t stride, int64_t stop) {
        d_c_start = start;
        d_c_stride = stride;
        d_c_stop = stop;
        d_constrained = true;
    }
 
    void print_dap4(XMLWriter &xml) const;
};

class D4Dimensions {
    vector<D4Dimension *> d_dims;
 
    D4Group *d_parent; // the group that holds this set of D4Dimensions; weak pointer, don't delete
 
protected:
    // Note Code in Array depends on the order of these 'new' dimensions
    // matching the 'old' dimensions they are derived from. See
    // Array::update_dimension_pointers. jhrg 8/25/14
    void m_duplicate(const D4Dimensions &rhs) {
        D4DimensionsCIter i = rhs.d_dims.begin();
        while (i != rhs.d_dims.end()) {
            d_dims.push_back(new D4Dimension(**i++)); // deep copy
            d_dims.back()->set_parent(this);          // Set the Dimension's parent
        }
 
        d_parent = rhs.d_parent;
    }
 
public:
    typedef vector<D4Dimension *>::iterator D4DimensionsIter;
    typedef vector<D4Dimension *>::const_iterator D4DimensionsCIter;
 
    D4Dimensions() : d_parent(0) {}
    D4Dimensions(D4Group *g) : d_parent(g) {}
    D4Dimensions(const D4Dimensions &rhs) : d_parent(0) { m_duplicate(rhs); }
 
    virtual ~D4Dimensions() {
        D4DimensionsIter i = d_dims.begin();
        while (i != d_dims.end())
            delete *i++;
    }
 
    D4Dimensions &operator=(const D4Dimensions &rhs) {
        if (this == &rhs)
            return *this;
        m_duplicate(rhs);
        return *this;
    }

    bool empty() const { return d_dims.empty(); }
 
    D4Group *parent() const { return d_parent; }
    void set_parent(D4Group *g) { d_parent = g; }

    void add_dim(D4Dimension *dim) { add_dim_nocopy(new D4Dimension(*dim)); }

    void add_dim_nocopy(D4Dimension *dim) {
        dim->set_parent(this);
        d_dims.push_back(dim);
    }

    D4DimensionsIter dim_begin() { return d_dims.begin(); }

    D4DimensionsIter dim_end() { return d_dims.end(); }
 
    D4Dimension *find_dim(const string &name);

    void insert_dim(D4Dimension *dim, D4DimensionsIter i) { insert_dim_nocopy(new D4Dimension(*dim), i); }

    void insert_dim_nocopy(D4Dimension *dim, D4DimensionsIter i) {
        dim->set_parent(this);
        d_dims.insert(i, dim);
    }
 
    void print_dap4(XMLWriter &xml, bool constrained = false) const;
};
 
} /* namespace libdap */
#endif /* D4DIMENSIONS_H_ */