#include <Variables.hpp>

Inheritance diagram for ioda::ObsStore::Variable:

Collaboration diagram for ioda::ObsStore::Variable:

[legend]

Public Member Functions
	Variable ()

	Variable (const std::vector< Dimensions_t > &dimensions, const std::vector< Dimensions_t > &max_dimensions, const ObsTypes &dtype, const VarCreateParams &params)

	~Variable ()

std::vector< Dimensions_t >	get_dimensions () const
	returns dimension sizes More...

std::vector< Dimensions_t >	get_max_dimensions () const
	returns maximum dimension sizes More...

void	resize (const std::vector< Dimensions_t > &new_dim_sizes)
	resizes dimensions (but cannot change dimensions themselves) More...

bool	isOfType (ObsTypes dtype) const
	returns true if requested type matches stored type More...

std::pair< ObsTypes, size_t >	dtype () const
	returns the data type. More...

bool	hasFillValue () const
	Is there an associated fill value? More...

detail::FillValueData_t	getFillValue () const
	Get the fill value. More...

void	attachDimensionScale (const std::size_t dim_number, const std::shared_ptr< Variable > scale)
	attach another variable to serve as a scale (holds coordinate values) More...

void	detachDimensionScale (const std::size_t dim_number, const std::shared_ptr< Variable > scale)
	detach another variable that is servingas a scale (coordinate values) More...

bool	isDimensionScale () const
	returns true if this is being used as a scale for another variable More...

void	setIsDimensionScale (const std::string &name)
	set this variable as a dimension scale More...

void	getDimensionScaleName (std::string &name) const
	get the dimension scale name More...

bool	isDimensionScaleAttached (const std::size_t dim_number, const std::shared_ptr< Variable > scale) const
	return true if the scale is attached to this variable More...

std::shared_ptr< Variable >	write (gsl::span< char > data, ObsTypes dtype, Selection &m_select, Selection &f_select)
	transfer data to variable storage More...

std::shared_ptr< Variable >	read (gsl::span< char > data, ObsTypes dtype, Selection &m_select, Selection &f_select)
	transfer data from variable storage More...

Public Attributes
std::shared_ptr< Has_Attributes >	atts
	container for variable attributes More...

std::shared_ptr< Has_Attributes >	impl_atts
	implementation-specific attribute storage. Fill values, chunking, compression settings, etc. Stuff that shouldn't be directly visible to the client without using a dedicated function. More...

Private Attributes
std::vector< Dimensions_t >	dimensions_
	dimension sizes (length is rank of dimensions) More...

std::vector< Dimensions_t >	max_dimensions_
	maximum dimension sizes (for resizing) More...

ObsTypes	dtype_ = ObsTypes::NOTYPE
	ObsStore data type. More...

std::size_t	dtype_size_ = 0
	ObsStore data type. More...

detail::FillValueData_t	fvdata_
	Fill value information. More...

std::unique_ptr< VarAttrStore_Base >	var_data_
	container for variable data values More...

std::vector< std::shared_ptr< Variable > >	dim_scales_
	pointers to associated dimension scales More...

bool	is_scale_ = false
	true if this variable is a dimension scale More...

std::string	scale_name_
	alias for this variable when it is serving as a dimension scale More...

Detailed Description

Definition at line 49 of file Variables.hpp.

Constructor & Destructor Documentation

◆ Variable() [1/2]

ioda::ObsStore::Variable::Variable ( )

inline

Definition at line 76 of file Variables.hpp.

◆ Variable() [2/2]

ioda::ObsStore::Variable::Variable	(	const std::vector< Dimensions_t > &	dimensions,
		const std::vector< Dimensions_t > &	max_dimensions,
		const ObsTypes &	dtype,
		const VarCreateParams &	params
	)

Definition at line 28 of file Variables.cpp.

Here is the call graph for this function:

◆ ~Variable()

ioda::ObsStore::Variable::~Variable ( )

inline

Definition at line 80 of file Variables.hpp.

Member Function Documentation

◆ attachDimensionScale()

void ioda::ObsStore::Variable::attachDimensionScale	(	const std::size_t	dim_number,
		const std::shared_ptr< Variable >	scale
	)

attach another variable to serve as a scale (holds coordinate values)

Parameters

dim_number	dimension (by position) of which scale is associated
scale	variable serving as a scale

Definition at line 102 of file Variables.cpp.

◆ detachDimensionScale()

void ioda::ObsStore::Variable::detachDimensionScale	(	const std::size_t	dim_number,
		const std::shared_ptr< Variable >	scale
	)

detach another variable that is servingas a scale (coordinate values)

Parameters

dim_number	dimension (by position) of which scale is associated
scale	variable serving as a scale

Definition at line 107 of file Variables.cpp.

Here is the call graph for this function:

◆ dtype()

std::pair<ObsTypes, size_t> ioda::ObsStore::Variable::dtype ( ) const

inline

returns the data type.

Definition at line 99 of file Variables.hpp.

Here is the caller graph for this function:

◆ get_dimensions()

std::vector< Dimensions_t > ioda::ObsStore::Variable::get_dimensions ( ) const

returns dimension sizes

Definition at line 60 of file Variables.cpp.

◆ get_max_dimensions()

std::vector< Dimensions_t > ioda::ObsStore::Variable::get_max_dimensions ( ) const

returns maximum dimension sizes

Definition at line 62 of file Variables.cpp.

◆ getDimensionScaleName()

void ioda::ObsStore::Variable::getDimensionScaleName ( std::string & name ) const

get the dimension scale name

Parameters

name	name for this dimension scale

Definition at line 122 of file Variables.cpp.

◆ getFillValue()

detail::FillValueData_t ioda::ObsStore::Variable::getFillValue ( ) const

Get the fill value.

Definition at line 100 of file Variables.cpp.

◆ hasFillValue()

bool ioda::ObsStore::Variable::hasFillValue ( ) const

Is there an associated fill value?

Returns: true if yes, false if no.

Definition at line 98 of file Variables.cpp.

◆ isDimensionScale()

bool ioda::ObsStore::Variable::isDimensionScale ( ) const

returns true if this is being used as a scale for another variable

Definition at line 115 of file Variables.cpp.

◆ isDimensionScaleAttached()

bool ioda::ObsStore::Variable::isDimensionScaleAttached	(	const std::size_t	dim_number,
		const std::shared_ptr< Variable >	scale
	)		const

return true if the scale is attached to this variable

Parameters

name	name for this dimension scale

Definition at line 124 of file Variables.cpp.

◆ isOfType()

bool ioda::ObsStore::Variable::isOfType ( ObsTypes dtype ) const

returns true if requested type matches stored type

Definition at line 96 of file Variables.cpp.

Here is the call graph for this function:

◆ read()

std::shared_ptr< Variable > ioda::ObsStore::Variable::read	(	gsl::span< char >	data,
		ObsTypes	dtype,
		Selection &	m_select,
		Selection &	f_select
	)

transfer data from variable storage

Parameters

data	contiguous block of data to transfer
m_select	Selection ojbect: how to select to data argument
f_select	Selection ojbect: how to select from variable storage

Definition at line 138 of file Variables.cpp.

Here is the call graph for this function:

◆ resize()

void ioda::ObsStore::Variable::resize ( const std::vector< Dimensions_t > & new_dim_sizes )

resizes dimensions (but cannot change dimensions themselves)

Parameters

new_dim_sizes new extents for each dimension

Definition at line 64 of file Variables.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsDimensionScale()

void ioda::ObsStore::Variable::setIsDimensionScale ( const std::string & name )

set this variable as a dimension scale

Parameters

name	name for this dimension scale

Definition at line 117 of file Variables.cpp.

◆ write()

std::shared_ptr< Variable > ioda::ObsStore::Variable::write	(	gsl::span< char >	data,
		ObsTypes	dtype,
		Selection &	m_select,
		Selection &	f_select
	)

transfer data to variable storage

Parameters

data	contiguous block of data to transfer
m_select	Selection ojbect: how to select from data argument
f_select	Selection ojbect: how to select to variable storage

Definition at line 129 of file Variables.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ atts

std::shared_ptr<Has_Attributes> ioda::ObsStore::Variable::atts

container for variable attributes

Definition at line 83 of file Variables.hpp.

◆ dim_scales_

std::vector<std::shared_ptr<Variable> > ioda::ObsStore::Variable::dim_scales_

private

pointers to associated dimension scales

Definition at line 67 of file Variables.hpp.

◆ dimensions_

std::vector<Dimensions_t> ioda::ObsStore::Variable::dimensions_

private

dimension sizes (length is rank of dimensions)

Definition at line 52 of file Variables.hpp.

◆ dtype_

ObsTypes ioda::ObsStore::Variable::dtype_ = ObsTypes::NOTYPE

private

ObsStore data type.

Definition at line 56 of file Variables.hpp.

◆ dtype_size_

std::size_t ioda::ObsStore::Variable::dtype_size_ = 0

private

ObsStore data type.

Definition at line 58 of file Variables.hpp.

◆ fvdata_

detail::FillValueData_t ioda::ObsStore::Variable::fvdata_

private

Fill value information.

Definition at line 61 of file Variables.hpp.

◆ impl_atts

std::shared_ptr<Has_Attributes> ioda::ObsStore::Variable::impl_atts

implementation-specific attribute storage. Fill values, chunking, compression settings, etc. Stuff that shouldn't be directly visible to the client without using a dedicated function.

Definition at line 87 of file Variables.hpp.

◆ is_scale_

bool ioda::ObsStore::Variable::is_scale_ = false

private

true if this variable is a dimension scale

Definition at line 70 of file Variables.hpp.

◆ max_dimensions_

std::vector<Dimensions_t> ioda::ObsStore::Variable::max_dimensions_

private

maximum dimension sizes (for resizing)

Definition at line 54 of file Variables.hpp.

◆ scale_name_

std::string ioda::ObsStore::Variable::scale_name_

private

alias for this variable when it is serving as a dimension scale

Definition at line 73 of file Variables.hpp.

◆ var_data_

std::unique_ptr<VarAttrStore_Base> ioda::ObsStore::Variable::var_data_

private

container for variable data values

Definition at line 64 of file Variables.hpp.

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

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Variable() [1/2]

◆ Variable() [2/2]

◆ ~Variable()

Member Function Documentation

◆ attachDimensionScale()

◆ detachDimensionScale()

◆ dtype()

◆ get_dimensions()

◆ get_max_dimensions()

◆ getDimensionScaleName()

◆ getFillValue()

◆ hasFillValue()

◆ isDimensionScale()

◆ isDimensionScaleAttached()

◆ isOfType()

◆ read()

◆ resize()

◆ setIsDimensionScale()

◆ write()

Member Data Documentation

◆ atts

◆ dim_scales_

◆ dimensions_

◆ dtype_

◆ dtype_size_

◆ fvdata_

◆ impl_atts

◆ is_scale_

◆ max_dimensions_

◆ scale_name_

◆ var_data_