Dimension.h

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://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
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
 
#ifndef __AGG_UTIL__DIMENSION_H__
#define __AGG_UTIL__DIMENSION_H__
 
#include <ostream>
#include <string>
#include <vector>
 
namespace agg_util {
struct Dimension {
public:
    Dimension() = default;
    Dimension(std::string nameArg, unsigned int sizeArg, bool isSharedArg = false, bool isSizeConstantArg = true);
    ~Dimension() = default;

    std::string toString() const;
 
    // The name of the dimension (merely mnemonic)
    std::string name;
 
    // The cardinality of the dimension (number of elements)
    unsigned int size {0};
 
    // Whether the dimension in considered as shared across objects
    bool isShared {false};
 
    // whether the size is allowed to change or not, important for joinExisting, e.g.
    bool isSizeConstant {false};
};

std::ostream& operator<<(std::ostream& os, const Dimension& dim);
 
/* Read back in */
std::istream& operator>>(std::istream& is, Dimension& dim);
}
 
#endif /* __AGG_UTIL__DIMENSION_H__ */