VAPoR  3.0.0
Public Member Functions | Friends | List of all members
VAPoR::DC::CoordVar Class Reference

Coordinate variable metadata. More...

#include <DC.h>

Inheritance diagram for VAPoR::DC::CoordVar:
VAPoR::DC::BaseVar

Public Member Functions

 CoordVar ()
 Default Coordinate Variable metadata constructor. More...
 
 CoordVar (string name, std::vector< DC::Dimension > dimensions, string units, XType type, std::vector< size_t > bs, string wname, std::vector< size_t > cratios, std::vector< bool > periodic, int axis, bool uniform)
 
 CoordVar (string name, std::vector< DC::Dimension > dimensions, string units, XType type, std::vector< bool > periodic, int axis, bool uniform)
 
virtual ~CoordVar ()
 
int GetAxis () const
 Access coordinate variable axis. More...
 
void SetAxis (int axis)
 
bool GetUniform () const
 Access coordinate variable uniform sampling flag. More...
 
void SetUniform (bool uniform)
 
- Public Member Functions inherited from VAPoR::DC::BaseVar
 BaseVar ()
 
 BaseVar (string name, std::vector< DC::Dimension > dimensions, string units, XType type, std::vector< size_t > bs, string wname, std::vector< size_t > cratios, std::vector< bool > periodic)
 
 BaseVar (string name, std::vector< DC::Dimension > dimensions, string units, XType type, std::vector< bool > periodic)
 
virtual ~BaseVar ()
 
string GetName () const
 Get variable name. More...
 
void SetName (string name)
 
std::vector< DC::DimensionGetDimensions () const
 Access variable's dimension names. More...
 
void SetDimensions (std::vector< DC::Dimension > dimensions)
 
string GetUnits () const
 Access variable units. More...
 
void SetUnits (string units)
 
XType GetXType () const
 Access variable external storage type. More...
 
void SetXType (XType type)
 
std::vector< size_t > GetBS () const
 Access variable's block size. More...
 
void SetBS (std::vector< size_t > bs)
 
string GetWName () const
 Access variable's wavelet family name. More...
 
void SetWName (string wname)
 
std::vector< size_t > GetCRatios () const
 Access variable's compression ratios. More...
 
void SetCRatios (std::vector< size_t > cratios)
 
std::vector< bool > GetPeriodic () const
 Access variable bounary periodic. More...
 
void SetPeriodic (std::vector< bool > periodic)
 
std::map< string, AttributeGetAttributes () const
 Access variable attributes. More...
 
void SetAttributes (std::map< string, Attribute > &atts)
 
bool IsCompressed () const
 Return true if no wavelet is defined. More...
 
bool IsTimeVarying () const
 Return true if a time dimension is present. More...
 

Friends

std::ostream & operator<< (std::ostream &o, const CoordVar &var)
 

Detailed Description

Coordinate variable metadata.

Definition at line 472 of file DC.h.

Constructor & Destructor Documentation

VAPoR::DC::CoordVar::CoordVar ( )
inline

Default Coordinate Variable metadata constructor.

Definition at line 477 of file DC.h.

VAPoR::DC::CoordVar::CoordVar ( string  name,
std::vector< DC::Dimension dimensions,
string  units,
XType  type,
std::vector< size_t >  bs,
string  wname,
std::vector< size_t >  cratios,
std::vector< bool >  periodic,
int  axis,
bool  uniform 
)
inline

Construct coordinate variable

Parameters
[in]axisan int in the range 0..3 indicating the coordinate axis, one of X, Y, Z, or T, respectively
[in]uniformA bool indicating whether the coordinate variable is uniformly sampled.

Definition at line 496 of file DC.h.

VAPoR::DC::CoordVar::CoordVar ( string  name,
std::vector< DC::Dimension dimensions,
string  units,
XType  type,
std::vector< bool >  periodic,
int  axis,
bool  uniform 
)
inline

Construct coordinate variable without compression

No compression constructor

Parameters
[in]nameThe variable's name
[in]dimensionsAn ordered vector specifying the variable's spatial and/or temporal dimensions
[in]unitsA string recognized by Udunits-2 specifying the unit measure for the variable. An empty string indicates that the variable is unitless.
[in]typeThe external storage type for variable data factor for the variable.
[in]periodicAn ordered array of booleans specifying the spatial boundary periodicity. Results are undefined if the rank of of periodic does not match that of dimensions.
[in]axisan int in the range 0..3 indicating the coordinate axis, one of X, Y, Z, or T, respectively
[in]uniformA bool indicating whether the coordinate variable is uniformly sampled.

Definition at line 522 of file DC.h.

virtual VAPoR::DC::CoordVar::~CoordVar ( )
inlinevirtual

Definition at line 533 of file DC.h.

Member Function Documentation

int VAPoR::DC::CoordVar::GetAxis ( ) const
inline

Access coordinate variable axis.

Definition at line 537 of file DC.h.

bool VAPoR::DC::CoordVar::GetUniform ( ) const
inline

Access coordinate variable uniform sampling flag.

Definition at line 542 of file DC.h.

void VAPoR::DC::CoordVar::SetAxis ( int  axis)
inline

Definition at line 538 of file DC.h.

void VAPoR::DC::CoordVar::SetUniform ( bool  uniform)
inline

Definition at line 543 of file DC.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const CoordVar var 
)
friend

The documentation for this class was generated from the following file: