IODA
ioda::NewDimensionScale_Object< DataType > Struct Template Reference

Used to specify a new dimension scale when making an ObsSpace. Templated version of NewDimensionScale_Base. More...

#include <DimensionScales.h>

Inheritance diagram for ioda::NewDimensionScale_Object< DataType >:
Collaboration diagram for ioda::NewDimensionScale_Object< DataType >:

Public Member Functions

virtual ~NewDimensionScale_Object ()
 
 NewDimensionScale_Object (const std::string &name, Dimensions_t size, Dimensions_t maxSize, Dimensions_t chunkingSize)
 
void writeInitialData (Variable &v) const override
 
std::shared_ptr< NewDimensionScale_Object< DataType > > getShared () const
 
- Public Member Functions inherited from ioda::NewDimensionScale_Base
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::vector< DataType > initdata_
 
- Public Attributes inherited from ioda::NewDimensionScale_Base
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

template<class DataType>
struct ioda::NewDimensionScale_Object< DataType >

Used to specify a new dimension scale when making an ObsSpace. Templated version of NewDimensionScale_Base.

Definition at line 94 of file DimensionScales.h.

Constructor & Destructor Documentation

◆ ~NewDimensionScale_Object()

template<class DataType >
virtual ioda::NewDimensionScale_Object< DataType >::~NewDimensionScale_Object ( )
inlinevirtual

Definition at line 95 of file DimensionScales.h.

◆ NewDimensionScale_Object()

template<class DataType >
ioda::NewDimensionScale_Object< DataType >::NewDimensionScale_Object ( const std::string &  name,
Dimensions_t  size,
Dimensions_t  maxSize,
Dimensions_t  chunkingSize 
)
inline

Definition at line 99 of file DimensionScales.h.

Member Function Documentation

◆ getShared()

template<class DataType >
std::shared_ptr<NewDimensionScale_Object<DataType> > ioda::NewDimensionScale_Object< DataType >::getShared ( ) const
inline

Definition at line 108 of file DimensionScales.h.

◆ writeInitialData()

template<class DataType >
void ioda::NewDimensionScale_Object< DataType >::writeInitialData ( Variable ) const
inlineoverridevirtual
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 from ioda::NewDimensionScale_Base.

Definition at line 106 of file DimensionScales.h.

Here is the call graph for this function:

Member Data Documentation

◆ initdata_

template<class DataType >
std::vector<DataType> ioda::NewDimensionScale_Object< DataType >::initdata_

Definition at line 97 of file DimensionScales.h.


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