Variables, Data Access, and Selections

The main data storage methods and objects in IODA. More...

Collaboration diagram for Variables, Data Access, and Selections:

Files
file	Fill.h
	Fill value getters and setters.
file	FillPolicy.h
	Default fill values for ioda files.
file	Has_Variables.h
	Interfaces for ioda::Has_Variables and related classes.
file	Selection.h
	Dataspace selections for reading and writing ioda::Variable data.
file	src/engines/ioda/include/ioda/Variables/Variable.h
	Interfaces for ioda::Variable and related classes.

Classes
struct	ioda::Dimensions
	Describes the dimensions of an Attribute or Variable. More...
struct	ioda::detail::FillValueData_t
	Container used to store and manipulate fill values. More...
struct	ioda::VariableCreationParameters
	Used to specify Variable creation-time properties. More...
class	ioda::detail::Has_Variables_Base
class	ioda::Has_Variables
	This class exists inside of ioda::Group and provides the interface to manipulating Variables. More...
struct	ioda::Selections::InstantiatedSelection
	An opaque object used to store a selection for direct processing by a backend. More...
class	ioda::Selection
	A Selection represents the bounds of the data, in ioda or in userspace, that you are reading or writing. More...
struct	ioda::Selection::SingleSelection
	Represents a hyperslab or a series of points in a selection, coupled with a SelectionOperator "action". More...
class	ioda::detail::Variable_Base< Variable_Implementation >
	Exists to prevent constructor conflicts when passing a backend into a frontend object. More...
class	ioda::Variable
	Variables store data! More...

Typedefs
typedef std::shared_ptr< InstantiatedSelection >	ioda::Selections::SelectionBackend_t
typedef std::vector< Dimensions_t >	ioda::Selection::VecDimensions_t

Enumerations
enum class	ioda::FillValuePolicy { ioda::HDF5 , ioda::NETCDF4 }
	This option describes the default fill values that will be used if the user does not manually specify a fill value. More...
enum class	ioda::SelectionOperator {   ioda::SET , ioda::OR , ioda::AND , ioda::XOR ,   ioda::NOT_B , ioda::NOT_A , ioda::APPEND , ioda::PREPEND }
	Selection enum. More...
enum class	ioda::SelectionState { ioda::ALL , ioda::NONE }
	The "default" for the selection. More...

Functions
template<class T >
T	ioda::detail::getFillValue (FillValueData_t &data)
template<>
std::string	ioda::detail::getFillValue (FillValueData_t &data)
template<class T >
void	ioda::detail::assignFillValue (FillValueData_t &data, T val)
template<>
void	ioda::detail::assignFillValue< std::string > (FillValueData_t &data, std::string val)
template<class T >
T	ioda::FillValuePolicies::netCDF4_default ()
template<class T >
void	ioda::FillValuePolicies::applyFillValuePolicy (FillValuePolicy pol, detail::FillValueData_t &fvd)
	Applies the fill value policy. This sets default fill values when fill values are not already provided. More...
virtual	ioda::Selections::InstantiatedSelection::~InstantiatedSelection ()
	ioda::Selection::SingleSelection::SingleSelection (SelectionOperator op, const VecDimensions_t &start, const VecDimensions_t &count, const VecDimensions_t &stride={}, const VecDimensions_t &block={})
	ioda::Selection::SingleSelection::SingleSelection (SelectionOperator op, const std::vector< VecDimensions_t > &points)
	ioda::Selection::SingleSelection::SingleSelection (SelectionOperator op, size_t dimension, const VecDimensions_t &indices_starts, const VecDimensions_t &indices_counts={})
	ioda::Selection::SingleSelection::SingleSelection ()
	ioda::Selection::Selection (const VecDimensions_t &extent={}, SelectionState sel=SelectionState::ALL)
	ioda::Selection::~Selection ()
Selection &	ioda::Selection::setOffset (const std::vector< Dimensions_t > &newOffset)
	Shift the selection by an offset. More...
const VecDimensions_t &	ioda::Selection::getOffset () const
Selection &	ioda::Selection::select (const SingleSelection &s)
	Append a new selection. More...
const std::vector< SingleSelection > &	ioda::Selection::getActions () const
SelectionState	ioda::Selection::getDefault () const
Selection &	ioda::Selection::extent (const VecDimensions_t &sz)
	Provide the dimensions of the object that you are selecting from. More...
const VecDimensions_t &	ioda::Selection::extent () const
Selections::SelectionBackend_t	ioda::Selection::concretize (const Variable &) const
	Talk to the backend and generate the appropriate selection object. More...
Selections::SelectionBackend_t	ioda::Selection::concretize () const
	Return the cached selection object. More...
void	ioda::Selection::concretize (Selections::SelectionBackend_t newobj) const
bool	ioda::Selection::isConcretized () const
	Is the selection already cached in the backend? More...
void	ioda::Selection::invalidate () const
	Ditch the concretized selection. More...

Variables
SelectionOperator	ioda::Selection::SingleSelection::op_
VecDimensions_t	ioda::Selection::SingleSelection::start_
VecDimensions_t	ioda::Selection::SingleSelection::count_
VecDimensions_t	ioda::Selection::SingleSelection::stride_
VecDimensions_t	ioda::Selection::SingleSelection::block_
std::vector< VecDimensions_t >	ioda::Selection::SingleSelection::points_
size_t	ioda::Selection::SingleSelection::dimension_
VecDimensions_t	ioda::Selection::SingleSelection::dimension_indices_starts_
VecDimensions_t	ioda::Selection::SingleSelection::dimension_indices_counts_
static IODA_DL const Selection	ioda::Selection::all
static IODA_DL const Selection	ioda::Selection::none
Selections::SelectionBackend_t	ioda::Selection::backend_
	Using an opaque object to implement a cache of the Selection for a backend. More...
SelectionState	ioda::Selection::default_
std::vector< SingleSelection >	ioda::Selection::actions_
VecDimensions_t	ioda::Selection::offset_
	The offset is a way to quickly shift the selection. More...
VecDimensions_t	ioda::Selection::extent_
	The extent is the dimensions of the object that you are selecting from. More...

Detailed Description

The main data storage methods and objects in IODA.

Typedef Documentation

SelectionBackend_t

typedef std::shared_ptr<InstantiatedSelection> ioda::Selections::SelectionBackend_t

Definition at line 35 of file Selection.h.

VecDimensions_t

typedef std::vector<Dimensions_t> ioda::Selection::VecDimensions_t

Definition at line 50 of file Selection.h.

Enumeration Type Documentation

FillValuePolicy

enum ioda::FillValuePolicy

strong

This option describes the default fill values that will be used if the user does not manually specify a fill value.

Enumerator
HDF5	Set all fill values to zero or null strings.
NETCDF4	Use NetCDF4 default fill values. This is the default option for ioda files.

Definition at line 28 of file FillPolicy.h.

SelectionOperator

enum ioda::SelectionOperator

strong

Selection enum.

Enumerator
SET
OR
AND
XOR
NOT_B
NOT_A
APPEND
PREPEND

Definition at line 24 of file Selection.h.

SelectionState

enum ioda::SelectionState

strong

The "default" for the selection.

Enumerator
ALL
NONE

Definition at line 27 of file Selection.h.

Function Documentation

Selection()

ioda::Selection::Selection ( const VecDimensions_t &  extent = {}, SelectionState  sel = SelectionState::ALL  )

inline

Definition at line 92 of file Selection.h.

SingleSelection() [1/4]

ioda::Selection::SingleSelection::SingleSelection ( )

inline

Definition at line 89 of file Selection.h.

SingleSelection() [2/4]

ioda::Selection::SingleSelection::SingleSelection ( SelectionOperator  op, const std::vector< VecDimensions_t > &  points  )

inline

Definition at line 81 of file Selection.h.

SingleSelection() [3/4]

ioda::Selection::SingleSelection::SingleSelection ( SelectionOperator  op, const VecDimensions_t &  start, const VecDimensions_t &  count, const VecDimensions_t &  stride = {}, const VecDimensions_t &  block = {}  )

inline

Definition at line 77 of file Selection.h.

SingleSelection() [4/4]

ioda::Selection::SingleSelection::SingleSelection ( SelectionOperator  op, size_t  dimension, const VecDimensions_t &  indices_starts, const VecDimensions_t &  indices_counts = {}  )

inline

Definition at line 83 of file Selection.h.

~InstantiatedSelection()

ioda::Selections::InstantiatedSelection::~InstantiatedSelection ( )

virtualdefault

~Selection()

ioda::Selection::~Selection ( )

inline

Definition at line 94 of file Selection.h.

applyFillValuePolicy()

template<class T >

void ioda::FillValuePolicies::applyFillValuePolicy	(	FillValuePolicy	pol,
		detail::FillValueData_t &	fvd
	)

Applies the fill value policy. This sets default fill values when fill values are not already provided.

Definition at line 108 of file FillPolicy.h.

Here is the call graph for this function:

assignFillValue()

template<class T >

void ioda::detail::assignFillValue	(	FillValueData_t &	data,
		T	val
	)

Definition at line 81 of file Fill.h.

Here is the caller graph for this function:

assignFillValue< std::string >()

template<>

void ioda::detail::assignFillValue< std::string > ( FillValueData_t &  data, std::string  val  )

inline

Definition at line 92 of file Fill.h.

concretize() [1/3]

Selections::SelectionBackend_t ioda::Selection::concretize ( ) const

inline

Return the cached selection object.

Returns

The cached selection, if any.

Definition at line 123 of file Selection.h.

concretize() [2/3]

Selections::SelectionBackend_t ioda::Selection::concretize

(

const Variable &

var

)

const

Talk to the backend and generate the appropriate selection object.

Returns

The instantiated backend selection object.

Definition at line 18 of file Selection.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

concretize() [3/3]

void ioda::Selection::concretize ( Selections::SelectionBackend_t  newobj ) const

inline

Definition at line 124 of file Selection.h.

extent() [1/2]

const VecDimensions_t& ioda::Selection::extent ( ) const

inline

Definition at line 116 of file Selection.h.

extent() [2/2]

Selection& ioda::Selection::extent ( const VecDimensions_t &  sz )

inline

Provide the dimensions of the object that you are selecting from.

Definition at line 111 of file Selection.h.

Here is the caller graph for this function:

getActions()

const std::vector<SingleSelection>& ioda::Selection::getActions ( ) const

inline

Definition at line 108 of file Selection.h.

Here is the caller graph for this function:

getDefault()

SelectionState ioda::Selection::getDefault ( ) const

inline

Definition at line 109 of file Selection.h.

Here is the caller graph for this function:

getFillValue() [1/2]

template<class T >

T ioda::detail::getFillValue

(

FillValueData_t &

data

)

Definition at line 63 of file Fill.h.

getFillValue() [2/2]

template<>

std::string ioda::detail::getFillValue ( FillValueData_t &  data )

inline

Definition at line 75 of file Fill.h.

getOffset()

const VecDimensions_t& ioda::Selection::getOffset ( ) const

inline

Definition at line 101 of file Selection.h.

Here is the caller graph for this function:

invalidate()

void ioda::Selection::invalidate ( ) const

inline

Ditch the concretized selection.

Definition at line 129 of file Selection.h.

Here is the caller graph for this function:

isConcretized()

bool ioda::Selection::isConcretized ( ) const

inline

Is the selection already cached in the backend?

Returns

true if yes, false if no.

Definition at line 127 of file Selection.h.

Here is the caller graph for this function:

netCDF4_default()

template<class T >

T ioda::FillValuePolicies::netCDF4_default

(

)

See also

netcdf.h, starting around line 62, for these values netcdf uses "ints" and "shorts", but these are all defined as fixed-width types.

Definition at line 52 of file FillPolicy.h.

select()

Selection& ioda::Selection::select ( const SingleSelection &  s )

inline

Append a new selection.

Definition at line 103 of file Selection.h.

Here is the caller graph for this function:

setOffset()

Selection& ioda::Selection::setOffset ( const std::vector< Dimensions_t > &  newOffset )

inline

Shift the selection by an offset.

Definition at line 96 of file Selection.h.

Variable Documentation

actions_

std::vector<SingleSelection> ioda::Selection::actions_

private

Definition at line 141 of file Selection.h.

all

const Selection ioda::Selection::all

static

Definition at line 131 of file Selection.h.

backend_

Selections::SelectionBackend_t ioda::Selection::backend_

mutableprivate

Using an opaque object to implement a cache of the Selection for a backend.

This allows the selection to be reused without expensive repetitive recomputation. Any new manipulation invalidates backend_.

Definition at line 138 of file Selection.h.

block_

VecDimensions_t ioda::Selection::SingleSelection::block_

Definition at line 70 of file Selection.h.

count_

VecDimensions_t ioda::Selection::SingleSelection::count_

Definition at line 70 of file Selection.h.

default_

SelectionState ioda::Selection::default_

private

Definition at line 140 of file Selection.h.

dimension_

size_t ioda::Selection::SingleSelection::dimension_

Definition at line 74 of file Selection.h.

dimension_indices_counts_

VecDimensions_t ioda::Selection::SingleSelection::dimension_indices_counts_

Definition at line 75 of file Selection.h.

dimension_indices_starts_

VecDimensions_t ioda::Selection::SingleSelection::dimension_indices_starts_

Definition at line 75 of file Selection.h.

extent_

VecDimensions_t ioda::Selection::extent_

private

The extent is the dimensions of the object that you are selecting from.

Definition at line 145 of file Selection.h.

none

const Selection ioda::Selection::none

static

Definition at line 132 of file Selection.h.

offset_

VecDimensions_t ioda::Selection::offset_

private

The offset is a way to quickly shift the selection.

Definition at line 143 of file Selection.h.

op_

SelectionOperator ioda::Selection::SingleSelection::op_

Definition at line 68 of file Selection.h.

points_

std::vector<VecDimensions_t> ioda::Selection::SingleSelection::points_

Definition at line 72 of file Selection.h.

start_

VecDimensions_t ioda::Selection::SingleSelection::start_

Definition at line 70 of file Selection.h.

stride_

VecDimensions_t ioda::Selection::SingleSelection::stride_

Definition at line 70 of file Selection.h.