VAPoR::DC::BaseVar Class Reference

Base class for storing variable metadata. More...

#include <DC.h>

Inheritance diagram for VAPoR::DC::BaseVar:

Public Member Functions
	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
std::ostream &	operator<< (std::ostream &o, const BaseVar &var)

Detailed Description

Base class for storing variable metadata.

Definition at line 754 of file DC.h.

Constructor & Destructor Documentation

BaseVar() [1/3]

VAPoR::DC::BaseVar::BaseVar ( )

inline

Definition at line 756 of file DC.h.

BaseVar() [2/3]

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

inline

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.

Definition at line 784 of file DC.h.

BaseVar() [3/3]

VAPoR::DC::BaseVar::BaseVar	(	string	name,
		string	units,
		XType	type,
		std::vector< bool >	periodic
	)

No compression constructor

Parameters

[in]

name

The variable's name

Deprecated:

Parameters

[in]	dimensions	An ordered vector specifying the variable's spatial and/or temporal dimensions
[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 factor for the variable.

Deprecated:

Parameters

[in]

periodic

An ordered array of booleans specifying the spatial boundary periodicity. Results are undefined if the rank of of periodic does not match that of dimensions.

~BaseVar()

virtual VAPoR::DC::BaseVar::~BaseVar ( )

inlinevirtual

Definition at line 810 of file DC.h.

Member Function Documentation

GetAttribute()

bool VAPoR::DC::BaseVar::GetAttribute ( string  name, Attribute &  att  ) const

inline

Definition at line 852 of file DC.h.

GetAttributes()

const std::map< string, Attribute > & VAPoR::DC::BaseVar::GetAttributes ( ) const

inline

Access variable attributes.

Definition at line 849 of file DC.h.

GetCRatios()

std::vector< size_t > VAPoR::DC::BaseVar::GetCRatios ( ) const

inline

Access variable's compression ratios.

Definition at line 834 of file DC.h.

GetName()

string VAPoR::DC::BaseVar::GetName ( ) const

inline

Get variable name.

Definition at line 814 of file DC.h.

GetPeriodic()

std::vector< bool > VAPoR::DC::BaseVar::GetPeriodic ( ) const

inline

Deprecated:

Access variable bounary periodic

Definition at line 844 of file DC.h.

GetUnits()

string VAPoR::DC::BaseVar::GetUnits ( ) const

inline

Access variable units.

Definition at line 819 of file DC.h.

GetWName()

string VAPoR::DC::BaseVar::GetWName ( ) const

inline

Access variable's wavelet family name.

Definition at line 829 of file DC.h.

GetXType()

XType VAPoR::DC::BaseVar::GetXType ( ) const

inline

Access variable external storage type.

Definition at line 824 of file DC.h.

IsCompressed()

bool VAPoR::DC::BaseVar::IsCompressed ( ) const

inline

Return true if no wavelet is defined.

Definition at line 864 of file DC.h.

SetAttribute()

void VAPoR::DC::BaseVar::SetAttribute ( const Attribute &  att )

inline

Definition at line 860 of file DC.h.

References VAPoR::DC::Attribute::GetName().

SetAttributes()

void VAPoR::DC::BaseVar::SetAttributes ( std::map< string, Attribute > &  atts )

inline

Definition at line 850 of file DC.h.

SetCRatios()

void VAPoR::DC::BaseVar::SetCRatios ( std::vector< size_t >  cratios )

inline

Definition at line 836 of file DC.h.

SetName()

void VAPoR::DC::BaseVar::SetName ( string  name )

inline

Definition at line 815 of file DC.h.

SetPeriodic()

void VAPoR::DC::BaseVar::SetPeriodic ( std::vector< bool >  periodic )

inline

Definition at line 845 of file DC.h.

SetUnits()

void VAPoR::DC::BaseVar::SetUnits ( string  units )

inline

Definition at line 820 of file DC.h.

SetWName()

void VAPoR::DC::BaseVar::SetWName ( string  wname )

inline

Definition at line 830 of file DC.h.

SetXType()

void VAPoR::DC::BaseVar::SetXType ( XType  type )

inline

Definition at line 825 of file DC.h.

Friends And Related Function Documentation

operator<<

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

friend

---

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

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