LTableStorage

LTableStorage is an abstract PowerPlant class that specifies the interface for the data storage helper objects. These functions provide behaviors to maintain the data associated with a table.

Methods :

The methods in this class are:

LTableStorage()	~LTableStorage()
FindCellData()	GetCellData()
GetStorageSize()	InsertCols()
InsertRows()	RemoveCols()
RemoveRows()	SetCellData()

Data Members:

The data member in this class is:

mTableView

Operation:

All functions in this class are pure virtual, so when you inherit from this class you must provide implementations for every method.

Source files:

(Table Classes)

UTableHelpers.h

LTableStorage()

Purpose:

The constructor creates an object.

Access :

Public

Prototype:

LTableStorage();

None

~LTableStorage()

Purpose:

The destructor destroys the object.

Access :

Virtual, Public

Prototype:

virtual		 ~LTableStorage();

FindCellData()

Purpose:

Search a cell for the specified data.

Access :

Pure Virtual, Public

Prototype:

virtual Boolean		FindCellData(

	STableCell			&outCell, 

	const void			*inDataPtr,

	UInt32				inDataSize) const = 0;

This method has the following parameters:

STableCell&	outCell	A reference to the cell.
void*	inDataPtr	The buffer pointer.
UInt32	inDataSize	The buffer size.

Return:

Return true if the data is found.

GetCellData()

Purpose:

Retrieve data from a cell.

Access :

Pure Virtual, Public

Prototype:

virtual void		GetCellData(

	const STableCell	&inCell,

	void				*outDataPtr,

	UInt32				&ioDataSize) const = 0;

This method has the following parameters:

STableCell&	inCell	A reference to the cell.
void*	outDataPtr	The buffer pointer.
UInt32	ioDataSize	The buffer size.

Return:

None

GetStorageSize()

Purpose:

Get the storage size.

Access :

Pure Virtual, Public

Prototype:

virtual void		GetStorageSize(

	TableIndexT			&outRows,

	TableIndexT			&outCols ) = 0

This method has the following parameters:

TableIndexT&	outRows	The number of rows in storage.
TableIndexT&	outCols	The number of columns in storage.

Return:

None

InsertCols()

Purpose:

Insert more columns into storage.

Access :

Pure Virtual, Public

Prototype:

virtual void		InsertCols(

	UInt32				inHowMany,

	TableIndexT			inAfterCol,

	const void			*inDataPtr,

	UInt32				inDataSize) = 0;

This method has the following parameters:

UInt32	inHowMany	The number of columns to insert.
TableIndexT	inAfterCol	The column to insert after.
void*	inDataPtr	The buffer pointer.
UInt32	inDataSize	The buffer size.

Return:

None

InsertRows()

Purpose:

Insert more rows into storage.

Access :

Pure Virtual, Public

Prototype:

virtual void		InsertRows(

	UInt32				inHowMany,

	TableIndexT			inAfterRow,

	const void			*inDataPtr,

	UInt32				inDataSize) = 0;

This method has the following parameters:

UInt32	inHowMany	The number of columns to insert.
TableIndexT	inAfterRow	The row to insert after.
void*	inDataPtr	The buffer pointer.
UInt32	inDataSize	The buffer size.

Return:

None

RemoveCols()

Purpose:

Remove columns from storage.

Access :

Pure Virtual, Public

Prototype:

virtual void		RemoveCols(

	UInt32				inHowMany,

	TableIndexT			inFromCol ) = 0;

This method has the following parameters:

UInt32	inHowMany	The number of columns to remove.
TableIndexT	inFromCol	The column to start removal from.

Return:

None

RemoveRows()

Purpose:

Remove rows from storage.

Access :

Pure Virtual, Public

Prototype:

virtual void		RemoveRows(

	UInt32				inHowMany,

	TableIndexT			inFromRow) = 0;

This method has the following parameters:

UInt32	inHowMany	The number of rows to remove.
TableIndexT	inFromRow	The row to start removal from.

Return:

None

SetCellData()

Purpose:

Put data into a storage cell.

Access :

Pure Virtual, Public

Prototype:

virtual void		SetCellData(

	const STableCell	&inCell,

	const void			*inDataPtr,

	UInt32				inDataSize ) = 0;

This method has the following parameters:

STableCell&	inCell	The cell.
void *	inDataPtr	The buffer pointer.
UInt32	inDataSize	The buffer size.

Return:

None

mTableView

Purpose:

Storage for the pointer to the table.

Access :

Public

Prototype:

LTableView *mTableView;