Used to specify a new dimension scale when making an ObsSpace. More...

#include <DimensionScales.h>

Inheritance diagram for ioda::NewDimensionScale_Base:

Collaboration diagram for ioda::NewDimensionScale_Base:

[legend]

Public Member Functions
virtual void	writeInitialData (Variable &) const

virtual	~NewDimensionScale_Base ()

	NewDimensionScale_Base (const std::string &name, const std::type_index &dataType, Dimensions_t size, Dimensions_t maxSize, Dimensions_t chunkingSize)

	NewDimensionScale_Base (const std::string &name, const Type &dataType, Dimensions_t size, Dimensions_t maxSize, Dimensions_t chunkingSize)

Public Attributes
std::string	name_
	Name of the dimension. Scan position, scan line, latitude, ... More...

std::type_index	dataType_
	Type of the new dimension. Int, char, etc. Used if a type is not passed directly. More...

Type	dataTypeKnown_
	Type of the new dimension. Used if a type is passed directly. More...

Dimensions_t	size_
	Initial size of the new dimension. More...

Dimensions_t	maxSize_
	Maximum size of the new dimension. Unlimited (< 0) by default. More...

Dimensions_t	chunkingSize_
	Chunking size of the new dimension. May be used as a hint when creating new Variables based on this dimension. More...

Detailed Description

Used to specify a new dimension scale when making an ObsSpace.

Note: Instantiation stored in ObsSpace.cpp.; shared_from_this for pybind11. Can't pass in a list of unique_ptrs.

Definition at line 46 of file DimensionScales.h.

Constructor & Destructor Documentation

◆ ~NewDimensionScale_Base()

ioda::NewDimensionScale_Base::~NewDimensionScale_Base ( )

virtualdefault

◆ NewDimensionScale_Base() [1/2]

ioda::NewDimensionScale_Base::NewDimensionScale_Base	(	const std::string &	name,
		const std::type_index &	dataType,
		Dimensions_t	size,
		Dimensions_t	maxSize,
		Dimensions_t	chunkingSize
	)

inline

Note: This should not be used directly. Keeping it public because of cross-language bindings.

See also: NewDimensionScale

Definition at line 71 of file DimensionScales.h.

◆ NewDimensionScale_Base() [2/2]

ioda::NewDimensionScale_Base::NewDimensionScale_Base	(	const std::string &	name,
		const Type &	dataType,
		Dimensions_t	size,
		Dimensions_t	maxSize,
		Dimensions_t	chunkingSize
	)

inline

Definition at line 80 of file DimensionScales.h.

Member Function Documentation

◆ writeInitialData()

virtual void ioda::NewDimensionScale_Base::writeInitialData ( Variable & ) const

inlinevirtual

Note: Not pure virtual to avoid pybind11 headaches with adding a trampoline class. The base class should never be invoked directly.

See also: https://pybind11.readthedocs.io/en/stable/advanced/classes.html

Reimplemented in ioda::NewDimensionScale_Object< DataType >.

Definition at line 65 of file DimensionScales.h.

Here is the caller graph for this function:

Member Data Documentation

◆ chunkingSize_

Dimensions_t ioda::NewDimensionScale_Base::chunkingSize_

Chunking size of the new dimension. May be used as a hint when creating new Variables based on this dimension.

Matches size by default, but will throw an error if the size is zero.

Definition at line 60 of file DimensionScales.h.

◆ dataType_

std::type_index ioda::NewDimensionScale_Base::dataType_

Type of the new dimension. Int, char, etc. Used if a type is not passed directly.

Definition at line 50 of file DimensionScales.h.

◆ dataTypeKnown_

Type ioda::NewDimensionScale_Base::dataTypeKnown_

Type of the new dimension. Used if a type is passed directly.

Definition at line 52 of file DimensionScales.h.

◆ maxSize_

Dimensions_t ioda::NewDimensionScale_Base::maxSize_

Maximum size of the new dimension. Unlimited (< 0) by default.

Definition at line 56 of file DimensionScales.h.

◆ name_

std::string ioda::NewDimensionScale_Base::name_

Name of the dimension. Scan position, scan line, latitude, ...

Definition at line 48 of file DimensionScales.h.

◆ size_

Dimensions_t ioda::NewDimensionScale_Base::size_

Initial size of the new dimension.

Definition at line 54 of file DimensionScales.h.

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

Public Member Functions

Public Attributes