Coordinate variable metadata. More...

#include <DC.h>

Inheritance diagram for VAPoR::DC::CoordVar:

Public Member Functions
	CoordVar ()

	CoordVar (string name, string units, XType type, string wname, std::vector< size_t > cratios, std::vector< bool > periodic, std::vector< string > dim_names, string time_dim_name, int axis, bool uniform)

	CoordVar (string name, string units, XType type, std::vector< bool > periodic, int axis, bool uniform, std::vector< string > dim_names, string time_dim_name)

virtual	~CoordVar ()

std::vector< string >	GetDimNames () const

void	SetDimNames (std::vector< string > dim_names)

string	GetTimeDimName () const

void	SetTimeDimName (string time_dim_name)

int	GetAxis () const
	Access coordinate variable axis.

void	SetAxis (int axis)

bool	GetUniform () const
	Access coordinate variable uniform sampling flag.

void	SetUniform (bool uniform)

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
std::ostream &	operator<< (std::ostream &o, const CoordVar &var)

Detailed Description

Coordinate variable metadata.

Definition at line 881 of file DC.h.

Constructor & Destructor Documentation

◆ CoordVar() [1/3]

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

inline

Definition at line 883 of file DC.h.

◆ CoordVar() [2/3]

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

inline

Construct coordinate variable

Parameters

[in]	dim_names	An ordered list of names of the spatial 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 coordinate variable.
[in]	time_dim_name	Name of time varying dimension, if any. If the coordinate variable varies over time this parameter names the time dimension. If `time_dim_name` is the empty string the coordiante variable is constant over time.
[in]	axis	an int in the range 0..3 indicating the coordinate axis, one of X, Y, Z, or T, respectively
[in]	uniform	A bool indicating whether the coordinate variable is uniformly sampled.

Definition at line 916 of file DC.h.

◆ CoordVar() [3/3]

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

inline

Construct coordinate variable without compression

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`.
[in]	dim_names	An ordered list of names of the spatial 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 coordinate variable.
[in]	time_dim_name	Name of time varying dimension, if any. If the coordinate variable varies over time this parameter names the time dimension. If `time_dim_name` is the empty string the coordiante variable is constant over time.
[in]	axis	an int in the range 0..3 indicating the coordinate axis, one of X, Y, Z, or T, respectively
[in]	uniform	A bool indicating whether the coordinate variable is uniformly sampled.

Definition at line 944 of file DC.h.

◆ ~CoordVar()

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

inlinevirtual

Definition at line 949 of file DC.h.

Member Function Documentation

◆ GetAxis()

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

inline

Access coordinate variable axis.

Definition at line 965 of file DC.h.

◆ GetDimNames()

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

inline

Access coordinate variable spatial dimension names

Version: 3.1

Definition at line 954 of file DC.h.

◆ GetTimeDimName()

string VAPoR::DC::CoordVar::GetTimeDimName ( ) const

inline

Access coordinate variable time dimension name

Version: 3.1

Definition at line 960 of file DC.h.

◆ GetUniform()

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

inline

Access coordinate variable uniform sampling flag.

Definition at line 970 of file DC.h.

◆ SetAxis()

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

inline

Definition at line 966 of file DC.h.

◆ SetDimNames()

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

inline

Definition at line 955 of file DC.h.

◆ SetTimeDimName()

void VAPoR::DC::CoordVar::SetTimeDimName ( string time_dim_name )

inline

Definition at line 961 of file DC.h.

◆ SetUniform()

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

inline

Definition at line 971 of file DC.h.

Friends And Related Function Documentation

◆ operator<<

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

friend

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

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

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CoordVar() [1/3]

◆ CoordVar() [2/3]

◆ CoordVar() [3/3]

◆ ~CoordVar()

Member Function Documentation

◆ GetAxis()

◆ GetDimNames()

◆ GetTimeDimName()

◆ GetUniform()

◆ SetAxis()

◆ SetDimNames()

◆ SetTimeDimName()

◆ SetUniform()

Friends And Related Function Documentation

◆ operator<<