ioda::ObsStore::Selection Class Reference

#include <Selection.hpp>

Public Member Functions
	Selection (const std::size_t start, const std::size_t npoints)
	Selection (const SelectionModes mode, const std::vector< SelectSpecs > &dim_selects, const std::vector< Dimensions_t > &dim_sizes)
	Selection ()
SelectionModes	mode () const
	returns selection mode More...
void	init_lin_indx ()
	initializes iterator for walking through linear memory indices More...
std::size_t	next_lin_indx ()
	returns next linear memory index More...
bool	end_lin_indx () const
	returns true when at the end of the linear memory indices More...
std::size_t	npoints () const
	returns number of points in selection More...

Private Attributes
SelectionModes	mode_ = SelectionModes::ALL
	mode of selection (which impacts how linear memory is accessed) More...
int	end_ = 0
	end of selection for ALL mode More...
int	index_ = 0
	index value for ALL mode More...
std::size_t	npoints_ = 0
	total number of points in selection More...
std::size_t	max_index_ = 0
	maximum allowed index value More...
std::vector< SelectSpecs >	dim_selects_
	selection indices for each dimension More...
std::vector< Dimensions_t >	dim_sizes_
	sizes of data dimensions (length is rank of dimensions) More...
std::vector< std::size_t >	dim_select_sizes_
	number of dimension selections per dimension More...
std::unique_ptr< SelectCounter >	counter_
	counter for generating linear memory indices More...

Detailed Description

Definition at line 92 of file Selection.hpp.

Constructor & Destructor Documentation

Selection() [1/3]

ioda::ObsStore::Selection::Selection	(	const std::size_t	start,
		const std::size_t	npoints
	)

Definition at line 75 of file Engines/ObsStore/Selection.cpp.

Selection() [2/3]

ioda::ObsStore::Selection::Selection	(	const SelectionModes	mode,
		const std::vector< SelectSpecs > &	dim_selects,
		const std::vector< Dimensions_t > &	dim_sizes
	)

Definition at line 82 of file Engines/ObsStore/Selection.cpp.

Here is the call graph for this function:

Selection() [3/3]

ioda::ObsStore::Selection::Selection ( )

default

Member Function Documentation

end_lin_indx()

bool ioda::ObsStore::Selection::end_lin_indx

(

)

const

returns true when at the end of the linear memory indices

Definition at line 156 of file Engines/ObsStore/Selection.cpp.

Here is the caller graph for this function:

init_lin_indx()

void ioda::ObsStore::Selection::init_lin_indx

(

)

initializes iterator for walking through linear memory indices

Definition at line 121 of file Engines/ObsStore/Selection.cpp.

Here is the caller graph for this function:

mode()

SelectionModes ioda::ObsStore::Selection::mode

(

)

const

returns selection mode

Definition at line 112 of file Engines/ObsStore/Selection.cpp.

Here is the caller graph for this function:

next_lin_indx()

std::size_t ioda::ObsStore::Selection::next_lin_indx

(

)

returns next linear memory index

Definition at line 129 of file Engines/ObsStore/Selection.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

npoints()

std::size_t ioda::ObsStore::Selection::npoints

(

)

const

returns number of points in selection

Definition at line 167 of file Engines/ObsStore/Selection.cpp.

Here is the caller graph for this function:

Member Data Documentation

counter_

std::unique_ptr<SelectCounter> ioda::ObsStore::Selection::counter_

private

counter for generating linear memory indices

Definition at line 115 of file Selection.hpp.

dim_select_sizes_

std::vector<std::size_t> ioda::ObsStore::Selection::dim_select_sizes_

private

number of dimension selections per dimension

Definition at line 112 of file Selection.hpp.

dim_selects_

std::vector<SelectSpecs> ioda::ObsStore::Selection::dim_selects_

private

selection indices for each dimension

Definition at line 108 of file Selection.hpp.

dim_sizes_

std::vector<Dimensions_t> ioda::ObsStore::Selection::dim_sizes_

private

sizes of data dimensions (length is rank of dimensions)

Definition at line 110 of file Selection.hpp.

end_

int ioda::ObsStore::Selection::end_ = 0

private

end of selection for ALL mode

Definition at line 98 of file Selection.hpp.

index_

int ioda::ObsStore::Selection::index_ = 0

private

index value for ALL mode

Definition at line 100 of file Selection.hpp.

max_index_

std::size_t ioda::ObsStore::Selection::max_index_ = 0

private

maximum allowed index value

Definition at line 105 of file Selection.hpp.

mode_

SelectionModes ioda::ObsStore::Selection::mode_ = SelectionModes::ALL

private

mode of selection (which impacts how linear memory is accessed)

Definition at line 95 of file Selection.hpp.

npoints_

std::size_t ioda::ObsStore::Selection::npoints_ = 0

private

total number of points in selection

Definition at line 103 of file Selection.hpp.

---

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

• Selection.hpp
• Engines/ObsStore/Selection.cpp