IODA Bundle
Ingester::ArrayDataObject Class Reference

Container for Parser data that is expressed as a Eigen Array of doubles. More...

#include <ArrayDataObject.h>

Inheritance diagram for Ingester::ArrayDataObject:
[legend]
Collaboration diagram for Ingester::ArrayDataObject:
[legend]

Public Member Functions

 ArrayDataObject (const IngesterArray &eigArray)
 
 ~ArrayDataObject ()=default
 
ioda::Variable createVariable (ioda::ObsGroup &obsGroup, const std::string &name, const std::vector< ioda::Variable > &dimensions, const std::vector< ioda::Dimensions_t > &chunks, int compressionLevel) final
 Makes an ioda::Variable and ads it to the given ioda::ObsGroup. More...
 
void print () const final
 Print data to stdout for debug purposes. More...
 
size_t nrows () const final
 Get number of rows represented in the data. More...
 
size_t ncols () const final
 Get number of columns represented in the data. More...
 
IngesterArray get () const
 

Static Private Member Functions

static ioda::VariableCreationParameters makeCreationParams (const std::vector< ioda::Dimensions_t > &chunks, int compressionLevel)
 Create an ioda::VariableCreationParameters for the data. More...
 

Private Attributes

const IngesterArray eigArray_
 Eigen Array that holds the data. More...
 

Detailed Description

Container for Parser data that is expressed as a Eigen Array of doubles.

Definition at line 17 of file ArrayDataObject.h.

Constructor & Destructor Documentation

◆ ArrayDataObject()

Ingester::ArrayDataObject::ArrayDataObject ( const IngesterArray eigArray)
explicit

Definition at line 14 of file ArrayDataObject.cpp.

◆ ~ArrayDataObject()

Ingester::ArrayDataObject::~ArrayDataObject ( )
default

Member Function Documentation

◆ createVariable()

ioda::Variable Ingester::ArrayDataObject::createVariable ( ioda::ObsGroup obsGroup,
const std::string &  name,
const std::vector< ioda::Variable > &  dimensions,
const std::vector< ioda::Dimensions_t > &  chunks,
int  compressionLevel 
)
finalvirtual

Makes an ioda::Variable and ads it to the given ioda::ObsGroup.

Parameters
obsGroupObsgroup were to add the variable
nameThe name to associate with the variable (ex "latitude@MetaData")
dimensionsList of Variables to use as the dimensions for this new variable
chunksList of integers specifying the chunking dimensions
compressionLevelThe GZip compression level to use, must be 0-9

Implements Ingester::DataObject.

Definition at line 19 of file ArrayDataObject.cpp.

Here is the call graph for this function:

◆ get()

IngesterArray Ingester::ArrayDataObject::get ( ) const
inline

Definition at line 45 of file ArrayDataObject.h.

Here is the caller graph for this function:

◆ makeCreationParams()

ioda::VariableCreationParameters Ingester::ArrayDataObject::makeCreationParams ( const std::vector< ioda::Dimensions_t > &  chunks,
int  compressionLevel 
)
staticprivate

Create an ioda::VariableCreationParameters for the data.

Parameters
chunksList of integers specifying the chunking dimensions
compressionLevelThe GZip compression level to use, must be 0-9

Definition at line 46 of file ArrayDataObject.cpp.

Here is the caller graph for this function:

◆ ncols()

size_t Ingester::ArrayDataObject::ncols ( ) const
finalvirtual

Get number of columns represented in the data.

Implements Ingester::DataObject.

Definition at line 41 of file ArrayDataObject.cpp.

◆ nrows()

size_t Ingester::ArrayDataObject::nrows ( ) const
finalvirtual

Get number of rows represented in the data.

Implements Ingester::DataObject.

Definition at line 36 of file ArrayDataObject.cpp.

◆ print()

void Ingester::ArrayDataObject::print ( ) const
finalvirtual

Print data to stdout for debug purposes.

Implements Ingester::DataObject.

Definition at line 31 of file ArrayDataObject.cpp.

Member Data Documentation

◆ eigArray_

const IngesterArray Ingester::ArrayDataObject::eigArray_
private

Eigen Array that holds the data.

Definition at line 49 of file ArrayDataObject.h.


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