Exists to prevent constructor conflicts when passing a backend into a frontend object. More...

#include <Variable.h>

Collaboration diagram for ioda::detail::Variable_Base< Variable_Implementation >:

[legend]

Public Member Functions
Type-querying Functions
virtual Type	getType () const
	Get type. More...

Type	type () const
	Get type. More...

virtual detail::Type_Provider *	getTypeProvider () const
	Query the backend and get the type provider. More...

template<class DataType >
bool	isA () const
	Convenience function to check a Variable's storage type. More...

virtual bool	isA (Type lhs) const
	Hand-off to the backend to check equivalence. More...

bool	isA (BasicTypes dataType) const
	Python compatability function. More...

bool	_py_isA2 (BasicTypes dataType)

BasicTypes	getBasicType () const
	Convenience function to query type. More...

Data Space-Querying Functions
virtual Dimensions	getDimensions () const

virtual Variable	resize (const std::vector< Dimensions_t > &newDims)
	Resize the variable. More...

virtual Variable	attachDimensionScale (unsigned int DimensionNumber, const Variable &scale)
	Attach a dimension scale to this Variable. More...

virtual Variable	detachDimensionScale (unsigned int DimensionNumber, const Variable &scale)
	Detach a dimension scale. More...

Variable	setDimScale (const std::vector< Variable > &dims)
	Set dimensions (convenience function to several invocations of attachDimensionScale). More...

Variable	setDimScale (const std::vector< Named_Variable > &dims)
	Set dimensions (convenience function to several invocations of attachDimensionScale). More...

Variable	setDimScale (const Variable &dims)
	Set dimensions (convenience function to several invocations of attachDimensionScale). More...

Variable	setDimScale (const Variable &dim1, const Variable &dim2)
	Set dimensions (convenience function to several invocations of attachDimensionScale). More...

Variable	setDimScale (const Variable &dim1, const Variable &dim2, const Variable &dim3)
	Set dimensions (convenience function to several invocations of attachDimensionScale). More...

virtual bool	isDimensionScale () const
	Is this Variable used as a dimension scale? More...

virtual Variable	setIsDimensionScale (const std::string &dimensionScaleName)
	Designate this table as a dimension scale. More...

std::string	getDimensionScaleName () const
	Get the name of this Variable's defined dimension scale. More...

virtual Variable	getDimensionScaleName (std::string &res) const

virtual bool	isDimensionScaleAttached (unsigned int DimensionNumber, const Variable &scale) const
	Is a dimension scale attached to this Variable in a certain position? More...

virtual std::vector< std::vector< Named_Variable > >	getDimensionScaleMappings (const std::list< Named_Variable > &scalesToQueryAgainst, bool firstOnly=true) const
	Which dimensions are attached at which positions? This function may offer improved performance on some backends compared to serial isDimensionScaleAttached calls. More...

Writing Data
virtual Variable	write (gsl::span< char > data, const Type &in_memory_dataType, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	The fundamental write function. Backends overload this function to implement all write operations. More...

template<class DataType , class Marshaller = Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
Variable_Implementation	write (const gsl::span< DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write the Variable. More...

template<class DataType , class Marshaller = Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
Variable_Implementation	write (const gsl::span< const DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write the Variable. More...

template<class DataType , class Marshaller = Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
Variable_Implementation	write (const std::vector< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write the variable. More...

template<class EigenClass >
Variable_Implementation	writeWithEigenRegular (const EigenClass &d, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write an Eigen object (a Matrix, an Array, a Block, a Map). More...

template<class EigenClass >
Variable_Implementation	writeWithEigenTensor (const EigenClass &d, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write an Eigen Tensor-like object. More...

Reading Data
virtual Variable	read (gsl::span< char > data, const Type &in_memory_dataType, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Read the Variable - as char array. Ordering is row-major. More...

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
Variable_Implementation	read (gsl::span< DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Read the variable into a span (range) or memory. Ordering is row-major. More...

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
Variable_Implementation	read (std::vector< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Read the variable into a vector. Resize if needed. For a non-resizing version, use a gsl::span. More...

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
std::vector< DataType >	readAsVector (const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Read the variable into a new vector. Python convenience function. More...

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>
Variable_Implementation	read (std::valarray< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Valarray read convenience function. Resize if needed. For a non-resizing version, use a gsl::span. More...

template<class EigenClass , bool Resize = detail::EigenCompat::CanResize<EigenClass>::value>
Variable_Implementation	readWithEigenRegular (EigenClass &res, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Read data into an Eigen::Array, Eigen::Matrix, Eigen::Map, etc. More...

template<class EigenClass >
Variable_Implementation	readWithEigenTensor (EigenClass &res, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const
	Read data into an Eigen::Array, Eigen::Matrix, Eigen::Map, etc. More...

template<class EigenClass >
EigenClass	_readWithEigenRegular_python (const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all) const

virtual Selections::SelectionBackend_t	instantiateSelection (const Selection &sel) const
	Convert a selection into its backend representation. More...

Public Attributes
Metadata manipulation
Has_Attributes	atts
	Attributes. More...

Protected Attributes
std::shared_ptr< Variable_Backend >	backend_
	Using an opaque object to implement the backend. More...

Querying Functions for Fill Values, Chunking and Compression
typedef detail::FillValueData_t	FillValueData_t
	Remap fill value storage type into this class. More...

virtual VariableCreationParameters	getCreationParameters (bool doAtts=true, bool doDims=true) const
	Convenience function to get fill value, attributes, chunk sizes, and compression in a collective call. More...

virtual bool	hasFillValue () const
	Check if a variable has a fill value set. More...

virtual FillValueData_t	getFillValue () const
	Retrieve the fill value. More...

virtual std::vector< Dimensions_t >	getChunkSizes () const
	Retrieve the chunking options for the Variable. More...

virtual std::pair< bool, int >	getGZIPCompression () const
	Retrieve the GZIP compression options for the Variable. More...

virtual std::tuple< bool, unsigned, unsigned >	getSZIPCompression () const
	Retrieve the SZIP compression options for the Variable. More...

General Functions
	Variable_Base (std::shared_ptr< Variable_Backend >)

virtual	~Variable_Base ()

std::shared_ptr< Variable_Backend >	get () const
	Gets a handle to the underlying object that implements the backend functionality. More...

Detailed Description

template<class Variable_Implementation = Variable>
class ioda::detail::Variable_Base< Variable_Implementation >

Exists to prevent constructor conflicts when passing a backend into a frontend object.

Bug:: Need to add a virtual resize function.

Definition at line 53 of file Variable.h.

Member Typedef Documentation

◆ FillValueData_t

template<class Variable_Implementation = Variable>

typedef detail::FillValueData_t ioda::detail::Variable_Base< Variable_Implementation >::FillValueData_t

Remap fill value storage type into this class.

Definition at line 135 of file Variable.h.

Constructor & Destructor Documentation

◆ Variable_Base()

ioda::detail::Variable_Base::Variable_Base ( std::shared_ptr< Variable_Backend > backend )

protected

Definition at line 15 of file Variable.cpp.

◆ ~Variable_Base()

ioda::detail::Variable_Base::~Variable_Base ( )

virtualdefault

Member Function Documentation

◆ _py_isA2()

template<class Variable_Implementation = Variable>

bool ioda::detail::Variable_Base< Variable_Implementation >::_py_isA2 ( BasicTypes dataType )

inline

Definition at line 110 of file Variable.h.

Here is the call graph for this function:

◆ _readWithEigenRegular_python()

template<class Variable_Implementation = Variable>

template<class EigenClass >

EigenClass ioda::detail::Variable_Base< Variable_Implementation >::_readWithEigenRegular_python	(	const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Definition at line 640 of file Variable.h.

Here is the call graph for this function:

◆ attachDimensionScale()

Variable ioda::detail::Variable_Base::attachDimensionScale	(	unsigned int	DimensionNumber,
		const Variable &	scale
	)

virtual

Attach a dimension scale to this Variable.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 184 of file Variable.cpp.

Here is the caller graph for this function:

◆ detachDimensionScale()

Variable ioda::detail::Variable_Base::detachDimensionScale	(	unsigned int	DimensionNumber,
		const Variable &	scale
	)

virtual

Detach a dimension scale.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 198 of file Variable.cpp.

Here is the caller graph for this function:

◆ get()

std::shared_ptr< Variable_Backend > ioda::detail::Variable_Base::get

Gets a handle to the underlying object that implements the backend functionality.

Definition at line 21 of file Variable.cpp.

Here is the caller graph for this function:

◆ getBasicType()

template<class Variable_Implementation = Variable>

BasicTypes ioda::detail::Variable_Base< Variable_Implementation >::getBasicType ( ) const

Convenience function to query type.

◆ getChunkSizes()

std::vector< Dimensions_t > ioda::detail::Variable_Base::getChunkSizes

virtual

Retrieve the chunking options for the Variable.

Note: Not all backends support chunking, but they should all store the desired chunk size information in case the Variable is copied to a new backend.

Returns: a vector containing the chunk sizes.; an empty vector if chunking is not used.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 123 of file Variable.cpp.

Here is the caller graph for this function:

◆ getCreationParameters()

VariableCreationParameters ioda::detail::Variable_Base::getCreationParameters	(	bool	doAtts = `true`,
		bool	doDims = `true`
	)		const

virtual

Convenience function to get fill value, attributes, chunk sizes, and compression in a collective call.

This function has better performance on some engines for bulk operations than calling separately.

Parameters

doAtts	includes attributes in the creation parameters.
doDims	includes dimension scales in the creation parameters. Although dimensions are attributes on some backends, we treat them separately in this function.

Returns: the filled-in VariableCreationParameters object

Reimplemented in ioda::detail::Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 85 of file Variable.cpp.

◆ getDimensions()

Dimensions ioda::detail::Variable_Base::getDimensions

virtual

Get current and maximum dimensions, and number of total points.

Note: In Python, see the dims property.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 160 of file Variable.cpp.

Here is the caller graph for this function:

◆ getDimensionScaleMappings()

std::vector< std::vector< Named_Variable > > ioda::detail::Variable_Base::getDimensionScaleMappings	(	const std::list< Named_Variable > &	scalesToQueryAgainst,
		bool	firstOnly = `true`
	)		const

virtual

Which dimensions are attached at which positions? This function may offer improved performance on some backends compared to serial isDimensionScaleAttached calls.

Parameters

scalesToQueryAgainst	is a vector containing the scales. You can pass in "tagged" strings that map the Variable to a name. If you do not pass in a scale to check against, then this scale will not be checked and will not be present in the function output.
firstOnly	is specified when only one dimension can be attached to each axis (the default).

Returns: a vector with the same length as the variable's dimensionality. Each variable dimension in the vector can have one or more attached scales. These scales are returned as their own, inner, vector of pair<string, Variable>.

Reimplemented in ioda::detail::Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 303 of file Variable.cpp.

Here is the caller graph for this function:

◆ getDimensionScaleName() [1/2]

template<class Variable_Implementation = Variable>

std::string ioda::detail::Variable_Base< Variable_Implementation >::getDimensionScaleName ( ) const

inline

Get the name of this Variable's defined dimension scale.

Definition at line 217 of file Variable.h.

Here is the caller graph for this function:

◆ getDimensionScaleName() [2/2]

Variable ioda::detail::Variable_Base::getDimensionScaleName ( std::string & res ) const

virtual

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 276 of file Variable.cpp.

◆ getFillValue()

Variable_Base::FillValueData_t ioda::detail::Variable_Base::getFillValue

virtual

Retrieve the fill value.

Returns: an object of type FillValueData_t that stores the fill value. If there is no fill value, then FillValueData_t::set_ will equal false. The fill value data will be stored in FillValueData_t::fillValue_ (for simple types), or in FillValueData_t::stringFillValue_ (for strings only).

Note: Recommend querying isA to make sure that you are reading the fill value as the correct type.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 111 of file Variable.cpp.

Here is the caller graph for this function:

◆ getGZIPCompression()

std::pair< bool, int > ioda::detail::Variable_Base::getGZIPCompression

virtual

Retrieve the GZIP compression options for the Variable.

Note: Not all backends support compression (and those that do also require chunking support). They should store this information anyways, in case the Variable is copied to a new backend.

Returns: a pair indicating 1) whether GZIP is requested and 2) the compression level that is desired.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 136 of file Variable.cpp.

Here is the caller graph for this function:

◆ getSZIPCompression()

std::tuple< bool, unsigned, unsigned > ioda::detail::Variable_Base::getSZIPCompression

virtual

Retrieve the SZIP compression options for the Variable.

Note: Not all backends support compression (and those that do also require chunking support). They should store this information anyways, in case the Variable is copied to a new backend.

Returns: a tuple indicating 1) whether SZIP is requested, 2) PixelsPerBlock, and 3) general SZIP filter option flags.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 148 of file Variable.cpp.

Here is the caller graph for this function:

◆ getType()

Type ioda::detail::Variable_Base::getType

virtual

Get type.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 49 of file Variable.cpp.

Here is the caller graph for this function:

◆ getTypeProvider()

detail::Type_Provider * ioda::detail::Variable_Base::getTypeProvider

virtual

Query the backend and get the type provider.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 37 of file Variable.cpp.

Here is the caller graph for this function:

◆ hasFillValue()

bool ioda::detail::Variable_Base::hasFillValue

virtual

Check if a variable has a fill value set.

Returns: true if a fill value is set, false otherwise.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 98 of file Variable.cpp.

Here is the caller graph for this function:

◆ instantiateSelection()

Selections::SelectionBackend_t ioda::detail::Variable_Base::instantiateSelection ( const Selection & sel ) const

virtual

Convert a selection into its backend representation.

Parameters

sel	is the frontend selection.

Returns: The cached backend selection.

Reimplemented in ioda::detail::Engines::HH::HH_Variable.

Definition at line 344 of file Variable.cpp.

Here is the caller graph for this function:

◆ isA() [1/3]

template<class Variable_Implementation = Variable>

template<class DataType >

bool ioda::detail::Variable_Base< Variable_Implementation >::isA ( ) const

inline

Convenience function to check a Variable's storage type.

Parameters

DataType is the type of the data. I.e. float, int, int32_t, uint16_t, std::string, etc.

Returns: True if the type matches; False (0) if the type does not match

Exceptions

jedi::xError if an error occurred.

Definition at line 99 of file Variable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isA() [2/3]

template<class Variable_Implementation = Variable>

bool ioda::detail::Variable_Base< Variable_Implementation >::isA ( BasicTypes dataType ) const

inline

Python compatability function.

Definition at line 108 of file Variable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isA() [3/3]

bool ioda::detail::Variable_Base::isA ( Type lhs ) const

virtual

Hand-off to the backend to check equivalence.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 26 of file Variable.cpp.

◆ isDimensionScale()

bool ioda::detail::Variable_Base::isDimensionScale

virtual

Is this Variable used as a dimension scale?

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 251 of file Variable.cpp.

Here is the caller graph for this function:

◆ isDimensionScaleAttached()

bool ioda::detail::Variable_Base::isDimensionScaleAttached	(	unsigned int	DimensionNumber,
		const Variable &	scale
	)		const

virtual

Is a dimension scale attached to this Variable in a certain position?

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 288 of file Variable.cpp.

Here is the caller graph for this function:

◆ read() [1/4]

Variable ioda::detail::Variable_Base::read	(	gsl::span< char >	data,
		const Type &	in_memory_dataType,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

virtual

Read the Variable - as char array. Ordering is row-major.

This is the fundamental read function that has to be implemented.

Parameters

data	is a byte-array that will hold the read data.
in_memory_dataType	describes how ioda should arrange the read data in memory. As floats? As doubles? Strings?
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Note: Ensure that the correct dimension ordering is preserved; With default parameters, the entire Variable is read

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 330 of file Variable.cpp.

Here is the caller graph for this function:

◆ read() [2/4]

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::read	(	gsl::span< DataType >	data,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Read the variable into a span (range) or memory. Ordering is row-major.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

data	is a byte-array that will hold the read data.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Todo:: Add in the dataspaces!

Definition at line 443 of file Variable.h.

Here is the call graph for this function:

◆ read() [3/4]

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::read	(	std::valarray< DataType > &	data,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Valarray read convenience function. Resize if needed. For a non-resizing version, use a gsl::span.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

data	is a valarray acting as a data buffer that is filled with the metadata's contents. It gets resized as needed.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Returns: Another instance of this Attribute. Used for operation chaining.

Note: data will be stored in row-major order.

Bug:: Resize only if needed, and resize to the proper extent depending on mem_selection and file_selection.

Definition at line 525 of file Variable.h.

Here is the call graph for this function:

◆ read() [4/4]

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::read	(	std::vector< DataType > &	data,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Read the variable into a vector. Resize if needed. For a non-resizing version, use a gsl::span.

Ordering is row-major.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

data	is a byte-array that will hold the read data.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Bug:: Resize only if needed, and resize to the proper extent depending on mem_selection and file_selection.

Definition at line 483 of file Variable.h.

Here is the call graph for this function:

◆ readAsVector()

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = ioda::Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

std::vector<DataType> ioda::detail::Variable_Base< Variable_Implementation >::readAsVector	(	const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Read the variable into a new vector. Python convenience function.

Bug:: Get correct size based on selection operands.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Definition at line 502 of file Variable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readWithEigenRegular()

template<class Variable_Implementation = Variable>

template<class EigenClass , bool Resize = detail::EigenCompat::CanResize<EigenClass>::value>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::readWithEigenRegular	(	EigenClass &	res,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Read data into an Eigen::Array, Eigen::Matrix, Eigen::Map, etc.

Template Parameters

EigenClass	is a template pointing to the Eigen object. This template must provide the EigenClass::Scalar typedef.
Resize	indicates whether the Eigen object should be resized if there is a dimension mismatch. Not all Eigen objects can be resized.

Parameters

res	is the Eigen object.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Returns: Another instance of this Variable. Used for operation chaining.

Exceptions

ioda::xError	if the variable's dimensionality is too high.
ioda::xError	if resize = false and there is a dimension mismatch.

Note: When reading in a 1-D object, the data are read as a column vector.

Bug:: Resize only if needed, and resize to the proper extent depending on mem_selection and file_selection.

Definition at line 551 of file Variable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readWithEigenTensor()

template<class Variable_Implementation = Variable>

template<class EigenClass >

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::readWithEigenTensor	(	EigenClass &	res,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)		const

inline

Read data into an Eigen::Array, Eigen::Matrix, Eigen::Map, etc.

Template Parameters

EigenClass is a template pointing to the Eigen object. This template must provide the EigenClass::Scalar typedef.

Parameters

res	is the Eigen object.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Returns: Another instance of this Variable. Used for operation chaining.

Exceptions

jedi::xError if there is a size mismatch.

Note: When reading in a 1-D object, the data are read as a column vector.

Definition at line 615 of file Variable.h.

Here is the call graph for this function:

◆ resize()

Variable ioda::detail::Variable_Base::resize ( const std::vector< Dimensions_t > & newDims )

virtual

Resize the variable.

Note: Not all variables are resizable. This depends on backend support. For HDF5, the variable must be chunked and must not exceed max_dims.; Bad things may happen if a variable's dimension scales have different lengths than its dimensions. Resize them together, preferably using the ObsSpace resize function.

See also: ObsSpace::resize

Parameters

newDims are the new dimensions.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 172 of file Variable.cpp.

Here is the caller graph for this function:

◆ setDimScale() [1/5]

Variable ioda::detail::Variable_Base::setDimScale ( const std::vector< Named_Variable > & dims )

Set dimensions (convenience function to several invocations of attachDimensionScale).

Definition at line 225 of file Variable.cpp.

◆ setDimScale() [2/5]

Variable ioda::detail::Variable_Base::setDimScale ( const std::vector< Variable > & dims )

Set dimensions (convenience function to several invocations of attachDimensionScale).

Definition at line 212 of file Variable.cpp.

Here is the caller graph for this function:

◆ setDimScale() [3/5]

Variable ioda::detail::Variable_Base::setDimScale	(	const Variable &	dim1,
		const Variable &	dim2
	)

Set dimensions (convenience function to several invocations of attachDimensionScale).

Definition at line 241 of file Variable.cpp.

◆ setDimScale() [4/5]

Variable ioda::detail::Variable_Base::setDimScale	(	const Variable &	dim1,
		const Variable &	dim2,
		const Variable &	dim3
	)

Set dimensions (convenience function to several invocations of attachDimensionScale).

Definition at line 245 of file Variable.cpp.

◆ setDimScale() [5/5]

Variable ioda::detail::Variable_Base::setDimScale ( const Variable & dims )

Set dimensions (convenience function to several invocations of attachDimensionScale).

Definition at line 237 of file Variable.cpp.

◆ setIsDimensionScale()

Variable ioda::detail::Variable_Base::setIsDimensionScale ( const std::string & dimensionScaleName )

virtual

Designate this table as a dimension scale.

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 264 of file Variable.cpp.

Here is the caller graph for this function:

◆ type()

template<class Variable_Implementation = Variable>

Type ioda::detail::Variable_Base< Variable_Implementation >::type ( ) const

inline

Get type.

Definition at line 88 of file Variable.h.

Here is the call graph for this function:

◆ write() [1/4]

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::write	(	const gsl::span< const DataType >	data,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)

inline

Write the Variable.

Note: Ensure that the correct dimension ordering is preserved.; With default parameters, the entire Variable is written.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

data	is a span of data.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Exceptions

ioda::xError if data has the wrong size.

Returns: The variable (for chaining).

Definition at line 311 of file Variable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/4]

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::write	(	const gsl::span< DataType >	data,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)

inline

Write the Variable.

Note: Ensure that the correct dimension ordering is preserved.; With default parameters, the entire Variable is written.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

data	is a span of data.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Exceptions

ioda::xError if data has the wrong size.

Returns: The variable (for chaining).

Definition at line 281 of file Variable.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [3/4]

template<class Variable_Implementation = Variable>

template<class DataType , class Marshaller = Object_Accessor<DataType>, class TypeWrapper = Types::GetType_Wrapper<DataType>>

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::write	(	const std::vector< DataType > &	data,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)

inline

Write the variable.

Template Parameters

DataType	is the type of the data to be written.
Marshaller	is a class that serializes / deserializes data.
TypeWrapper	translates DataType into a form that the backend understands.

Parameters

data	is a span of data.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Exceptions

ioda::xError if data has the wrong size.

Returns: The variable (for chaining).

Definition at line 340 of file Variable.h.

Here is the caller graph for this function:

◆ write() [4/4]

Variable ioda::detail::Variable_Base::write	(	gsl::span< char >	data,
		const Type &	in_memory_dataType,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)

virtual

The fundamental write function. Backends overload this function to implement all write operations.

This function writes a span of bytes (characters) to the backend attribute storage. No type conversions take place here (see the templated conversion function, below).

Parameters

data	is a span of data.
in_memory_datatype	is an opaque (backend-level) object that describes the placement of the data in memory. Usually ignorable - needed for complex data structures.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Exceptions

ioda::xError if data has the wrong size.

Returns: The variable (for chaining).

Reimplemented in ioda::Engines::ObsStore::ObsStore_Variable_Backend, and ioda::detail::Engines::HH::HH_Variable.

Definition at line 317 of file Variable.cpp.

Here is the caller graph for this function:

◆ writeWithEigenRegular()

template<class Variable_Implementation = Variable>

template<class EigenClass >

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::writeWithEigenRegular	(	const EigenClass &	d,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)

inline

Write an Eigen object (a Matrix, an Array, a Block, a Map).

Template Parameters

EigenClass is the type of the Eigen object being written.

Parameters

d	is the data to be written.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Exceptions

ioda::xError on a dimension mismatch.

Returns: the variable

Definition at line 361 of file Variable.h.

Here is the caller graph for this function:

◆ writeWithEigenTensor()

template<class Variable_Implementation = Variable>

template<class EigenClass >

Variable_Implementation ioda::detail::Variable_Base< Variable_Implementation >::writeWithEigenTensor	(	const EigenClass &	d,
		const Selection &	mem_selection = `Selection::all`,
		const Selection &	file_selection = `Selection::all`
	)

inline

Write an Eigen Tensor-like object.

Template Parameters

EigenClass is the type of the Eigen object being written.

Parameters

d	is the data to be written.
mem_selection	is the user's memory layout representing the location where the data is read from.
file_selection	is the backend's memory layout representing the location where the data are written to.

Exceptions

ioda::xError on a dimension mismatch.

Returns: the variable

Definition at line 393 of file Variable.h.

Here is the call graph for this function:

Member Data Documentation

◆ atts

template<class Variable_Implementation = Variable>

Has_Attributes ioda::detail::Variable_Base< Variable_Implementation >::atts

Attributes.

Definition at line 71 of file Variable.h.

◆ backend_

template<class Variable_Implementation = Variable>

std::shared_ptr<Variable_Backend> ioda::detail::Variable_Base< Variable_Implementation >::backend_

protected

Using an opaque object to implement the backend.

Definition at line 56 of file Variable.h.

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

Public Member Functions

Public Attributes

Protected Attributes

Querying Functions for Fill Values, Chunking and Compression

General Functions

Detailed Description

template<class Variable_Implementation = Variable> class ioda::detail::Variable_Base< Variable_Implementation >

Member Typedef Documentation

◆ FillValueData_t

Constructor & Destructor Documentation

◆ Variable_Base()

◆ ~Variable_Base()

Member Function Documentation

◆ _py_isA2()

◆ _readWithEigenRegular_python()

◆ attachDimensionScale()

◆ detachDimensionScale()

◆ get()

◆ getBasicType()

◆ getChunkSizes()

◆ getCreationParameters()

◆ getDimensions()

◆ getDimensionScaleMappings()

◆ getDimensionScaleName() [1/2]

◆ getDimensionScaleName() [2/2]

◆ getFillValue()

◆ getGZIPCompression()

◆ getSZIPCompression()

◆ getType()

◆ getTypeProvider()

◆ hasFillValue()

◆ instantiateSelection()

◆ isA() [1/3]

◆ isA() [2/3]

◆ isA() [3/3]

◆ isDimensionScale()

◆ isDimensionScaleAttached()

◆ read() [1/4]

◆ read() [2/4]

◆ read() [3/4]

◆ read() [4/4]

◆ readAsVector()

◆ readWithEigenRegular()

◆ readWithEigenTensor()

◆ resize()

◆ setDimScale() [1/5]

◆ setDimScale() [2/5]

◆ setDimScale() [3/5]

◆ setDimScale() [4/5]

◆ setDimScale() [5/5]

◆ setIsDimensionScale()

◆ type()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]

◆ writeWithEigenRegular()

◆ writeWithEigenTensor()

Member Data Documentation

◆ atts

◆ backend_

template<class Variable_Implementation = Variable>
class ioda::detail::Variable_Base< Variable_Implementation >