DtVpfColumn Class Reference

A class representing a column of data from a table. More...

List of all members.

Public Member Functions
	DtVpfColumn (DtVpfTable *table)
	Constructor takes the table that this column belongs to.
virtual	~DtVpfColumn ()
	Destructor.
virtual bool	readDescription ()
	Reads the column description.
virtual bool	readValue ()
	Reads the column data.
virtual const DtVpfData *	operator[] (const unsigned int row) const
	Reads the column description.
virtual DtString	columnName () const
	returns the column name
virtual char	dataType () const
	returns a character that represents the column data type
virtual int	numberDataElements () const
	returns the number of data elements in this column
virtual const DtString &	columnDescription () const
	returns the column description
virtual const DtString &	valueDescriptionTableName () const
	returns the description table name
virtual bool	hasValueDescription () const
	determines whether or not a colunmn has a value description
virtual const DtString	valueDescription (const int input) const
	returns the value description of the input value
virtual const DtString	valueDescription (const DtString &input) const
	returns the value description of the input value
virtual DtVpfTable *	table () const
	returns the table that owns this column
virtual unsigned int	numRows () const
	the number of rows that this column has
Protected Attributes
DtString	myColumnName
char	myDataType
DtString	myNumberDataElementsString
int	myNumberDataElements
char	myKeyType
DtString	myDescription
DtString	myValueDescriptionTableName
DtString	myThematicIndexTableName
DtString	myNarrativeTableName
bool	myHasValueDescription
bool	myHasThematicIndex
bool	myHasNarrative
DtVpfTable *	myTable
std::vector< DtVpfData * >	myData
Private Member Functions
	DtVpfColumn (const DtVpfColumn &column)
	Copy constructor is private to prevent copying.
DtVpfColumn &	operator= (const DtVpfColumn &column)
	Assignment Operator is private to prevent copying.

---

Detailed Description

A class representing a column of data from a table.

---

Constructor & Destructor Documentation

DtVpfColumn::DtVpfColumn

(

const DtVpfColumn &

column

)

[private]

Copy constructor is private to prevent copying.

DtVpfColumn::DtVpfColumn

(

DtVpfTable *

table

)

Constructor takes the table that this column belongs to.

virtual DtVpfColumn::~DtVpfColumn

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtVpfColumn& DtVpfColumn::operator=

(

const DtVpfColumn &

column

)

[private]

Assignment Operator is private to prevent copying.

virtual bool DtVpfColumn::readDescription

(

)

[virtual]

Reads the column description.

Returns:

A boolean indicating the success or failure of the read operation

virtual bool DtVpfColumn::readValue

(

)

[virtual]

Reads the column data.

Returns:

A boolean indicating the success or failure of the read operation

virtual const DtVpfData* DtVpfColumn::operator[]

(

const unsigned int

row

)

const [virtual]

Reads the column description.

Returns:

A boolean indicating the success or failure of the read operation DtInvalidInput if the index is out or range

virtual DtString DtVpfColumn::columnName

(

)

const [virtual]

returns the column name

Returns:

A DtString that holds the column name

virtual char DtVpfColumn::dataType

(

)

const [virtual]

returns a character that represents the column data type

Returns:

A character that represents the column data type

virtual int DtVpfColumn::numberDataElements

(

)

const [virtual]

returns the number of data elements in this column

Returns:

An integer that represents the number of data elements in this column

virtual const DtString& DtVpfColumn::columnDescription

(

)

const [virtual]

returns the column description

Returns:

A DtString reference that contains the description

virtual const DtString& DtVpfColumn::valueDescriptionTableName

(

)

const [virtual]

returns the description table name

Returns:

A DtString reference that contains the name of the description table

virtual bool DtVpfColumn::hasValueDescription

(

)

const [virtual]

determines whether or not a colunmn has a value description

Returns:

A boolean indicating whether or not there is a value description

virtual const DtString DtVpfColumn::valueDescription

(

const int

input

)

const [virtual]

returns the value description of the input value

Returns:

A DtString containing the value description

virtual const DtString DtVpfColumn::valueDescription

(

const DtString &

input

)

const [virtual]

returns the value description of the input value

Returns:

A DtString containing the value description

virtual DtVpfTable* DtVpfColumn::table

(

)

const [virtual]

returns the table that owns this column

Returns:

a DtVpfTable pointer that points to the table that owns this column

virtual unsigned int DtVpfColumn::numRows

(

)

const [virtual]

the number of rows that this column has

Returns:

An unsigned integer that represents the number of rows this column has.

---

Member Data Documentation

DtString DtVpfColumn::myColumnName [protected]

char DtVpfColumn::myDataType [protected]

DtString DtVpfColumn::myNumberDataElementsString [protected]

int DtVpfColumn::myNumberDataElements [protected]

char DtVpfColumn::myKeyType [protected]

DtString DtVpfColumn::myDescription [protected]

DtString DtVpfColumn::myValueDescriptionTableName [protected]

DtString DtVpfColumn::myThematicIndexTableName [protected]

DtString DtVpfColumn::myNarrativeTableName [protected]

bool DtVpfColumn::myHasValueDescription [protected]

bool DtVpfColumn::myHasThematicIndex [protected]

bool DtVpfColumn::myHasNarrative [protected]

DtVpfTable* DtVpfColumn::myTable [protected]

std::vector<DtVpfData*> DtVpfColumn::myData [protected]

---

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

• include/vmap/vpfColumn.h