VcstLutInputItem

#include <VcstLutInputItem.h>

Inheritance diagram for VcstLutInputItem:

Collaboration diagram for VcstLutInputItem:

Public Member Functions
	VcstLutInputItem (const std::string &groupName, size_t size)
virtual	~VcstLutInputItem ()
virtual int	getData ()
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 VcstLutInputItem *	getInstance ()

Protected Member Functions
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 ()

Static Protected Member Functions
template<typename T >
static void	byteSwap (T &aValue)

Protected Attributes
std::string	groupName_

Static Protected Attributes
static const std::size_t	MAX_IO_SIZE = 1073741824

Detailed Description

Definition at line 19 of file VcstLutInputItem.h.

Constructor & Destructor Documentation

VcstLutInputItem()

VcstLutInputItem	(	const std::string &	groupName,
		size_t	size
	)

Constructor

Parameters

lutName

The LUT name that identifies the data buffer.

~VcstLutInputItem()

virtual ~VcstLutInputItem ( )

virtual

Destructor

Member Function Documentation

allocateMemory()

int allocateMemory ( size_t  size )

protected

Allocate memory

byteSwap()

void byteSwap ( T &  aValue )

staticprotected

Converts the endianness of the parameter by performing the appropriate byte swapping.

Definition at line 226 of file VcstLutInputItem.h.

convertEndianness()

virtual int convertEndianness ( )

protectedvirtual

Convert endianness of LUT file.

Reimplemented in VcstGeoAncInputItem, VcstCmnLutInputItem, VcstCalLutInputItem, and VcstGeoLutInputItem.

dataPtrEstablished()

const bool dataPtrEstablished ( ) const

inlineprotected

Definition at line 108 of file VcstLutInputItem.h.

dataPtrUnknown()

bool dataPtrUnknown ( ) const

inline

Definition at line 67 of file VcstLutInputItem.h.

determineFileSize()

size_t determineFileSize ( const std::string &  fileName )

protected

Determine file size on disk

getData()

virtual int getData ( )

virtual

Handles the details of retrieving the data item from disk.

Returns

PRO_SUCCESS or PRO_FAIL

Reimplemented in VcstPolarWanderItem, VcstGeoAncInputItem, VcstCalNetcdfInputItem, VcstGeoNetcdfInputItem, and VcstCmnLutInputItem.

getDataPtr()

void* getDataPtr ( ) const

inline

Definition at line 63 of file VcstLutInputItem.h.

getDataSize()

const size_t getDataSize ( ) const

inlineprotected

Definition at line 104 of file VcstLutInputItem.h.

getFileName()

const std::string getFileName

(

)

const

getFilePath()

const std::string getFilePath

(

)

const

getGroupName()

const std::string getGroupName ( ) const

inlineprotected

Inline gets

Definition at line 100 of file VcstLutInputItem.h.

getInstance()

static VcstLutInputItem* getInstance ( )

inlinestatic

Retrieve instance

Definition at line 51 of file VcstLutInputItem.h.

getShortName()

const std::string getShortName

(

)

const

isItemOkForIO()

virtual bool isItemOkForIO ( )

protectedvirtual

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

Reimplemented in VcstGeoAncInputItem.

releaseMemory()

void releaseMemory ( )

protected

Release allocated memory

setDataPtr()

void setDataPtr ( void *  ptr )

inline

Definition at line 81 of file VcstLutInputItem.h.

setDataSize()

void setDataSize ( size_t  size )

inlineprotected

Definition at line 120 of file VcstLutInputItem.h.

setFilePath()

void setFilePath

(

const std::string &

filePath

)

setGroupName()

void setGroupName ( std::string  strName )

inlineprotected

Inline sets

Definition at line 116 of file VcstLutInputItem.h.

setIsAllocated()

void setIsAllocated ( bool  bVal )

inlineprotected

Definition at line 124 of file VcstLutInputItem.h.

setShortName()

void setShortName

(

const std::string &

shortName

)

Member Data Documentation

groupName_

std::string groupName_

protected

This data item's group name

Definition at line 165 of file VcstLutInputItem.h.

MAX_IO_SIZE

const std::size_t MAX_IO_SIZE = 1073741824

staticprotected

Definition at line 87 of file VcstLutInputItem.h.

---

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

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