Base class for storing variable metadata. More...

#include <DC.h>

Inheritance diagram for VAPoR::DC::BaseVar:

Public Member Functions
	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::Dimension >	GetDimensions () 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, Attribute >	GetAttributes () 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 BaseVar &var)

Detailed Description

Base class for storing variable metadata.

Definition at line 307 of file DC.h.

Constructor & Destructor Documentation

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

inline

Default constructor

Definition at line 312 of file DC.h.

VAPoR::DC::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
	)

inline

Constructor

Parameters

[in]	name	The variable's name
[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
[in]	bs	An ordered array specifying the storage blocking factor for the variable. Results are undefined if the rank of of `bs` does not match that of `dimensions` spatial dimensions. dimensions only the needed elements of `bs` are accessed
[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
[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`.

Definition at line 349 of file DC.h.

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

No compression constructor

Parameters

[in]	name	The variable's name
[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.
[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`.

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

inlinevirtual

Definition at line 389 of file DC.h.

Member Function Documentation

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

inline

Access variable attributes.

Definition at line 439 of file DC.h.

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

inline

Access variable's block size.

Definition at line 416 of file DC.h.

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

inline

Access variable's compression ratios.

Definition at line 426 of file DC.h.

std::vector<DC::Dimension> VAPoR::DC::BaseVar::GetDimensions ( ) const

inline

Access variable's dimension names.

Definition at line 398 of file DC.h.

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

inline

Get variable name.

Definition at line 393 of file DC.h.

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

inline

Access variable bounary periodic.

Definition at line 434 of file DC.h.

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

inline

Access variable units.

Definition at line 405 of file DC.h.

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

inline

Access variable's wavelet family name.

Definition at line 421 of file DC.h.

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

inline

Access variable external storage type.

Definition at line 410 of file DC.h.

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

inline

Return true if no wavelet is defined.

Definition at line 444 of file DC.h.

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

inline

Return true if a time dimension is present.

Definition at line 448 of file DC.h.

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

inline

Definition at line 440 of file DC.h.

void VAPoR::DC::BaseVar::SetBS ( std::vector< size_t > bs )

inline

Definition at line 417 of file DC.h.

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

inline

Definition at line 427 of file DC.h.

void VAPoR::DC::BaseVar::SetDimensions ( std::vector< DC::Dimension > dimensions )

inline

Definition at line 399 of file DC.h.

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

inline

Definition at line 394 of file DC.h.

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

inline

Definition at line 435 of file DC.h.

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

inline

Definition at line 406 of file DC.h.

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

inline

Definition at line 422 of file DC.h.

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

inline

Definition at line 411 of file DC.h.

Friends And Related Function Documentation

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

friend

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

/Users/clyne/src/vapor-3.0/include/vapor/DC.h

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation