CDM.h

Go to the documentation of this file.

/*
 * Fimex
 *
 * (C) Copyright 2008, met.no
 *
 * Project Info:  https://wiki.met.no/fimex/start
 *
 * 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.
 */

#ifndef CDM_H_
#define CDM_H_

#include <map>
#include <vector>
#include <string>
#include <ostream>
#include <boost/regex_fwd.hpp>
#include "fimex/CDMAttribute.h"
#include "fimex/CDMVariable.h"
#include "fimex/CDMDimension.h"
#include "fimex/CDMException.h"
#include "fimex/CDMconstants.h"
#include "fimex/coordSys/Projection.h"

namespace MetNoFimex
{
//forward declaration
struct CDMImpl;

class CDM
{
public:
    typedef std::vector<CDMAttribute> AttrVec;
    typedef std::map<std::string, AttrVec> StrAttrVecMap;
    typedef std::vector<CDMDimension> DimVec;
    typedef std::vector<CDMVariable> VarVec;
    CDM();
    CDM(const CDM& rhs);
    virtual ~CDM();
    CDM& operator=(const CDM& rhs);
    void addVariable(const CDMVariable& var) throw(CDMException);
    CDMVariable& getVariable(const std::string& varName) throw(CDMException);
    const CDMVariable& getVariable(const std::string& varName) const throw(CDMException);
    bool hasVariable(const std::string& varName) const;
    std::vector<std::string> findVariables(const std::string& attrName, const std::string& attrValueRegExp) const;
    std::vector<std::string> findVariables(const std::map<std::string, std::string>& findAttributes, const std::vector<std::string>& findDimensions) const;
    bool renameVariable(const std::string& oldName, const std::string& newName);
    bool checkVariableAttribute(const std::string& varName, const std::string& attribute, const boost::regex& attrValue) const;
    void removeVariable(const std::string& variableName);

    void addDimension(const CDMDimension& dim) throw(CDMException);
    bool hasDimension(const std::string& dimName) const;

    CDMDimension& getDimension(const std::string& dimName) throw(CDMException);
    const CDMDimension& getDimension(const std::string& dimName) const throw(CDMException);

    bool testDimensionInUse(const std::string& name) const;

    bool renameDimension(const std::string& oldName, const std::string& newName) throw(CDMException);

    bool removeDimension(const std::string& name) throw(CDMException);

    const CDMDimension* getUnlimitedDim() const;
    bool hasUnlimitedDim(const CDMVariable& var) const;

    void addAttribute(const std::string& varName, const CDMAttribute& attr) throw(CDMException);
    void addOrReplaceAttribute(const std::string& varName, const CDMAttribute& attr) throw(CDMException);
    void removeAttribute(const std::string& varName, const std::string& attrName);


    void toXMLStream(std::ostream& os) const;
    const static std::string& globalAttributeNS() {const static std::string global("_GLOBAL"); return global;}

    const DimVec& getDimensions() const;
    const VarVec& getVariables() const;
    const StrAttrVecMap& getAttributes() const;
    std::vector<CDMAttribute> getAttributes(const std::string& varName) const;


    CDMAttribute& getAttribute(const std::string& varName, const std::string& attrName) throw(CDMException);
    const CDMAttribute& getAttribute(const std::string& varName, const std::string& attrName) const throw(CDMException);
    bool getAttribute(const std::string& varName, const std::string& attrName, CDMAttribute& retAttribute) const;
    double getFillValue(const std::string& varName) const;
    double getValidMin(const std::string& varName) const;
    double getValidMax(const std::string& varName) const;

    double getAddOffset(const std::string& varName) const;

    double getScaleFactor(const std::string& varName) const;

    std::string getUnits(const std::string& varName) const;
    void generateProjectionCoordinates(boost::shared_ptr<const Projection> projection, const std::string& xDim, const std::string& yDim, const std::string& lonDim, const std::string& latDim);
    MIFI_DEPRECATED(void generateProjectionCoordinates(const std::string& projectionVariable, const std::string& xDim, const std::string& yDim, const std::string& lonDim, const std::string& latDim);)
    MIFI_DEPRECATED(bool getProjectionAndAxesUnits(std::string& projectionName, std::string& xAxis, std::string& yAxis, std::string& xAxisUnits, std::string& yAxisUnits) const throw(CDMException));


    MIFI_DEPRECATED(AttrVec getProjection(std::string varName) const);
    boost::shared_ptr<const Projection> getProjectionOf(std::string varName) const;

    std::string getHorizontalXAxis(std::string varName) const;
    std::string getHorizontalYAxis(std::string varName) const;
    bool getLatitudeLongitude(std::string varName, std::string& latitude, std::string& longitude) const;
    std::string getTimeAxis(std::string varName) const;
    std::string getVerticalAxis(std::string varName) const;

private:
    CDMImpl* pimpl_;
};

}

#endif /*CDM_H_*/