VcstPolarWanderItem

#include <VcstPolarWanderItem.h>

Inheritance diagram for VcstPolarWanderItem:

Collaboration diagram for VcstPolarWanderItem:

Classes
struct	finalsEntry

Public Member Functions
	VcstPolarWanderItem ()
virtual	~VcstPolarWanderItem ()
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)

Static Public Member Functions
static VcstPolarWanderItem *	getInstance ()
Static Public Member Functions inherited from VcstLutInputItem
static VcstLutInputItem *	getInstance ()

Protected Member Functions
	VcstPolarWanderItem (const VcstPolarWanderItem &right)
VcstPolarWanderItem &	operator= (const VcstPolarWanderItem &right)
int	readMetadata (std::string filepath)
int	ReadAsciiPolarWanderFile (std::string filepath, char *bufPtr)
int	ReadH5PolarWanderFile (std::string filepath, char *bufPtr)
int	fillInternalBuffer (char *bufPtr)
void	extractField (std::stringstream &converter, unsigned char *source, const unsigned int offset, const unsigned int length)
Protected Member Functions inherited from VcstLutInputItem
virtual bool	isItemOkForIO ()
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 ()
virtual int	convertEndianness ()

Protected Attributes
unsigned char *	nativeBuffer_
int	nativeBufferSize_
Protected Attributes inherited from VcstLutInputItem
std::string	groupName_

Additional Inherited Members
Static Protected Member Functions inherited from VcstLutInputItem
template<typename T >
static void	byteSwap (T &aValue)
Static Protected Attributes inherited from VcstLutInputItem
static const std::size_t	MAX_IO_SIZE = 1073741824

Detailed Description

This class is derived from the AdlCmnInputItem class. It represents a HDF5 Polar Wander data item.

Definition at line 38 of file VcstPolarWanderItem.h.

Constructor & Destructor Documentation

VcstPolarWanderItem() [1/2]

VcstPolarWanderItem

(

)

Constructor

Parameters

groupName	The group name that identifies the data buffer.
client	The DMS client pointer. Null for ADL, but present to retain the proper data item interface.
caller	who instantiated this object
collectionShortName	The CSN for this input item

~VcstPolarWanderItem()

virtual ~VcstPolarWanderItem ( )

virtual

Destructor

VcstPolarWanderItem() [2/2]

VcstPolarWanderItem ( const VcstPolarWanderItem &  right )

protected

Copy constructor.

Member Function Documentation

extractField()

void extractField ( std::stringstream &  converter, unsigned char *  source, const unsigned int  offset, const unsigned int  length  )

protected

Extracts a field from the source row and places it into a string stream as a null terminated character array.

Parameters

converter	Stream used to hold extracted value
source	Source buffer for the data being extracted
offset	Offset into the source buffer for the data being extracted
length	Length of the data being extracted

fillInternalBuffer()

int fillInternalBuffer ( char *  bufPtr )

protected

Method to copy the static anc out of its native format into an internal format

getData()

virtual int getData ( )

virtual

Handles the details of retrieving the data item from disk.

Returns

PRO_SUCCESS or PRO_FAIL

Reimplemented from VcstLutInputItem.

getInstance()

static VcstPolarWanderItem* getInstance ( )

inlinestatic

Retrieve instance

Definition at line 83 of file VcstPolarWanderItem.h.

operator=()

VcstPolarWanderItem& operator= ( const VcstPolarWanderItem &  right )

protected

Assignment operator.

ReadAsciiPolarWanderFile()

int ReadAsciiPolarWanderFile ( std::string  filepath, char *  bufPtr  )

protected

Method to read an ASCII polar wander file into memory

ReadH5PolarWanderFile()

int ReadH5PolarWanderFile ( std::string  filepath, char *  bufPtr  )

protected

Method to read an HDF5 polar wander file into memory

readMetadata()

int readMetadata ( std::string  filepath )

protected

Inserts file metadata

Member Data Documentation

nativeBuffer_

unsigned char* nativeBuffer_

protected

Definition at line 205 of file VcstPolarWanderItem.h.

nativeBufferSize_

int nativeBufferSize_

protected

Definition at line 206 of file VcstPolarWanderItem.h.

---

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

• /gfs-oceanweb/web/ocssw/ocssw_src/include/ViirsCmn/VcstPolarWanderItem.h