OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <L3FileSMI.h>

Inheritance diagram for L3FileSMI:
[legend]
Collaboration diagram for L3FileSMI:
[legend]

Public Member Functions

 L3FileSMI ()
 
virtual ~L3FileSMI ()
 
template<typename TheType >
bool readAttribute (std::string name, TheType &val)
 
template<typename TheType >
bool readAttribute (const netCDF::NcGroup &group, std::string name, TheType &val)
 
template<typename TheType >
bool readAttribute (const netCDF::NcVar &var, std::string name, TheType &val)
 
template<typename TheType >
bool readAttribute (const netCDF::NcVar &var, std::string name, TheType *val)
 
virtual bool readVarCF (netCDF::NcVar &var, const std::vector< size_t > &start, const std::vector< size_t > &count, float *data)
 
virtual bool open (const char *fileName)
 
virtual void close ()
 
virtual meta_l3bTypegetMetaData ()
 
virtual int32_t getNumProducts ()
 
virtual std::string getProductName (size_t index=0)
 
virtual bool setActiveProductList (const char *prodStr)
 
virtual bool hasQuality ()
 
- Public Member Functions inherited from L3File
 L3File ()
 
virtual ~L3File ()
 
virtual int64_t rowbin2record (int32_t row, int64_t bin)
 
virtual int64_t rowcol2record (int32_t row, int32_t col)
 
virtual int64_t latlon2record (float lat, float lon)
 
virtual int64_t bin2record (int64_t bin)
 
virtual void clearCache ()
 
virtual void setNumCacheRows (int32_t numRows)
 
virtual int32_t getNumActiveProducts ()
 
virtual std::string getActiveProductName (size_t index=0)
 
virtual int32_t getNumRows ()
 
virtual L3RowgetRow (int32_t row)
 
virtual L3BingetBin (int32_t row, int32_t col)
 
virtual L3BingetClosestBin (float lat, float lon)
 
template<typename Geometry >
L3BingetBinsInside (Geometry geo, bool areaWeighted=false)
 
virtual Hdf::hdf_bingetHdfBinObject () const
 
virtual void setQualityProcessing (bool val)
 
virtual bool getQualityProcessing () const
 
virtual L3ShapegetShape () const
 

Protected Member Functions

virtual int initRecordLookup ()
 
virtual L3RowreadRow (int32_t row)
 
- Protected Member Functions inherited from L3File
template<typename Geometry >
bool addBinsFromRow (float lat0, float lon0, Geometry geo, bool areaWeighted)
 

Protected Attributes

std::vector< std::stringprodNameList
 
netCDF::NcFile * ncFile
 
meta_l3bType metaData
 
std::vector< netCDF::NcVar > prodVarList
 
- Protected Attributes inherited from L3File
L3Shapeshape
 
Hdf::hdf_binbinObj
 
std::list< L3Row * > rowList
 
int numCacheRows
 
int64_t * baseRecord
 
int32_t * extentbin
 
float * sumBuffer
 
L3Bin outBin
 
uint8_t * qualityBuffer
 
size_t * prodMap
 
size_t numProds
 
std::vector< std::stringactiveProdNameList
 

Detailed Description

class to read the information out of a L3 SMI file

Definition at line 13 of file L3FileSMI.h.

Constructor & Destructor Documentation

◆ L3FileSMI()

L3FileSMI ( )

Definition at line 19 of file L3FileSMI.cpp.

◆ ~L3FileSMI()

~L3FileSMI ( )
virtual

Definition at line 25 of file L3FileSMI.cpp.

Member Function Documentation

◆ close()

void close ( )
virtual

Reimplemented from L3File.

Definition at line 316 of file L3FileSMI.cpp.

◆ getMetaData()

meta_l3bType * getMetaData ( )
virtual

Reimplemented from L3File.

Definition at line 328 of file L3FileSMI.cpp.

◆ getNumProducts()

int32_t getNumProducts ( )
virtual

Reimplemented from L3File.

Definition at line 366 of file L3FileSMI.cpp.

◆ getProductName()

string getProductName ( size_t  index = 0)
virtual

Reimplemented from L3File.

Definition at line 370 of file L3FileSMI.cpp.

◆ hasQuality()

bool hasQuality ( )
virtual

Reimplemented from L3File.

Definition at line 462 of file L3FileSMI.cpp.

◆ initRecordLookup()

int initRecordLookup ( )
protectedvirtual

init the internal data structures to lookup the record index

Returns
status 0 if good, -1 if bad

Reimplemented from L3File.

Definition at line 336 of file L3FileSMI.cpp.

◆ open()

bool open ( const char *  fileName)
virtual

Reimplemented from L3File.

Definition at line 238 of file L3FileSMI.cpp.

◆ readAttribute() [1/4]

bool readAttribute ( const netCDF::NcGroup &  group,
std::string  name,
TheType &  val 
)
inline

Definition at line 43 of file L3FileSMI.h.

◆ readAttribute() [2/4]

bool readAttribute ( const netCDF::NcVar &  var,
std::string  name,
TheType &  val 
)
inline

Definition at line 58 of file L3FileSMI.h.

◆ readAttribute() [3/4]

bool readAttribute ( const netCDF::NcVar &  var,
std::string  name,
TheType *  val 
)
inline

Definition at line 73 of file L3FileSMI.h.

◆ readAttribute() [4/4]

bool readAttribute ( std::string  name,
TheType &  val 
)
inline

Definition at line 29 of file L3FileSMI.h.

◆ readRow()

L3Row * readRow ( int32_t  row)
protectedvirtual

Reimplemented from L3File.

Definition at line 407 of file L3FileSMI.cpp.

◆ readVarCF()

bool readVarCF ( netCDF::NcVar &  var,
const std::vector< size_t > &  start,
const std::vector< size_t > &  count,
float *  data 
)
virtual

Definition at line 29 of file L3FileSMI.cpp.

◆ setActiveProductList()

bool setActiveProductList ( const char *  prodStr)
virtual

Reimplemented from L3File.

Definition at line 374 of file L3FileSMI.cpp.

Member Data Documentation

◆ metaData

meta_l3bType metaData
protected

Definition at line 17 of file L3FileSMI.h.

◆ ncFile

netCDF::NcFile* ncFile
protected

Definition at line 16 of file L3FileSMI.h.

◆ prodNameList

std::vector<std::string> prodNameList
protected

array of all product names in file

Definition at line 15 of file L3FileSMI.h.

◆ prodVarList

std::vector<netCDF::NcVar> prodVarList
protected

Definition at line 18 of file L3FileSMI.h.


The documentation for this class was generated from the following files:
  • /gfs-oceanweb/web/ocssw/ocssw_src/oel_hdf4/libbin/L3FileSMI.h
  • /gfs-oceanweb/web/ocssw/ocssw_src/oel_hdf4/libbin/L3FileSMI.cpp