RVC::DBTABLE::RECORD

RVC::DBTABLE::RECORD Class Reference

Class to contain a database record. More...

#include <rvc/dbtable.h>

Inheritance diagram for RVC::DBTABLE::RECORD:

Inheritance graph
RVC::DBTABLE::RECORD_EXTRUDED_POINTSRVC::DBTABLE::RECORD_FLIGHTPATHRVC::DBTABLE::RECORD_ID_ELEMENTRVC::DBTABLE::RECORD_ID_POINTRVC::DBTABLE::RECORD_INFLUENCE_SPHERERVC::DBTABLE::RECORD_LEGENDELEMENTRVC::DBTABLE::RECORD_NODETURNRVC::DBTABLE::RECORD_PARAMETERS_SELECTRVC::DBTABLE::RECORD_PARAMETERS_STYLERVC::DBTABLE::RECORD_POINTOFINTERESTRVC::DBTABLE::RECORD_SCALESELECTRVC::DBTABLE::RECORD_SELECTIONRVC::DBTABLE::RECORD_STYLE_CADRVC::DBTABLE::RECORD_STYLE_ELEMENT
[legend]
List of all members.

Public Types

enum  FIELDFLAG {
  FIELDFLAG_None = 0x0000, FIELDFLAG_NaN = 0x0010, FIELDFLAG_NoUnitConv = 0x0020, FIELDFLAG_MultiKey = 0x0040,
  FIELDFLAG_LocalTime = 0x0080, FIELDFLAG_MemoEncoding = 0x8000
}

Public Member Functions

ERRVALUE AssignTable (const RVC::DBTABLE &table)
void Clear ()
bool CompareField (INT32 FieldNum, const RECORD &record, double threshhold=0.0) const
INT32 CompareFieldOrdered (INT32 FieldNum, const RECORD &record, double threshhold=0.0) const
bool CompareRecords (RECORD &rhs, double threshhold=0.0)
INT32 ComputeHash () const
ERRVALUE CopyTo (RECORD &DestRecord) const
void GetData (SIMPLE_ARRAY< UINT8 > &Data) const
INT32 GetRecordNumber () const
INT32 GetTableNumber () const
ERRVALUE GetValue (INT32 FieldNum, COLOR &color) const
double GetValue (INT32 FieldNum, FIELDFLAG FieldFlag=FIELDFLAG_None) const
ERRVALUE GetValue (INT32 FieldNum, MISTRING &string, FIELDFLAG FieldFlag=FIELDFLAG_None, int DecimalPlaces=-1, const UNITCONV *UnitConv=0) const
ERRVALUE GetValueBinary (INT32 FieldNum, SIMPLE_ARRAY< UINT8 > &binary) const
ERRVALUE Initialize ()
bool IsAssigned () const
bool operator!= (RECORD &rhs)
RECORD & operator= (const RECORD &rhs)
bool operator== (RECORD &rhs)
 RECORD (const RVC::DBTABLE &table)
 RECORD (const RECORD &rhs)
 RECORD ()
DEPRECATED void SetData (const void *buf)
void SetData (const SIMPLE_ARRAY< UINT8 > &Data)
ERRVALUE SetKeyValues (INT32 StartFieldNum, const RECORD &SourceRecord)
ERRVALUE SetValue (INT32 FieldNum, const RECORD &SourceRecord, INT32 SourceFieldNum)
void SetValue (INT32 FieldNum, double value, bool NoUnitConv=false)
ERRVALUE SetValue (INT32 FieldNum, const MISTRING &string, FIELDFLAG FieldFlag=FIELDFLAG_None, const UNITCONV *conv=0)
ERRVALUE SetValue (INT32 FieldNum, const COLOR &color)
ERRVALUE SetValueBinary (INT32 FieldNum, const SIMPLE_ARRAY< UINT8 > &binary) const
virtual ~RECORD ()

Protected Member Functions

void * GetFieldPtr (INT32 FieldNum)
const void *const GetFieldPtr (INT32 FieldNum) const
virtual bool IsValidTable (const RVC::DBTABLE &)

Detailed Description

Class to contain a database record.

Definition at line 2956 of file dbtable.h.

Member Enumeration Documentation

enum RVC::DBTABLE::RECORD::FIELDFLAG

Flags for reading field methods (i.e. RVCDBTABLE::ReadField()).

Enumerator:
FIELDFLAG_None 
FIELDFLAG_NaN  Return NaN for unknown values.
FIELDFLAG_NoUnitConv  Don't do any unit conversion.
FIELDFLAG_MultiKey  String together multi-field keys with commas (for MfReadFieldStr()).
FIELDFLAG_LocalTime  Show FIELD::TYPE_DateTime in local time zone.
FIELDFLAG_MemoEncoding  Memo field has table.encoding encoding.

Definition at line 2960 of file dbtable.h.

Constructor & Destructor Documentation

RVC::DBTABLE::RECORD::RECORD (  ) 

Default constructor.

RVC::DBTABLE::RECORD::RECORD ( const RECORD &  rhs  ) 

Copy constructor.

RVC::DBTABLE::RECORD::RECORD ( const RVC::DBTABLE &  table  ) 

Constructor from RVCDBTABLE - used to setup internal items.

virtual RVC::DBTABLE::RECORD::~RECORD (  )  [virtual]

Destructor.

Member Function Documentation

ERRVALUE RVC::DBTABLE::RECORD::AssignTable ( const RVC::DBTABLE &  table  ) 

Initialize this record to work with this table, used to setup internal items.

void RVC::DBTABLE::RECORD::Clear (  ) 

Clear the record.

bool RVC::DBTABLE::RECORD::CompareField ( INT32  FieldNum,
const RECORD &  record,
double  threshhold = 0.0 
) const

Compare two entries in a field to determine if they are equal.

INT32 RVC::DBTABLE::RECORD::CompareFieldOrdered ( INT32  FieldNum,
const RECORD &  record,
double  threshhold = 0.0 
) const

Compare two entries in a field to determine sort order returns <0 if "this" is < record, >0 if this > record, = if same.

bool RVC::DBTABLE::RECORD::CompareRecords ( RECORD &  rhs,
double  threshhold = 0.0 
)

INT32 RVC::DBTABLE::RECORD::ComputeHash (  )  const

Compute a hash value for the current record.

This is used by the database join code to quickly compare two records for equality.

ERRVALUE RVC::DBTABLE::RECORD::CopyTo ( RECORD &  DestRecord  )  const

Copy the field values from one record to another.

Unlike using the assignment operator, which assumes the same table (or at least same structure), this method will cope with the possibility that the source record may have different field sizes and offsets than the destination record. Note: it assumes that the records come from tables with the same number of fields and won't do any field reordering.

void RVC::DBTABLE::RECORD::GetData ( SIMPLE_ARRAY< UINT8 > &  Data  )  const

Read an entire record into a byte array.

void* RVC::DBTABLE::RECORD::GetFieldPtr ( INT32  FieldNum  )  [inline, protected]

Definition at line 3164 of file dbtable.h.

const void* const RVC::DBTABLE::RECORD::GetFieldPtr ( INT32  FieldNum  )  const [inline, protected]

Definition at line 3160 of file dbtable.h.

INT32 RVC::DBTABLE::RECORD::GetRecordNumber (  )  const

Get the current record number refered to by this instance.

Returns:
Record number if >= 0 or -1 if not associated with a record in a table

INT32 RVC::DBTABLE::RECORD::GetTableNumber (  )  const

Get the current table number refered to by this instance.

Returns:
Table number if >= 0 or TABLE_Invalid if not associated with a table

ERRVALUE RVC::DBTABLE::RECORD::GetValue ( INT32  FieldNum,
COLOR &  color 
) const

Read the value of a COLOR field.

double RVC::DBTABLE::RECORD::GetValue ( INT32  FieldNum,
FIELDFLAG  FieldFlag = FIELDFLAG_None 
) const

Read a field from this record and return a double.

Returns:
Double value converted from the field specified

ERRVALUE RVC::DBTABLE::RECORD::GetValue ( INT32  FieldNum,
MISTRING &  string,
FIELDFLAG  FieldFlag = FIELDFLAG_None,
int  DecimalPlaces = -1,
const UNITCONV *  UnitConv = 0 
) const

Read a field from this record into an MISTRING.

ERRVALUE RVC::DBTABLE::RECORD::GetValueBinary ( INT32  FieldNum,
SIMPLE_ARRAY< UINT8 > &  binary 
) const

Read a binary field from this record into a SIMPLE_ARRAY<UINT8> This will return an empty array if the field is not a FIELDINFO::TYPE_Binary.

ERRVALUE RVC::DBTABLE::RECORD::Initialize (  ) 

Initialize the record with the constraints set for the table.

bool RVC::DBTABLE::RECORD::IsAssigned (  )  const

Determine if 'this' is assigned to a table.

Returns:
'True' if assigned to a table, 'false' if not

virtual bool RVC::DBTABLE::RECORD::IsValidTable ( const RVC::DBTABLE &   )  [inline, protected, virtual]

Definition at line 3158 of file dbtable.h.

bool RVC::DBTABLE::RECORD::operator!= ( RECORD &  rhs  )  [inline]

Inequality - compares if the information in the two records are not the same, including memo and computed fields.

Definition at line 3004 of file dbtable.h.

RECORD& RVC::DBTABLE::RECORD::operator= ( const RECORD &  rhs  ) 

Assignment.

bool RVC::DBTABLE::RECORD::operator== ( RECORD &  rhs  ) 

Equality - compares if the information in the two records are the same, including memo and computed fields.

DEPRECATED void RVC::DBTABLE::RECORD::SetData ( const void *  buf  ) 

Temprorary until all of the database editor is converted over.

Assumes the caller allocated the buffer to the correct size.

void RVC::DBTABLE::RECORD::SetData ( const SIMPLE_ARRAY< UINT8 > &  Data  ) 

Write an entire record from a byte array.

ERRVALUE RVC::DBTABLE::RECORD::SetKeyValues ( INT32  StartFieldNum,
const RECORD &  SourceRecord 
)

Write a set of fields from another RECORD field to this record if the tables are related using the key field / next field association.

ERRVALUE RVC::DBTABLE::RECORD::SetValue ( INT32  FieldNum,
const RECORD &  SourceRecord,
INT32  SourceFieldNum 
)

Write a field from another RECORD field to this record.

void RVC::DBTABLE::RECORD::SetValue ( INT32  FieldNum,
double  value,
bool  NoUnitConv = false 
)

Write a field from a double to this record.

ERRVALUE RVC::DBTABLE::RECORD::SetValue ( INT32  FieldNum,
const MISTRING &  string,
FIELDFLAG  FieldFlag = FIELDFLAG_None,
const UNITCONV *  conv = 0 
)

Write a field from a MISTRING to this record.

ERRVALUE RVC::DBTABLE::RECORD::SetValue ( INT32  FieldNum,
const COLOR &  color 
)

Write a field from a COLOR to this record (for COLOR fields only).

ERRVALUE RVC::DBTABLE::RECORD::SetValueBinary ( INT32  FieldNum,
const SIMPLE_ARRAY< UINT8 > &  binary 
) const

Write a binary field to this record from a SIMPLE_ARRAY<UINT8>.

The documentation for this class was generated from the following file:
Generated on Thu Apr 26 04:48:54 2007 for TNTsdk by  doxygen 1.5.2