OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <VcstGeoAncInputItem.h>

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

Public Member Functions

 VcstGeoAncInputItem (const std::string &groupName, size_t size, const std::string &tileId)
 
virtual ~VcstGeoAncInputItem ()
 
virtual int setCSN ()
 
const std::stringgetTileId () const
 
void setTileId (const std::string &tileId)
 
virtual int getData ()
 
- Public Member Functions inherited from VcstLutInputItem
 VcstLutInputItem (const std::string &groupName, size_t size)
 
virtual ~VcstLutInputItem ()
 
void * getDataPtr () const
 
bool dataPtrUnknown () const
 
const std::string getShortName () const
 
void setShortName (const std::string &shortName)
 
const std::string getFilePath () const
 
void setFilePath (const std::string &filePath)
 
const std::string getFileName () const
 
void setDataPtr (void *ptr)
 

Protected Member Functions

virtual bool isItemOkForIO ()
 
virtual int convertEndianness ()
 
virtual int readNetCDF ()
 
- Protected Member Functions inherited from VcstLutInputItem
const std::string getGroupName () const
 
const size_t getDataSize () const
 
const bool dataPtrEstablished () const
 
void setGroupName (std::string strName)
 
void setDataSize (size_t size)
 
void setIsAllocated (bool bVal)
 
size_t determineFileSize (const std::string &fileName)
 
int allocateMemory (size_t size)
 
void releaseMemory ()
 

Additional Inherited Members

- Static Public Member Functions inherited from VcstLutInputItem
static VcstLutInputItemgetInstance ()
 
- Static Protected Member Functions inherited from VcstLutInputItem
template<typename T >
static void byteSwap (T &aValue)
 
- Protected Attributes inherited from VcstLutInputItem
std::string groupName_
 
- Static Protected Attributes inherited from VcstLutInputItem
static const std::size_t MAX_IO_SIZE = 1073741824
 

Detailed Description

Derived class of AdlCmnInputItem. This class represents a single SRTM30Plus tile. The difference between this class and an AdlCmnInput item is that this class must use a tile ID to retrieve the appropriate file from disk.

Definition at line 40 of file VcstGeoAncInputItem.h.

Constructor & Destructor Documentation

◆ VcstGeoAncInputItem()

VcstGeoAncInputItem ( const std::string groupName,
size_t  size,
const std::string tileId 
)

Constructor

Parameters
groupNameThe group name of this data item
sizeThe size of this data item's buffer
tileIdThe tile ID of this item

◆ ~VcstGeoAncInputItem()

virtual ~VcstGeoAncInputItem ( )
virtual

Destructor

Member Function Documentation

◆ convertEndianness()

virtual int convertEndianness ( )
protectedvirtual

Convert endianness of LUT file.

Reimplemented from VcstLutInputItem.

◆ getData()

virtual int getData ( )
virtual

Handles the details of retrieving the data item from disk.

Returns
PRO_SUCCESS or PRO_FAIL

Reimplemented from VcstLutInputItem.

◆ getTileId()

const std::string& getTileId ( ) const

Accessors

◆ isItemOkForIO()

virtual bool isItemOkForIO ( )
protectedvirtual

Checks attributes of this data item to determine if it is able to be read from disk

Reimplemented from VcstLutInputItem.

◆ readNetCDF()

virtual int readNetCDF ( )
protectedvirtual

Read netCDF DEM LUT file.

Returns
PRO_SUCCESS or PRO_FAIL

◆ setCSN()

virtual int setCSN ( )
virtual

Determines the CSN the config guide.

Parameters
envPointer to the environment that this data item is part of.
Returns
PRO_SUCCESS or PRO_FAIL

◆ setTileId()

void setTileId ( const std::string tileId)

Mutators


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