VDC.h

Go to the documentation of this file.

#include <vector>
#include <map>
#include <iostream>
#include <vapor/DC.h>
#include <vapor/MyBase.h>
#include <vapor/UDUnitsClass.h>

#ifndef _VDC_H_
#define _VDC_H_

namespace VAPoR {

class VDF_API VDC : public VAPoR::DC {
public:

 enum AccessMode {R,W,A};

 VDC();
 virtual ~VDC() {}

 //
 virtual int Initialize(const std::vector <string> &paths, AccessMode mode);
 virtual int Initialize(const std::vector <string> &paths) {
    return(Initialize(paths, R));
 }

 //
 int SetCompressionBlock(
    std::vector <size_t> bs, string wname, std::vector <size_t> cratios
 );
 
 //
 void GetCompressionBlock(
    std::vector <size_t> &bs, string &wname, 
    std::vector <size_t> &cratios
 ) const;



 void SetPeriodicBoundary(std::vector <bool> periodic) {
    _periodic = periodic;
    for (int i=_periodic.size(); i<3; i++) _periodic.push_back(false);
 }

 //
 std::vector <bool> GetPeriodicBoundary() const { return(_periodic); };

 //
 int DefineDimension(string dimname, size_t length, int axis);


 bool GetDimension(
    string dimname, DC::Dimension &dimension
 ) const;

 std::vector <string> GetDimensionNames() const;


 //
 int DefineCoordVar(
    string varname, std::vector <string> dimnames, 
    string units, int axis, XType type, bool compressed
 );


 //
 int DefineCoordVarUniform(
    string varname, std::vector <string> dimname, 
    string units, int axis, XType type, bool compressed
 );

 bool GetCoordVarInfo(
    string varname, std::vector <string> &dimnames, 
    string &units, int &axis, XType &type, bool &compressed, bool &uniform
 ) const;

 bool GetCoordVarInfo(string varname, DC::CoordVar &cvar) const;

 int DefineDataVar(
    string varname, std::vector <string> dimnames, 
    std::vector <string> coordvars, 
    string units, XType type, bool compressed
 );

 int DefineDataVar(
    string varname, std::vector <string> dimnames, 
    std::vector <string> coordvars, 
    string units, XType type, double missing_value, string maskvar
 );


 bool GetDataVarInfo(
    string varname, std::vector <string> &dimnames, 
    std::vector <string> &coordvars, 
    string &units, XType &type, bool &compressed,
    string &maskvar
 ) const;

 bool GetDataVarInfo( string varname, DC::DataVar &datavar) const;
 
 //
 bool GetBaseVarInfo(string varname, DC::BaseVar &var) const;


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

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


 //
 int GetNumRefLevels(string varname) const;


 //
 int PutAtt(
    string varname, string attname, XType type, const vector <double> &values
 );
 int PutAtt(
    string varname, string attname, XType type, const vector <long> &values
 );
 int PutAtt(
    string varname, string attname, XType type, const string &values
 );

 //
 int GetAtt(
    string varname, string attname, vector <double> &values
 ) const;
 int GetAtt(
    string varname, string attname, vector <long> &values
 ) const;
 int GetAtt(
    string varname, string attname, string &values
 ) const;

 //
 std::vector <string> GetAttNames(string varname) const;

 XType GetAttType(string varname, string attname) const;

 virtual int GetMapProjection(
    string lonname, string latname, string &projstring
 ) const;

 //
 virtual int SetMapProjection(
    string lonname, string latname, string projstring
 );

 int EndDefine();

 virtual int GetPath(
    string varname, size_t ts, string &path, size_t &file_ts,
    size_t &max_ts

 ) const = 0;

 //
 virtual int GetDimLensAtLevel(
    string varname, int level, std::vector <size_t> &dims_at_level,
    std::vector <size_t> &bs_at_level
 ) const = 0;


 //
 virtual int OpenVariableRead(
    size_t ts, string varname, int level=0, int lod=0
 ) = 0;

 //
 virtual int OpenVariableWrite(size_t ts, string varname, int lod=-1) = 0;

 //
 virtual int CloseVariable() = 0;


 //
 virtual int Write(const float *data) = 0;

 virtual int WriteSlice(const float *slice) = 0;

 //
 int virtual Read(float *data) = 0;

 virtual int ReadSlice(float *slice) = 0;

 //
 virtual int ReadRegion(
    const vector <size_t> &min, const vector <size_t> &max, float *region
 ) = 0;

 virtual int ReadRegionBlock(
    const vector <size_t> &min, const vector <size_t> &max, float *region
 ) = 0;

 //
 virtual int PutVar(string varname, int lod, const float *data) = 0;
 
 //
 virtual int PutVar(size_t ts, string varname, int lod, const float *data) = 0;

 //
 virtual int GetVar(string varname, int level, int lod, float *data) = 0;

 //
 virtual int GetVar(
    size_t ts, string varname, int level, int lod, float *data
 ) = 0;

 virtual bool CompressionInfo(
    vector <size_t> bs, string wname, size_t &nlevels, size_t &maxcratio
 ) const = 0; 


 //
 virtual bool VariableExists(
    size_t ts,
    string varname,
    int reflevel = 0,
    int lod = 0
 ) const = 0;


 friend std::ostream &operator<<(std::ostream &o, const VDC &vdc);

private:
 std::vector <string> _newUniformVars;

protected:
 string _master_path;
 AccessMode _mode;
 bool _defineMode;
 std::vector <size_t> _bs;
 string _wname;
 std::vector <size_t> _cratios;
 vector <bool> _periodic;
 VAPoR::UDUnits _udunits;

 std::map <string, Dimension> _dimsMap;
 std::map <string, Attribute> _atts;
 std::map <string, CoordVar> _coordVars;
 std::map <string, DataVar> _dataVars;

#ifndef DOXYGEN_SKIP_THIS

 bool _ValidDefineDimension(string name, size_t length, int axis) const;

 bool _ValidDefineCoordVar(
    string varname, vector <string> dimnames,
    string units, int axis, XType type, bool compressed
 ) const;


 bool _valid_blocking(
    const vector <DC::Dimension> &dimensions,
    const vector <string> &coordvars,
    const vector <size_t> &bs
 ) const;

 bool _valid_mask_var(
    string varname, vector <DC::Dimension> dimensions,
    vector <size_t> bs, bool compressed, string maskvar
 ) const;

 bool _ValidDefineDataVar(
    string varname, vector <string> dimnames, vector <string> coordnames,
    string units, XType type, bool compressed, string maskvar
 ) const;


 bool _ValidCompressionBlock(
    vector <size_t> bs, string wname, vector <size_t> cratios
 ) const;

 virtual int _WriteMasterMeta() = 0;
 virtual int _ReadMasterMeta() = 0;

 int _DefineDataVar(
    string varname, std::vector <string> dimnames, 
    std::vector <string> coordvars, 
    string units, XType type, bool compressed, double mv, string maskvar
 );

#endif

};
};

#endif