Main Page   Class Hierarchy   Compound List   Compound Members  

VOTColumn Class Reference

This class represents the column element <TD> in a <TABLE>. More...

List of all members.

Public Member Functions

 VOTColumn ()
 ~VOTColumn ()
VOTColumn operator= (const VOTColumn &column)
 VOTColumn (const VOTColumn &column)
int getLogicalArray (Bool *&boolArray, int *&valid, int &numOfElements)
int getBitArray (char *&bitArray, int &numOfElements)
int getByteArray (unsigned char *&byteArray, int &numOfElements)
int getShortArray (short *&shortArray, int *&valid, int &numOfElements)
int getIntArray (int *&intArray, int *&valid, int &numOfElements)
int getLongArray (long *&longArray, int *&valid, int &numOfElements)
int getCharArray (char *&charArray, int &numOfElements)
int getUnicodeArray (unsigned short *&unicodeArray, int &numOfElements)
int getFloatArray (float *&floatArray, int *&valid, int &numOfElements)
int getDoubleArray (double *&doubleArray, int *&valid, int &numOfElements)
int getFloatComplexArray (float *&complexArray, int *&valid, int &numOfElements)
int getDoubleComplexArray (double *&complexArray, int *&valid, int &numOfElements)
int getRef (char *&ref)

Detailed Description

This class represents the column element <TD> in a <TABLE>.

Column contains data in the primitive form. It may also contain an array.

Constructor & Destructor Documentation

VOTColumn::VOTColumn (   ) 
 

Default constructor.

VOTColumn::~VOTColumn (   ) 
 

Default deconstructor.

VOTColumn::VOTColumn (  const VOTColumn &  column  ) 
 

Copy constructor.

Member Function Documentation

int VOTColumn::getBitArray (  char *&  bitArray,
int &  numOfElements
) 
 

Gets the data in a bit array.

Parameters:
bitArray The bit array to get the data
numOfElements Number of elements in the data array
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR

int VOTColumn::getByteArray (  unsigned char *&  byteArray,
int &  numOfElements
) 
 

Gets the data in a byte array

Parameters:
byteArray The byte array to get the data
numOfElements Number of elements in the data and valid array
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getCharArray (  char *&  charArray,
int &  numOfElements
) 
 

Gets the data in a char array

Parameters:
charArray The char array to get the data
numOfElements Number of elements in the data array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR

int VOTColumn::getDoubleArray (  double *&  doubleArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the data in a double array. If the data in some array location is not double, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
doubleArray The double array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getDoubleComplexArray (  double *&  complexArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the complex data as double array. If the data in some array location is not double, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
complexArray The double array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR

int VOTColumn::getFloatArray (  float *&  floatArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the data in a float array. If the data in some array location is not float, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
floatArray The float array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getFloatComplexArray (  float *&  complexArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the complex data as float array. If the data in some array location is not float, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
complexArray The float array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getIntArray (  int *&  intArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the data in an integer array. If the data in some array location is not int, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
intArray The int array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getLogicalArray (  Bool *&  boolArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the data in a boolean array. If the data in some array location is not boolean, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
boolArray The boolean array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data array
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getLongArray (  long *&  longArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the data in a long array. If the data in some array location is not long, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
longArray The long array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getRef (  char *&  ref  ) 
 

Gets attribute 'ref' of <TD>.

int VOTColumn::getShortArray (  short *&  shortArray,
int *&  valid,
int &  numOfElements
) 
 

Gets the data in a short array. If the data in some array location is not short, this will be indicated by a INVALID_DATATYPE_ERROR in the corresponding array location of the 'valid' array.

Parameters:
shortArray The short array to get the data
valid Indicates whether data in the corresponding array location in the data array is of the correct datatype. A value of VOT_SUCCESS indicates success and INVALID_DATATYPE_ERROR indicates an error.
numOfElements Number of elements in the data and valid array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

int VOTColumn::getUnicodeArray (  unsigned short *&  unicodeArray,
int &  numOfElements
) 
 

Gets the unicode data array

Parameters:
unicodeArray The unsigned short array to get the data
numOfElements Number of elements in the data array.
Returns:
VOT_SUCCESS if data array has valid data, else VOT_ERROR.

VOTColumn VOTColumn::operator= (  const VOTColumn &  column  ) 
 

Assignment operator overloaded.

The documentation for this class was generated from the following files:
Generated on Fri May 9 19:13:17 2003 for C++ Streaming Parser by doxygen1.3