Metadata.h

Go to the documentation of this file.

//
//      $Id$
//


#ifndef _Metadata_h_
#define _Metadata_h_

#include <vector>
#include "vapor/common.h"

#ifdef WIN32
#pragma warning(disable : 4251)
#endif

namespace VAPoR {

//
class VDF_API Metadata {
public:

 enum VarType_T {
    VARUNKNOWN = -1,
    VAR3D, VAR2D_XY, VAR2D_XZ, VAR2D_YZ
 };

 Metadata() {_deprecated_get_dim = false;}
 virtual ~Metadata() {};

 //
 virtual void   GetGridDim(size_t dim[3]) const = 0;

 //
 virtual void GetBlockSize(size_t bs[3], int reflevel) const = 0;


 //
 virtual int GetNumTransforms() const {return(0); };

 //
 virtual std::vector <size_t> GetCRatios() const {
    std::vector <size_t> cr; cr.push_back(1); return(cr);
 }

 //
 virtual std::string GetCoordSystemType() const { return("cartesian"); };

 //
 virtual std::string GetGridType() const { return("regular"); };

 //
 virtual std::vector<double> GetTSXCoords(size_t ts) const {
    std::vector <double> empty; return(empty);
 };
 virtual std::vector<double> GetTSYCoords(size_t ts) const {
    std::vector <double> empty; return(empty);
 };
 virtual std::vector<double> GetTSZCoords(size_t ts) const {
    std::vector <double> empty; return(empty);
 };



 //
 virtual std::vector<double> GetExtents(size_t ts = 0) const = 0;


 //
 virtual long GetNumTimeSteps() const = 0;


 //
 virtual std::vector <std::string> GetVariableNames() const;

 //
 virtual std::string GetMapProjection() const {std::string empty; return (empty); };

 //
 virtual std::vector <std::string> GetVariables3D() const = 0;

 //
 virtual std::vector <std::string> GetVariables2DXY() const = 0;

 //
 virtual std::vector <std::string> GetVariables2DXZ() const = 0;

 //
 virtual std::vector <std::string> GetVariables2DYZ() const = 0;

 //
 virtual std::vector <std::string> GetCoordinateVariables() const {;
    std::vector <std::string> v;
    v.push_back("NONE"); v.push_back("NONE"); v.push_back("ELEVATION");
    return(v);
 }


 //
 virtual std::vector<long> GetPeriodicBoundary() const = 0;

 virtual std::vector<long> GetGridPermutation() const = 0;

 //
 virtual double GetTSUserTime(size_t ts) const = 0;


 //
 virtual void GetTSUserTimeStamp(size_t ts, std::string &s) const = 0;


 //
 virtual void   GetDim(size_t dim[3], int reflevel = 0) const;

 //
 virtual void   GetDimBlk(size_t bdim[3], int reflevel = 0) const; 

 //
 virtual bool GetMissingValue(std::string varname, float &value) const {
    return(false); 
 };



 virtual void   MapVoxToBlk(const size_t vcoord[3], size_t bcoord[3], int reflevel = -1) const;

 virtual void   MapVoxToUser(
    size_t timestep,
    const size_t vcoord0[3], double vcoord1[3], int ref_level = 0
 ) const;

 void MapUserToVox(
    size_t timestep, const double vcoord0[3], size_t vcoord1[3],
    int reflevel
 ) const;


 //
 virtual VarType_T GetVarType(const std::string &varname) const; 

 //
 virtual int IsValidRegion(
    const size_t min[3], const size_t max[3], int reflevel = 0
 ) const;

 //
 virtual int IsValidRegionBlk(
    const size_t min[3], const size_t max[3], int reflevel = 0
 ) const;

 //
 virtual bool IsCoordinateVariable(std::string varname) const;


protected:
 bool _deprecated_get_dim;
};
};

#endif  //  _Metadata_h_