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

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dimeRecordHolder Class Reference

The dimeRecordHolder class is a superclass for objects that store records. More...

`#include <dime/RecordHolder.h>`

Inheritance diagram for dimeRecordHolder:

## Public Member Functions

| 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
virtual bool | read (dimeInput *const in)
virtual bool | write (dimeOutput *const out)
virtual bool | isOfType (const int thetypeid) const
virtual int | countRecords () 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 ()
virtual int | typeId () const =0
void * | operator new (size_t size, dimeMemHandler *memhandler=NULL, const int alignment=4)
void | operator delete (void *ptr)

## Protected Member Functions

virtual bool | handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
bool | copyRecords (dimeRecordHolder *const rh, dimeMemHandler *const memhandler) const
virtual bool | shouldWriteRecord (const int groupcode) const

## Protected Attributes

dimeRecord ** | records
int | numRecords

## 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
}

## Detailed Description

The dimeRecordHolder class is a superclass for objects that store records.

This class makes it very easy to add new classes to dime, as it handles all of the reading, error checking and storing of records of no use to the subclass. Subclasses will only need to implement the dimeRecordHolder::handleRecord() and dimeRecordHolder::getRecord() methods.

## Constructor & Destructor Documentation

## ◆ dimeRecordHolder()

dimeRecordHolder::dimeRecordHolder | ( | const int | sep | ) |

Constructor. separator is the group code that will separate objects, to enable the record holder to stop reading the object at the correct time. For instance, entities are separated by group code 0 (a group code 0 signals a new entity is about to start).

## ◆ ~dimeRecordHolder()

dimeRecordHolder::~dimeRecordHolder | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## ◆ copyRecords()

bool dimeRecordHolder::copyRecords | ( | dimeRecordHolder *const | rh,
|  | dimeMemHandler *const | memh
| ) |  | const

protected

Copies the stored records into rh.

References dimeRecord::copy().

Referenced by dimeTableEntry::copyRecords(), dimeObject::copyRecords(), dimeClass::copyRecords(), and dimeEntity::copyRecords().

## ◆ countRecords()

int dimeRecordHolder::countRecords | ( |  | ) | const

virtual

Returns the number of records in the record holder. Should be overloaded by subclasses which should count their records, and then call the parent's method. This method is used to precalculate the number of records to be written. Very useful when progress information is needed during write().

Reimplemented in dimePolyline, dimeSpline, dimeEntity, dimeVertex, dimeBlock, dime3DFace, dimeEllipse, dimeText, dimeFaceEntity, dimeArc, dimeInsert, dimeCircle, dimeClass, dimeObject, dimeLayerTable, dimeUCSTable, dimeLine, dimePoint, dimeSolid, dimeTrace, dimeTableEntry, dimeExtrusionEntity, dimeLWPolyline, dimeUnknownClass, dimeUnknownObject, dimeUnknownEntity, and dimeUnknownTable.

Referenced by dimeTableEntry::countRecords(), dimeObject::countRecords(), dimeClass::countRecords(), and dimeEntity::countRecords().

## ◆ findRecord()

dimeRecord * dimeRecordHolder::findRecord | ( | const int | groupcode,
|  | const int | index = `0`
| ) |  |

Returns the record with group code groupcode. If index > 0, the index'th record with group code groupcode will be returned. Returns NULL if the record is not found or index is out of bounds.

Referenced by setRecords(), and shouldWriteRecord().

## ◆ getNumRecordsInRecordHolder()

int dimeRecordHolder::getNumRecordsInRecordHolder | ( | void |  | ) | const

Returns the number of records stored in this record holder.

## ◆ getRecord()

bool dimeRecordHolder::getRecord | ( | const int | groupcode,
|  | dimeParam & | param,
|  | const int | index = `0`
| ) |  | const

virtual

Will return the value of the record with group code groupcode. false is returned if the record could not be found. Subclasses should overload this method if one or several records are stored in the class. If the groupcode queried is not stored internally, the subclass should call its parent's method.

Reimplemented in dimePolyline, dimeEntity, dimeSpline, dimeBlock, dimeEllipse, dimeText, dimeVertex, dimeCircle, dimeInsert, dime3DFace, dimeArc, dimeSolid, dimeTrace, dimeLine, dimePoint, dimeFaceEntity, dimeLWPolyline, and dimeExtrusionEntity.

References dimeRecord::getValue().

Referenced by dimeEntity::getRecord().

## ◆ getRecordInRecordHolder()

dimeRecord * dimeRecordHolder::getRecordInRecordHolder | ( | const int | idx | ) | const

Returns the idx'th record in the record holder.

See also
  getNumRecordsInRecordHolder().

## ◆ handleRecord()

bool dimeRecordHolder::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 in dimePolyline, dimeEntity, dimeSpline, dimeVertex, dimeText, dimeBlock, dimeClass, dimeInsert, dime3DFace, dimeEllipse, dimeFaceEntity, dimeArc, dimeLWPolyline, dimeCircle, dimeLine, dimePoint, dimeTableEntry, dimeObject, dimeLayerTable, dimeSolid, dimeTrace, dimeUCSTable, and dimeExtrusionEntity.

Referenced by read(), setRecords(), and shouldWriteRecord().

## ◆ isOfType()

bool dimeRecordHolder::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 dimeBase.

Reimplemented in dimeEntity, dimeFaceEntity, dimeClass, dimeObject, dimeTableEntry, and dimeExtrusionEntity.

References dimeBase::isOfType().

Referenced by dimeTableEntry::isOfType(), dimeObject::isOfType(), dimeClass::isOfType(), dimeEntity::isOfType(), and shouldWriteRecord().

## ◆ read()

bool dimeRecordHolder::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 in dimePolyline, dimeEntity, dimeBlock, dimeInsert, dimeClass, dimeObject, dimeLayerTable, and dimeTableEntry.

References dimeArray< T >::count(), dimeRecord::createRecord(), dimeInput::getMemHandler(), handleRecord(), dimeInput::putBackGroupCode(), dimeInput::readGroupCode(), and dimeRecord::readRecordData().

Referenced by dimeTableEntry::read(), dimeObject::read(), dimeClass::read(), and dimeEntity::read().

## ◆ setIndexedRecord()

void dimeRecordHolder::setIndexedRecord | ( | const int | groupcode,
|  | const dimeParam & | value,
|  | const int | index,
|  | dimeMemHandler *const | memhandler = `NULL`
| ) |  |

Basically the same function as setRecord(), but also allows you to specify an index for the record. This is useful if you're going to set several records with the same group code.

See also
  dimeRecordHolder::setRecord()

## ◆ setRecord()

void dimeRecordHolder::setRecord | ( | const int | groupcode,
|  | const dimeParam & | value,
|  | dimeMemHandler *const | memhandler = `NULL`
| ) |  |

Sets the data for the record with group code groupcode. If the record already exists, it's value will simply be overwritten, otherwise a new record will be created. If the record is handled by a subclass, param will be passed on to the subclass (using dimeRecordHolder::handleRecord()), and will be ignored by dimeRecordHolder.

For entities, you cannot use this method to set the layer name. Use dimeEntity::setLayer() to do that. Also, you should not use this function to set the block name for a dimeInsert entity; use dimeInsert::setBlock() instead.

See also
  dimeRecordHolder::handleRecord()
  dimeRecordHolder::getRecord()
  dimeRecordHolder::setRecords()

## ◆ setRecords()

void dimeRecordHolder::setRecords | ( | const int *const | groupcodes,
|  | const dimeParam *const | params,
|  | const int | numrecords,
|  | dimeMemHandler *const | memhandler = `NULL`
| ) |  |

Sets an array of entities. It is much more efficient to use this than using dimeRecordHolder::setRecord() several times if you are going to set the value of more than one record. Otherwise behaves exactly as dimeRecordHolder::setRecord().

References dimeArray< T >::count(), dimeRecord::createRecord(), findRecord(), handleRecord(), dimeRecord::setValue(), and dimeBase::typeId().

## ◆ shouldWriteRecord()

bool dimeRecordHolder::shouldWriteRecord | ( | const int | groupcode | ) | const

protected virtual

Can be overloaded by subclasses that want the record holder to store a record, but handles writing themselves. Default method returns true for all group codes.

Reimplemented in dimeEntity.

References dimeRecord::createRecord(), findRecord(), handleRecord(), isOfType(), dimeRecord::setValue(), and dimeBase::typeId().

Referenced by write().

## ◆ write()

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

virtual

Will write the records to file.

Reimplemented in dimePolyline, dimeSpline, dimeEntity, dimeVertex, dimeBlock, dime3DFace, dimeEllipse, dimeText, dimeArc, dimeInsert, dimeCircle, dimeClass, dimeObject, dimeLayerTable, dimeUCSTable, dimeLine, dimePoint, dimeTableEntry, dimeLWPolyline, dimeUnknownClass, dimeSolid, dimeTrace, dimeUnknownObject, dimeUnknownEntity, and dimeUnknownTable.

References shouldWriteRecord().

Referenced by dimeTableEntry::isOfType(), dimeObject::write(), dimeClass::write(), and dimeEntity::write().

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

- RecordHolder.h
- RecordHolder.cpp

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