| http://www.coin3d.org/ http://www.kongsberg.com/kogt/

Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
dimeTableEntry Class Referenceabstract

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

`#include <dime/tables/TableEntry.h>`

Inheritance diagram for dimeTableEntry:

## 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 dimeTableEntry * | copy (dimeModel *const model) const =0
virtual int | typeId () const =0
virtual bool | isOfType (const int thetypeid) const
virtual int | countRecords () const
Public Member Functions inherited from dimeRecordHolder
| dimeRecordHolder (const int separator)
virtual | ~dimeRecordHolder ()
void | setRecord (const int groupcode, const dimeParam &value, dimeMemHandler *const memhandler=NULL)
void | setRecords (const int *const groupcodes, const dimeParam *const params, const int numrecords, dimeMemHandler *const memhandler=NULL)
void | setIndexedRecord (const int groupcode, const dimeParam &value, const int index, dimeMemHandler *const memhandler=NULL)
virtual bool | getRecord (const int groupcode, dimeParam &param, const int index=0) const
dimeRecord * | findRecord (const int groupcode, const int index=0)
int | getNumRecordsInRecordHolder (void) const
dimeRecord * | getRecordInRecordHolder (const int idx) const
Public Member Functions inherited from dimeBase
| dimeBase (void)
virtual | ~dimeBase ()
void * | operator new (size_t size, dimeMemHandler *memhandler=NULL, const int alignment=4)
void | operator delete (void *ptr)

## Static Public Member Functions

static dimeTableEntry * | createTableEntry (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
Protected Member Functions inherited from dimeRecordHolder
bool | copyRecords (dimeRecordHolder *const rh, dimeMemHandler *const memhandler) const
virtual bool | shouldWriteRecord (const int groupcode) const

## Friends

class | dimeUnknownTable
class | dimeLayerTable

## Additional Inherited Members

Public Types inherited from dimeBase

enum

{
dimeBaseType = 1, dimeRecordType, dimeStringRecordType, dimeFloatRecordType,
dimeDoubleRecordType, dimeInt8RecordType, dimeInt16RecordType, dimeInt32RecordType,
dimeHexRecordType, dimeRecordHolderType, dimeClassType, dimeUnknownClassType,
dimeObjectType, dimeUnknownObjectType, dimeEntityType, dimeUnknownEntityType,
dimePolylineType, dimeVertexType, dimeFaceEntityType, dimeExtrusionEntityType,
dime3DFaceType, dimeSolidType, dimeTraceType, dimeLineType,
dimeTextType, dimePointType, dimeBlockType, dimeInsertType,
dimeCircleType, dimeArcType, dimeLWPolylineType, dimeEllipseType,
dimeSplineType, dimeSectionType, dimeUnknownSectionType, dimeEntitiesSectionType,
dimeBlocksSectionType, dimeTablesSectionType, dimeHeaderSectionType, dimeClassesSectionType,
dimeObjectsSectionType, dimeTableType, dimeTableEntryType, dimeUnknownTableType,
dimeUCSTableType, dimeLayerTableType, dimeLastTypeTag
}

Protected Attributes inherited from dimeRecordHolder
dimeRecord ** | records
int | numRecords

## Detailed Description

The dimeTableEntry class is the superclass for all table classes.

## Constructor & Destructor Documentation

## ◆ dimeTableEntry()

dimeTableEntry::dimeTableEntry | ( |  | ) |

Constructor.

## ◆ ~dimeTableEntry()

dimeTableEntry::~dimeTableEntry | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## ◆ copyRecords()

bool dimeTableEntry::copyRecords | ( | dimeTableEntry *const | table,
|  | dimeModel *const | model
| ) |  | const

protected

Copies the unclassified records.

References dimeRecordHolder::copyRecords(), and dimeModel::getMemHandler().

Referenced by dimeLayerTable::dimeLayerTable(), dimeUCSTable::dimeUCSTable(), and dimeUnknownTable::~dimeUnknownTable().

## ◆ countRecords()

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.

References dimeRecordHolder::countRecords().

Referenced by dimeUnknownTable::countRecords(), dimeUCSTable::countRecords(), and dimeLayerTable::countRecords().

## ◆ createTableEntry()

dimeTableEntry * dimeTableEntry::createTableEntry | ( | const char *const | name,
|  | dimeMemHandler *const | memhandler = `NULL`
| ) |  |

static

Static function that creates a table based on its name.

Referenced by dimeTable::read().

## ◆ handleRecord()

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.

Referenced by dimeUCSTable::handleRecord(), and dimeLayerTable::handleRecord().

## ◆ isOfType()

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.

References dimeRecordHolder::isOfType(), dimeRecordHolder::write(), dimeOutput::writeGroupCode(), and dimeOutput::writeString().

## ◆ read()

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.

References dimeRecordHolder::read().

Referenced by dimeTable::read(), and dimeLayerTable::read().

## ◆ typeId()

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.

## ◆ write()

bool dimeTableEntry::write | ( | dimeOutput *const | file | ) |

virtual

Will write the records to file.

Reimplemented from dimeRecordHolder.

Reimplemented in dimeLayerTable, dimeUCSTable, and dimeUnknownTable.

Referenced by dimeUnknownTable::write(), dimeUCSTable::write(), and dimeLayerTable::write().

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

- TableEntry.h
- TableEntry.cpp

Copyright © by Kongsberg Oil & Gas Technologies. All rights reserved.