CoordinateSystem.h

Go to the documentation of this file.

/*
 * Fimex, CoordinateSystem.h
 *
 * (C) Copyright 2009, 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.
 *
 *  Created on: Mar 15, 2010
 *      Author: Heiko Klein
 */

#ifndef COORDINATESYSTEM_H_
#define COORDINATESYSTEM_H_

#include <functional>
#include <vector>
#include <map>
#include <set>
#include <string>
#include <boost/shared_ptr.hpp>
#include <iostream>
#include "fimex/coordSys/CoordinateAxis.h"
#include "fimex/coordSys/Projection.h"
#include "fimex/coordSys/verticalTransform/VerticalTransformation.h"
#include "fimex/deprecated.h"


namespace MetNoFimex
{

//forward decl.
class CDM;
class CDMReader;
struct CoordSysImpl;

class CoordinateSystem
{
public:
    typedef boost::shared_ptr<const CoordinateAxis> ConstAxisPtr;
    typedef boost::shared_ptr<CoordinateAxis> AxisPtr;
    typedef std::vector<ConstAxisPtr> ConstAxisList;

    CoordinateSystem();
    explicit CoordinateSystem(const std::string& conventionName);
    virtual ~CoordinateSystem() {}

    virtual std::string id() const;
    virtual std::string horizontalId() const;

    virtual std::string getConventionName() const;
    virtual void setConventionName(const std::string& conventionName);
    virtual bool isComplete(const std::string& varName) const;
    virtual void setComplete(const std::string& varName, bool set = true);
    virtual bool isCSFor(const std::string& varName) const;
    virtual void setCSFor(const std::string& varName, bool set = true);
    virtual bool isSimpleSpatialGridded() const;
    virtual void setSimpleSpatialGridded(bool set = true);
    virtual bool hasProjection() const;
    virtual boost::shared_ptr<const Projection> getProjection() const;
    virtual void setProjection(boost::shared_ptr<const Projection> proj);
    virtual bool hasVerticalTransformation() const;
    virtual boost::shared_ptr<const VerticalTransformation> getVerticalTransformation() const;
    virtual void setVerticalTransformation(boost::shared_ptr<const VerticalTransformation> vtran);
    virtual bool hasAxisType(CoordinateAxis::AxisType type) const;
    virtual ConstAxisPtr findAxisOfType(CoordinateAxis::AxisType type) const;
    virtual ConstAxisPtr findAxisOfType(const std::vector<CoordinateAxis::AxisType>& types) const;
    virtual ConstAxisPtr getGeoXAxis() const;
    virtual ConstAxisPtr getGeoYAxis() const;
    virtual ConstAxisPtr getGeoZAxis() const;
    virtual ConstAxisPtr getTimeAxis() const;
    virtual ConstAxisList getAxes() const;
    virtual void setAxis(ConstAxisPtr axis);
    virtual void setAuxiliaryAxis(ConstAxisPtr axis);
    virtual std::set<std::string> getDependencyVariables() const;
    virtual void addDependencyVariable(std::string varName);
private:
    boost::shared_ptr<CoordSysImpl> pimpl_;
};

std::ostream& operator<<(std::ostream& out, const CoordinateSystem& p);

std::vector<boost::shared_ptr<const CoordinateSystem> > listCoordinateSystems(boost::shared_ptr<CDMReader> reader);
void enhanceVectorProperties(boost::shared_ptr<CDMReader> reader);

MIFI_DEPRECATED(std::vector<boost::shared_ptr<const CoordinateSystem> > listCoordinateSystems(CDM& cdm));
MIFI_DEPRECATED(std::vector<boost::shared_ptr<const CoordinateSystem> > listCoordinateSystems(const CDM& cdm));

int findBestHorizontalCoordinateSystems(bool withProjection, boost::shared_ptr<CDMReader> reader, std::map<std::string, boost::shared_ptr<const CoordinateSystem> >& systems, std::map<std::string, std::string>& variables, std::vector<std::string>& incompatibleVariables);

struct CompleteCoordinateSystemForComparator : public std::unary_function<boost::shared_ptr<const CoordinateSystem>, bool>
{
public:
    CompleteCoordinateSystemForComparator(const std::string& varName) : varName(varName) {}
    virtual ~CompleteCoordinateSystemForComparator() {}
    bool operator()(const boost::shared_ptr<const CoordinateSystem>& cs) {return cs->isComplete(varName) && cs->isCSFor(varName);}
private:
    const std::string& varName;

};

}

#endif /* COORDINATESYSTEM_H_ */