Main Page | Class Hierarchy | Class List | File List | Class Members

dimeTableEntry Class Reference

The dimeTableEntry class is the superclass for all table classes. More...

#include <dime/tables/TableEntry.h>

Inheritance diagram for dimeTableEntry:

dimeRecordHolder dimeBase dimeLayerTable dimeUCSTable dimeUnknownTable List of all members.

Public Member Functions

 dimeTableEntry ()
virtual ~dimeTableEntry ()
virtual const char * getTableName () const =0
virtual bool read (dimeInput *const in)
virtual bool write (dimeOutput *const out)
virtual dimeTableEntrycopy (dimeModel *const model) const =0
virtual int typeId () const =0
virtual bool isOfType (const int thetypeid) const
virtual int countRecords () const

Static Public Member Functions

dimeTableEntrycreateTableEntry (const char *const name, dimeMemHandler *const memhandler=NULL)

Protected Member Functions

bool preWrite (dimeOutput *const output)
virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
bool copyRecords (dimeTableEntry *const table, dimeModel *const model) const

Detailed Description

The dimeTableEntry class is the superclass for all table classes.


Constructor & Destructor Documentation

dimeTableEntry::dimeTableEntry  ) 
 

Constructor.

dimeTableEntry::~dimeTableEntry  )  [virtual]
 

Destructor.


Member Function Documentation

bool dimeTableEntry::copyRecords dimeTableEntry *const  table,
dimeModel *const  model
const [protected]
 

Copies the unclassified records.

int dimeTableEntry::countRecords  )  const [virtual]
 

Returns the number of records for this table. Tables overloading this function should first count the number of records they will write, then add the return value of this function to get the total number of records.

Reimplemented from dimeRecordHolder.

Reimplemented in dimeLayerTable, dimeUCSTable, and dimeUnknownTable.

dimeTableEntry * dimeTableEntry::createTableEntry const char *const  name,
dimeMemHandler *const  memhandler = NULL
[static]
 

Static function that creates a table based on its name.

bool dimeTableEntry::handleRecord const int  groupcode,
const dimeParam param,
dimeMemHandler *const  memhandler
[protected, virtual]
 

Must be overloaded by entities that directly supports a record type. During dimeRecordHolder::read(), dimeRecordHolder::setRecord and dimeRecordHolder::setRecords, this function is called for every record found, and it is up to the subclass if the record should be stored internally, or if a generic record should be created and stored in this superclass. A subclass should return when it will handle the record, false otherwise. Default function does nothing, and returns false.

For entities, records with group codes 8 (layer name) and 62 (color number) are automatically handled by the dimeEntity class.

See also:
dimeRecordHolder::read()

dimeRecordHolder::setRecord()

Reimplemented from dimeRecordHolder.

Reimplemented in dimeLayerTable, and dimeUCSTable.

bool dimeTableEntry::isOfType const int  thetypeid  )  const [virtual]
 

Returns true if the object is of type typeid or is inherited from it. Function in base class checks whether thetypeid equals the virtual dimeBase::typeId() value or equals dimeBaseType. Must be implemented by all subclasses that are superclasses of other classes, and should check if thetypeid equals its typeId, and then call its parent's isOfType function. Leaf-classes do not have to implement this method.

Reimplemented from dimeRecordHolder.

bool dimeTableEntry::read dimeInput *const  file  )  [virtual]
 

Reads records from in until the separator groupcode (specified in constructor) is found. Can be overloaded by subclasses, but in most cases this will not be necessary as dimeRecordHolder::handleRecord() is called for each record found in the stream.

See also:
dimeEntity::handleRecord().

Reimplemented from dimeRecordHolder.

Reimplemented in dimeLayerTable.

int dimeTableEntry::typeId  )  const [pure virtual]
 

Must be implemented by all subclasses, and should return an unique id for that class.

Implements dimeBase.

Implemented in dimeLayerTable, dimeUCSTable, and dimeUnknownTable.

bool dimeTableEntry::write dimeOutput *const  out  )  [virtual]
 

Will write the records to file.

Reimplemented from dimeRecordHolder.

Reimplemented in dimeLayerTable, dimeUCSTable, and dimeUnknownTable.


The documentation for this class was generated from the following files:
Copyright © 1998-1999, Systems In Motion <sales@sim.no>. All rights reserved.
System documentation was generated using doxygen.