Variable backends inherit from this. More...

#include <Variable.h>

Inheritance diagram for ioda::detail::Variable_Backend:

[legend]

Collaboration diagram for ioda::detail::Variable_Backend:

Public Member Functions
virtual	~Variable_Backend ()

std::vector< std::vector< Named_Variable > >	getDimensionScaleMappings (const std::list< Named_Variable > &scalesToQueryAgainst, bool firstOnly=true) const override
	Default, trivial implementation. Customizable by backends for performance. More...

VariableCreationParameters	getCreationParameters (bool doAtts=true, bool doDims=true) const override
	Default implementation. Customizable by backends for performance. More...

Public Member Functions inherited from ioda::detail::Variable_Base< Variable >
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...

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...

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 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...

Variable	write (const gsl::span< DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write the Variable. More...

Variable	write (const gsl::span< const DataType > data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write the Variable. More...

Variable	write (const std::vector< DataType > &data, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write the variable. More...

Variable	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...

Variable	writeWithEigenTensor (const EigenClass &d, const Selection &mem_selection=Selection::all, const Selection &file_selection=Selection::all)
	Write an Eigen Tensor-like object. More...

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...

Variable	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...

Variable	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...

Variable	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...

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...

Variable	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...

Variable	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...

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...

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...

virtual	~Variable_Base ()

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

Protected Member Functions
	Variable_Backend ()

Protected Member Functions inherited from ioda::detail::Variable_Base< Variable >
	Variable_Base (std::shared_ptr< Variable_Backend >)

Static Protected Member Functions
template<class Attribute_Implementation = Attribute>
static std::shared_ptr< Attribute_Backend >	_getAttributeBackend (const Attribute_Implementation &att)
	This function de-encapsulates an Attribute's backend storage object. This function is used by Variable_Backend's derivatives when accessing a Variable's Attributes. IODA-internal use only. More...

template<class Has_Attributes_Implementation = Has_Attributes>
static std::shared_ptr< Has_Attributes_Backend >	_getHasAttributesBackend (const Has_Attributes_Implementation &hatts)
	This function de-encapsulates a Has_Attributes backend storage object. IODA-internal use only. More...

Additional Inherited Members
Public Types inherited from ioda::detail::Variable_Base< Variable >
typedef detail::FillValueData_t	FillValueData_t
	Remap fill value storage type into this class. More...

Public Attributes inherited from ioda::detail::Variable_Base< Variable >
Has_Attributes	atts
	Attributes. More...

Protected Attributes inherited from ioda::detail::Variable_Base< Variable >
std::shared_ptr< Variable_Backend >	backend_
	Using an opaque object to implement the backend. More...

Detailed Description

Variable backends inherit from this.

Definition at line 710 of file Variable.h.

Constructor & Destructor Documentation

◆ ~Variable_Backend()

ioda::detail::Variable_Backend::~Variable_Backend ( )

virtualdefault

◆ Variable_Backend()

ioda::detail::Variable_Backend::Variable_Backend ( )

protected

Definition at line 358 of file Variable.cpp.

Member Function Documentation

◆ _getAttributeBackend()

template<class Attribute_Implementation = Attribute>

static std::shared_ptr<Attribute_Backend> ioda::detail::Variable_Backend::_getAttributeBackend ( const Attribute_Implementation & att )

inlinestaticprotected

This function de-encapsulates an Attribute's backend storage object. This function is used by Variable_Backend's derivatives when accessing a Variable's Attributes. IODA-internal use only.

Template Parameters

Attribute_Implementation is a dummy parameter used by Attributes.

Parameters

base	is the Attribute whose backend you want.

Returns: The encapsulated backend object.

Definition at line 733 of file Variable.h.

◆ _getHasAttributesBackend()

template<class Has_Attributes_Implementation = Has_Attributes>

static std::shared_ptr<Has_Attributes_Backend> ioda::detail::Variable_Backend::_getHasAttributesBackend ( const Has_Attributes_Implementation & hatts )

inlinestaticprotected

This function de-encapsulates a Has_Attributes backend storage object. IODA-internal use only.

Template Parameters

Has_Attributes_Implementation is a dummy parameter for template resolution.

Parameters

hatts is the Has_Attributes whose backend you want.

Returns: The encapsulated backend object.

Definition at line 744 of file Variable.h.

◆ getCreationParameters()

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

overridevirtual

Default implementation. Customizable by backends for performance.

Reimplemented from ioda::detail::Variable_Base< Variable >.

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

Definition at line 381 of file Variable.cpp.

Here is the call graph for this function:

◆ getDimensionScaleMappings()

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

overridevirtual

Default, trivial implementation. Customizable by backends for performance.

Reimplemented from ioda::detail::Variable_Base< Variable >.

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

Definition at line 360 of file Variable.cpp.

Here is the call graph for this function:

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members