VAPoR::DC::AuxVar Class Reference

Auxiliary variable metadata. More...

#include <DC.h>

Inheritance diagram for VAPoR::DC::AuxVar:

Public Member Functions
	AuxVar ()
	AuxVar (string name, string units, XType type, string wname, std::vector< size_t > cratios, std::vector< bool > periodic, std::vector< string > dim_names)
virtual	~AuxVar ()
std::vector< string >	GetDimNames () const
	Access Auxiliary variable dimension names.
void	SetDimNames (std::vector< string > dim_names)
long	GetOffset () const
void	SetOffset (long offset)
Public Member Functions inherited from VAPoR::DC::BaseVar
	BaseVar ()
	BaseVar (string name, string units, XType type, string wname, std::vector< size_t > cratios, std::vector< bool > periodic)
	BaseVar (string name, string units, XType type, std::vector< bool > periodic)
virtual	~BaseVar ()
string	GetName () const
	Get variable name.
void	SetName (string name)
string	GetUnits () const
	Access variable units.
void	SetUnits (string units)
XType	GetXType () const
	Access variable external storage type.
void	SetXType (XType type)
string	GetWName () const
	Access variable's wavelet family name.
void	SetWName (string wname)
std::vector< size_t >	GetCRatios () const
	Access variable's compression ratios.
void	SetCRatios (std::vector< size_t > cratios)
std::vector< bool >	GetPeriodic () const
void	SetPeriodic (std::vector< bool > periodic)
const std::map< string, Attribute > &	GetAttributes () const
	Access variable attributes.
void	SetAttributes (std::map< string, Attribute > &atts)
bool	GetAttribute (string name, Attribute &att) const
void	SetAttribute (const Attribute &att)
bool	IsCompressed () const
	Return true if no wavelet is defined.

Friends
VDF_API friend std::ostream &	operator<< (std::ostream &o, const AuxVar &var)

Detailed Description

Auxiliary variable metadata.

Version

3.1

This class defines metadata associatd with an Auxiliary variable. An Auxiliary variable is neither a data variable, nor a coordinate variable.

Definition at line 1230 of file DC.h.

Constructor & Destructor Documentation

AuxVar() [1/2]

VAPoR::DC::AuxVar::AuxVar ( )

inline

Definition at line 1232 of file DC.h.

AuxVar() [2/2]

VAPoR::DC::AuxVar::AuxVar ( string  name, string  units, XType  type, string  wname, std::vector< size_t >  cratios, std::vector< bool >  periodic, std::vector< string >  dim_names  )

inline

Construct Auxiliary variable definition

Constructor

Parameters

[in]	name	The variable's name
[in]	units	A string recognized by Udunits-2 specifying the unit measure for the variable. An empty string indicates that the variable is unitless.
[in]	type	The external storage type for variable data
[in]	wname	The wavelet family name for compressed variables
[in]	cratios	Specifies a vector of compression factors for compressed variable definitions. If empty, or if cratios.size()==1 and cratios[0]==1, the variable is not compressed

Deprecated:

Results are undefined if the rank of of periodic does not match that of dimensions.

Parameters

[in]

dim_names

An ordered list of names of the dimensions of the coordinate variable. The ordering is from fastest varying dimension to slowest. The number of elements in dim_names determines the dimensionality of the auxiliary variable.

Definition at line 1252 of file DC.h.

~AuxVar()

virtual VAPoR::DC::AuxVar::~AuxVar ( )

inlinevirtual

Definition at line 1257 of file DC.h.

Member Function Documentation

GetDimNames()

std::vector< string > VAPoR::DC::AuxVar::GetDimNames ( ) const

inline

Access Auxiliary variable dimension names.

Definition at line 1261 of file DC.h.

GetOffset()

long VAPoR::DC::AuxVar::GetOffset ( ) const

inline

Access Auxiliary variable's offset

The value of offset should be added to the Auxiliary variable's data

Definition at line 1268 of file DC.h.

SetDimNames()

void VAPoR::DC::AuxVar::SetDimNames ( std::vector< string >  dim_names )

inline

Definition at line 1262 of file DC.h.

SetOffset()

void VAPoR::DC::AuxVar::SetOffset ( long  offset )

inline

Definition at line 1269 of file DC.h.

Friends And Related Function Documentation

operator<<

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

friend

---

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

• /Users/pearse/VAPOR/include/vapor/DC.h