VPFTable Class Reference

#include <vpf_table.h>

Public Types
typedef VPFUtil::PointerArray< VPFDataValue >	Row
typedef VPFUtil::PointerArray< Row >	TableData

Public Member Functions
	VPFTable (const char *const fname, volatile bool &abortLoad)
	VPFTable (const char *const fname, const VPFTableHeader::ColumnDefinition::Check *const columnCheck, const unsigned int numColumnCheck, volatile bool &abortLoad)
virtual	~VPFTable ()
const VPFTableHeader *	GetTableHeader (void) const
const TableData *	GetTableData (void) const
unsigned int	GetRowCount (void) const
const VPFDataValue *	GetTableValue (const unsigned int rowNum, const unsigned int colNum) const
bool	IsValid (void) const

Protected Member Functions
void	Initialize (const char *const fname, volatile bool &abortLoad)
Row *	ReadRow (VPFFile &infile, VPFTableHeader &tableHeader, volatile bool &abortLoad) const
bool	CheckColumn (const unsigned int col, const VPFTableHeader::ColumnDefinition::Check &check, const bool colCanBeNULL=false) const
bool	CheckColumnForeignKey (const unsigned int col, const char *const colName, const bool colCanBeNULL=false) const

Protected Attributes
VPFUtil::WarningBool	_isValid
VPFTableHeader *	_tableHeader
TableData *	_data

Detailed Description

encapsulates a VPF table

Member Typedef Documentation

typedef VPFUtil::PointerArray<VPFDataValue> Row

array of VPFDataValue pointers

typedef VPFUtil::PointerArray<Row> TableData

array of Row pointers

Constructor & Destructor Documentation

VPFTable	(	const char *const	fname,
		volatile bool &	abortLoad
	)

Load the VPF table with the given filename es

Parameters

fname	filename of VPF table to load
abortLoad	can be set true by another thread to async abort the load

VPFTable	(	const char *const	fname,
		const VPFTableHeader::ColumnDefinition::Check *const	columnCheck,
		const unsigned int	numColumnCheck,
		volatile bool &	abortLoad
	)

Load the VPF table with the given filename and ensure that its columns match the columns described by the given column check structures. Check IsValid() to ensure that table was loaded successfully and columns match check structures

Parameters

fname	filename of VPF table to load
columnCheck	array of column check structures (!=NULL)
numColumnCheck	number of check structures in columnCheckArray
abortLoad	can be set true by another thread to async abort the load

virtual ~VPFTable ( )

virtual

Dtor

Member Function Documentation

bool CheckColumn ( const unsigned int  col, const VPFTableHeader::ColumnDefinition::Check &  check, const bool  colCanBeNULL = false  ) const

protected

Check if a given column definition matches the given column check

Parameters

col	zero based column number
check	column check
colCanBeNULL	[optional, defaults to false] true if column can optionally be a NULL data type and pass this check test

Returns

true if matches else false

bool CheckColumnForeignKey ( const unsigned int  col, const char *const  colName, const bool  colCanBeNULL = false  ) const

protected

Check if a given column definition matches a foreign key definition

Parameters

col	zero based column number
colName	name of column
colCanBeNULL	[optional, defaults to false] true if column can optionally be a NULL data type and pass this check test

Returns

true if matches else false

unsigned int GetRowCount ( void  ) const

inline

Get number of rows in table ( shortcut for GetTableData()->GetRowCount() )

Returns

number of rows in table

const TableData* GetTableData ( void  ) const

inline

Get the data in the table

Returns

table data else NULL

const VPFTableHeader* GetTableHeader ( void  ) const

inline

Get the table header for this table

Returns

table header for table else NULL

const VPFDataValue* GetTableValue	(	const unsigned int	rowNum,
		const unsigned int	colNum
	)		const

Get a specific column value from a specific row in the table

Parameters

rowNum	zero based row number
colNum	zero based column number

Returns

data value from table else NULL

void Initialize ( const char *const  fname, volatile bool &  abortLoad  )

protected

Initialize instance and load table from file. Used by Ctor

Parameters

fname	name of file to load
abortLoad	can be set true by another thread to async abort the load

bool IsValid ( void  ) const

inline

Determine if the table was loaded successfully

Returns

true if loaded else false

Row* ReadRow ( VPFFile &  infile, VPFTableHeader &  tableHeader, volatile bool &  abortLoad  ) const

protected

Read a row of data described by the given table header from the given file

Parameters

infile	file to read
tableHeader	table header describing data to read
abortLoad	can be set true by another thread to async abort the load

Returns

new row else NULL

Member Data Documentation

TableData* _data

protected

rows of table data values else NULL

VPFUtil::WarningBool _isValid

protected

true if a valid table was loaded else false

VPFTableHeader* _tableHeader

protected

header for table else NULL

---

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

• vpf_table.h