Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeLayerTable Class Reference

The dimeLayerTable class reads and writes LAYER tables. More...

#include <dime/tables/LayerTable.h>

Inheritance diagram for dimeLayerTable::

dimeTableEntry dimeRecordHolder dimeBase List of all members.

Public Methods

 dimeLayerTable ()
virtual ~dimeLayerTable ()
void setLayerName (const char *name, dimeMemHandler *const memhandler)
const char * getLayerName (void) const
void setColorNumber (const int16 colnum)
int16 getColorNumber (void) const
void registerLayer (dimeModel *model)
virtual dimeTableEntrycopy (dimeModel *const model) const
virtual const char * getTableName () const
virtual bool read (dimeInput *const in)
virtual bool write (dimeOutput *const out)
virtual int typeId () const
virtual int countRecords () const

Protected Methods

virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)

Detailed Description

The dimeLayerTable class reads and writes LAYER tables.


Constructor & Destructor Documentation

dimeLayerTable::dimeLayerTable  
 

Constructor.


Member Function Documentation

int dimeLayerTable::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 dimeTableEntry.

int16 dimeLayerTable::getColorNumber void    const
 

Returns the color number.

const char * dimeLayerTable::getLayerName void    const
 

Returns the layer name.

bool dimeLayerTable::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 \true 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 dimeTableEntry.

bool dimeLayerTable::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 dimeTableEntry.

void dimeLayerTable::registerLayer dimeModel   model
 

Should be called _once_ after you've finished setting up your layer (name and color number). Calling this method more than once for a layer might lead to hard-to-find bugs. After calling this method, the layer information (color number) will be available to entities using this layer.

void dimeLayerTable::setColorNumber const int16    colnum
 

Sets the color number.

void dimeLayerTable::setLayerName const char *    name,
dimeMemHandler *const    memhandler
 

Sets the layer name.

int dimeLayerTable::typeId   const [virtual]
 

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

Reimplemented from dimeTableEntry.

bool dimeLayerTable::write dimeOutput *const    file [virtual]
 

Will write the records to file.

Reimplemented from dimeTableEntry.


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.