IODA
Private Attributes | List of all members
ioda::VariableCreationParameters Struct Reference
IODA » Interfaces » C++ interface » API » Variables, Data Access, and Selections

Used to specify Variable creation-time properties. More...

#include <Has_Variables.h>

Collaboration diagram for ioda::VariableCreationParameters:
Collaboration graph
[legend]

Private Attributes

std::vector< std::pair< unsigned int, Variable > > dimsToAttach_
 
std::string dimScaleName_
 

Fill Value

detail::FillValueData_t fillValue_
 
template<class DataType >
VariableCreationParameters & setFillValue (DataType fill)
 
VariableCreationParameters & unsetFillValue ()
 

Chunking and compression

bool chunk = false
 Do we chunk this variable? Required for extendible / compressible Variables. More...
 
std::vector< Dimensions_t > chunks
 Manually specify the chunks. Never directly use. Use getChunks(...) instead. More...
 
std::function< bool(const std::vector< Dimensions_t > &, std::vector< Dimensions_t > &)> fChunkingStrategy = chunking::Chunking_Max
 Set variable chunking strategy. Used only if chunk == true and chunks.size() == 0. More...
 
bool gzip_ = false
 
bool szip_ = false
 
int gzip_level_ = 6
 
unsigned int szip_PixelsPerBlock_ = 16
 
unsigned int szip_options_ = 4
 
std::vector< Dimensions_t > getChunks (const std::vector< Dimensions_t > &cur_dims) const
 
void noCompress ()
 
void compressWithGZIP (int level=6)
 
void compressWithSZIP (unsigned PixelsPerBlock=16, unsigned options=4)
 

General Functions

Attribute_Creator_Store atts
 Set any initial attributes here. More...
 
detail::python_bindings::VariableCreationFillValues< VariableCreationParameters > _py_setFillValue
 
class detail::Has_Variables_Base
 
 VariableCreationParameters ()
 
 VariableCreationParameters (const VariableCreationParameters &)
 
VariableCreationParameters & operator= (const VariableCreationParameters &)
 
detail::FillValueData_t::FillValueUnion_t finalize () const
 Finalize routine to make sure struct members are intact (e.g. for fill values) More...
 
template<class DataType >
static VariableCreationParameters defaulted ()
 
template<class DataType >
static VariableCreationParameters defaults ()
 
Variable applyImmediatelyAfterVariableCreation (Variable h) const
 Apply the properties to a Variable (second pass; after Variable is created). More...
 

Detailed Description

Used to specify Variable creation-time properties.

Definition at line 57 of file Has_Variables.h.

Constructor & Destructor Documentation

◆ VariableCreationParameters() [1/2]

ioda::VariableCreationParameters::VariableCreationParameters ( )

Definition at line 452 of file Has_Variables.cpp.

◆ VariableCreationParameters() [2/2]

ioda::VariableCreationParameters::VariableCreationParameters ( const VariableCreationParameters &  r)

Definition at line 453 of file Has_Variables.cpp.

Member Function Documentation

◆ applyImmediatelyAfterVariableCreation()

Variable ioda::VariableCreationParameters::applyImmediatelyAfterVariableCreation ( Variable  h) const
private

Apply the properties to a Variable (second pass; after Variable is created).

Definition at line 498 of file Has_Variables.cpp.

Here is the call graph for this function:

◆ compressWithGZIP()

void ioda::VariableCreationParameters::compressWithGZIP ( int  level = 6)

Definition at line 486 of file Has_Variables.cpp.

Here is the caller graph for this function:

◆ compressWithSZIP()

void ioda::VariableCreationParameters::compressWithSZIP ( unsigned  PixelsPerBlock = 16,
unsigned  options = 4 
)

Definition at line 491 of file Has_Variables.cpp.

Here is the caller graph for this function:

◆ defaulted()

template<class DataType >
static VariableCreationParameters ioda::VariableCreationParameters::defaulted ( )
inlinestatic

Definition at line 122 of file Has_Variables.h.

Here is the call graph for this function:

◆ defaults()

template<class DataType >
static VariableCreationParameters ioda::VariableCreationParameters::defaults ( )
inlinestatic

Definition at line 130 of file Has_Variables.h.

◆ finalize()

detail::FillValueData_t::FillValueUnion_t ioda::VariableCreationParameters::finalize ( ) const
inline

Finalize routine to make sure struct members are intact (e.g. for fill values)

Definition at line 135 of file Has_Variables.h.

Here is the call graph for this function:

◆ getChunks()

std::vector<Dimensions_t> ioda::VariableCreationParameters::getChunks ( const std::vector< Dimensions_t > &  cur_dims) const
inline

Figure out the chunking size

Parameters
cur_dimsare the current dimensions

Definition at line 93 of file Has_Variables.h.

Here is the caller graph for this function:

◆ noCompress()

void ioda::VariableCreationParameters::noCompress ( )

Definition at line 482 of file Has_Variables.cpp.

Here is the caller graph for this function:

◆ operator=()

VariableCreationParameters & ioda::VariableCreationParameters::operator= ( const VariableCreationParameters &  r)

Definition at line 465 of file Has_Variables.cpp.

◆ setFillValue()

template<class DataType >
VariableCreationParameters& ioda::VariableCreationParameters::setFillValue ( DataType  fill)
inline

Definition at line 69 of file Has_Variables.h.

Here is the caller graph for this function:

◆ unsetFillValue()

VariableCreationParameters& ioda::VariableCreationParameters::unsetFillValue ( )
inline

Definition at line 73 of file Has_Variables.h.

Friends And Related Function Documentation

◆ detail::Has_Variables_Base

friend class detail::Has_Variables_Base
friend

Definition at line 140 of file Has_Variables.h.

Member Data Documentation

◆ _py_setFillValue

detail::python_bindings::VariableCreationFillValues<VariableCreationParameters> ioda::VariableCreationParameters::_py_setFillValue

Definition at line 137 of file Has_Variables.h.

◆ atts

Attribute_Creator_Store ioda::VariableCreationParameters::atts

Set any initial attributes here.

Definition at line 115 of file Has_Variables.h.

◆ chunk

bool ioda::VariableCreationParameters::chunk = false

Do we chunk this variable? Required for extendible / compressible Variables.

Requires a chunking strategy.

Definition at line 84 of file Has_Variables.h.

◆ chunks

std::vector<Dimensions_t> ioda::VariableCreationParameters::chunks

Manually specify the chunks. Never directly use. Use getChunks(...) instead.

Definition at line 87 of file Has_Variables.h.

◆ dimScaleName_

std::string ioda::VariableCreationParameters::dimScaleName_
private

Definition at line 60 of file Has_Variables.h.

◆ dimsToAttach_

std::vector<std::pair<unsigned int, Variable> > ioda::VariableCreationParameters::dimsToAttach_
private

Definition at line 59 of file Has_Variables.h.

◆ fChunkingStrategy

std::function<bool(const std::vector<Dimensions_t>&, std::vector<Dimensions_t>&)> ioda::VariableCreationParameters::fChunkingStrategy = chunking::Chunking_Max

Set variable chunking strategy. Used only if chunk == true and chunks.size() == 0.

Definition at line 90 of file Has_Variables.h.

◆ fillValue_

detail::FillValueData_t ioda::VariableCreationParameters::fillValue_

Definition at line 66 of file Has_Variables.h.

◆ gzip_

bool ioda::VariableCreationParameters::gzip_ = false

Definition at line 100 of file Has_Variables.h.

◆ gzip_level_

int ioda::VariableCreationParameters::gzip_level_ = 6

Definition at line 102 of file Has_Variables.h.

◆ szip_

bool ioda::VariableCreationParameters::szip_ = false

Definition at line 101 of file Has_Variables.h.

◆ szip_options_

unsigned int ioda::VariableCreationParameters::szip_options_ = 4

Definition at line 104 of file Has_Variables.h.

◆ szip_PixelsPerBlock_

unsigned int ioda::VariableCreationParameters::szip_PixelsPerBlock_ = 16

Definition at line 103 of file Has_Variables.h.

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