MI - Fimex
Public Member Functions | List of all members
MetNoFimex::NetCDF_CDMReader Class Reference

#include "fimex/NetCDF_CDMReader.h"

Inheritance diagram for MetNoFimex::NetCDF_CDMReader:
MetNoFimex::CDMReaderWriter MetNoFimex::CDMReader

Public Member Functions

 NetCDF_CDMReader (const std::string &fileName, bool writable=false)
 
virtual ~NetCDF_CDMReader ()
 
virtual DataPtr getDataSlice (const std::string &varName, size_t unLimDimPos)
 data-reading function to be called from the CDMWriter More...
 
virtual DataPtr getDataSlice (const std::string &varName, const SliceBuilder &sb)
 data-reading function to be called from the CDMWriter More...
 
virtual void sync ()
 flush data to disc More...
 
virtual void putDataSlice (const std::string &varName, size_t unLimDimPos, const DataPtr data)
 data-writing function More...
 
virtual void putDataSlice (const std::string &varName, const SliceBuilder &sb, const DataPtr data)
 data-writing function for general slices More...
 
- Public Member Functions inherited from MetNoFimex::CDMReaderWriter
 CDMReaderWriter ()
 
virtual ~CDMReaderWriter ()
 
virtual void putScaledDataSlice (const std::string &varName, size_t unLimDimPos, const DataPtr data)
 unscale and write a dataslice More...
 
virtual void putScaledDataSliceInUnit (const std::string &varName, const std::string &unit, size_t unLimDimPos, const DataPtr data)
 unscale and write a dataslice from a known unit More...
 
virtual void putScaledDataSlice (const std::string &varName, const SliceBuilder &sb, const DataPtr data)
 unscale and write a dataslice More...
 
virtual void putScaledDataSliceInUnit (const std::string &varName, const std::string &dataUnit, const SliceBuilder &sb, const DataPtr data)
 unscale and write a dataslice from a known unit More...
 
- Public Member Functions inherited from MetNoFimex::CDMReader
 CDMReader ()
 
virtual ~CDMReader ()
 
virtual const CDMgetCDM () const
 
virtual CDMgetInternalCDM ()
 
virtual std::vector< std::size_t > getDims (std::string varName)
 Read the sizes of the dimensions belonging to a variable. More...
 
virtual std::vector< std::size_t > getDimsSlice (std::string varName)
 Read the sizes of the dimensions belonging to a variable slice. More...
 
virtual DataPtr getData (const std::string &varName)
 data-reading function to be called from the CDMWriter More...
 
virtual DataPtr getScaledDataSlice (const std::string &varName, size_t unLimDimPos)
 read and scale a dataslice More...
 
virtual DataPtr getScaledDataSliceInUnit (const std::string &varName, const std::string &unit, size_t unLimDimPos)
 read and scale a dataslice to a known unit More...
 
virtual DataPtr getScaledDataSlice (const std::string &varName, const SliceBuilder &sb)
 read and scale a dataslice More...
 
virtual DataPtr getScaledDataSliceInUnit (const std::string &varName, const std::string &unit, const SliceBuilder &sb)
 read and scale a dataslice to a set unit More...
 
virtual DataPtr getScaledData (const std::string &varName)
 read and scale the complete data More...
 
virtual DataPtr getScaledDataInUnit (const std::string &varName, const std::string &unit)
 read and scale the complete data to a set unit More...
 

Additional Inherited Members

- Protected Member Functions inherited from MetNoFimex::CDMReader
virtual DataPtr getDataSliceFromMemory (const CDMVariable &variable, size_t unLimDimPos=0)
 
void getScaleAndOffsetOf (const std::string &varName, double &scale, double &offset) const
 
- Protected Attributes inherited from MetNoFimex::CDMReader
boost::shared_ptr< CDMcdm_
 

Constructor & Destructor Documentation

MetNoFimex::NetCDF_CDMReader::NetCDF_CDMReader ( const std::string fileName,
bool  writable = false 
)
virtual MetNoFimex::NetCDF_CDMReader::~NetCDF_CDMReader ( )
virtual

Member Function Documentation

virtual DataPtr MetNoFimex::NetCDF_CDMReader::getDataSlice ( const std::string varName,
size_t  unLimDimPos 
)
virtual

data-reading function to be called from the CDMWriter

This methods needs to be implemented by the CDMReader. It should provide the data for each variable, either by reading from disk, converting from another CDMReader or reading from an in-memory data-section.

This function should retrieve the whole data for a dataset without unlimited dimension if the unLimDimPos == 0.

Parameters
varNamename of the variable to read
unLimDimPos(optional) if the variable contains a unlimited dimension (max one allowed) an slice of this position is returned
Exceptions
CDMExceptionon errors related to the CDM in combination with the underlying data-structure. It might also throw other (IO-)exceptions.

Implements MetNoFimex::CDMReader.

virtual DataPtr MetNoFimex::NetCDF_CDMReader::getDataSlice ( const std::string varName,
const SliceBuilder sb 
)
virtual

data-reading function to be called from the CDMWriter

Parameters
varNamename of the variable to read
sba SliceBuilder generated from this CDMReaders CDM
Exceptions
CDMExceptionon errors related to the CDM in combination with the underlying data-structure. It might also throw other (IO-)exceptions.
Warning
This method has a default implementation depending on getDataSlice(const std::string&, size_t), but should be implemented for performance reasons. If you want to fall back to the default implementation, remember to use 'using CDMReader::getDataSlice;'

Reimplemented from MetNoFimex::CDMReader.

virtual void MetNoFimex::NetCDF_CDMReader::putDataSlice ( const std::string varName,
size_t  unLimDimPos,
const DataPtr  data 
)
virtual

data-writing function

This methods needs to be implemented by the CDMReaderWriter. It will write back the data to a variable at unLimPos, without any changes (except eventually required change of datatypes).

This function will write the whole data for a dataset without unlimited dimension if the unLimDimPos == 0.

Parameters
varNamename of the variable to read
unLimDimPos(optional) if the variable contains a unlimited dimension (max one allowed) an slice of this position is returned
dataData to be written to unLimDimPos
Exceptions
CDMExceptionon errors related to the CDM in combination with the underlying data-structure. It might also throw other (IO-)exceptions.

Implements MetNoFimex::CDMReaderWriter.

virtual void MetNoFimex::NetCDF_CDMReader::putDataSlice ( const std::string varName,
const SliceBuilder sb,
const DataPtr  data 
)
virtual

data-writing function for general slices

Parameters
varNamename of the variable to read
sba SliceBuilder generated from this CDMReaders CDM
dataData to be written at the slicePositions
Exceptions
CDMExceptionon errors related to the CDM in combination with the underlying data-structure. It might also throw other (IO-)exceptions.
Warning
This method must be implemented for performance reasons.

Implements MetNoFimex::CDMReaderWriter.

virtual void MetNoFimex::NetCDF_CDMReader::sync ( )
virtual

flush data to disc

Implements MetNoFimex::CDMReaderWriter.


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