A Selection represents the bounds of the data, in ioda or in userspace, that you are reading or writing. More...

#include <Selection.h>

Collaboration diagram for ioda::Selection:

Classes
struct	SingleSelection
	Represents a hyperslab or a series of points in a selection, coupled with a SelectionOperator "action". More...

Public Types
typedef std::vector< Dimensions_t >	VecDimensions_t

Public Member Functions
	Selection (const VecDimensions_t &extent={}, SelectionState sel=SelectionState::ALL)

	~Selection ()

Selection &	setOffset (const std::vector< Dimensions_t > &newOffset)
	Shift the selection by an offset. More...

const VecDimensions_t &	getOffset () const

Selection &	select (const SingleSelection &s)
	Append a new selection. More...

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

SelectionState	getDefault () const

Selection &	extent (const VecDimensions_t &sz)
	Provide the dimensions of the object that you are selecting from. More...

const VecDimensions_t &	extent () const

Selections::SelectionBackend_t	concretize (const Variable &) const
	Talk to the backend and generate the appropriate selection object. More...

Selections::SelectionBackend_t	concretize () const
	Return the cached selection object. More...

void	concretize (Selections::SelectionBackend_t newobj) const

bool	isConcretized () const
	Is the selection already cached in the backend? More...

void	invalidate () const
	Ditch the concretized selection. More...

Static Public Attributes
static IODA_DL const Selection	all

static IODA_DL const Selection	none

Private Attributes
Selections::SelectionBackend_t	backend_
	Using an opaque object to implement a cache of the Selection for a backend. More...

SelectionState	default_

std::vector< SingleSelection >	actions_

VecDimensions_t	offset_
	The offset is a way to quickly shift the selection. More...

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

Detailed Description

A Selection represents the bounds of the data, in ioda or in userspace, that you are reading or writing.

It is made of a series of SingleSelection objects. Each of these objects represents a selection operation that filters the range that came before.

Note: In user-space, you need to specify the bounds of your multi-dimensional storage container. Use the extent function to do this.

Definition at line 48 of file Selection.h.

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

Classes