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

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

The dimeObject class is the superclass for the object classes. More...

`#include <dime/objects/Object.h>`

Inheritance diagram for dimeObject:

## Public Member Functions

| dimeObject ()
virtual | ~dimeObject ()
virtual const char * | getObjectName () const =0
virtual dimeObject * | copy (dimeModel *const model) const =0
virtual bool | read (dimeInput *const in)
virtual bool | write (dimeOutput *const out)
virtual bool | isOfType (const int thetypeid) const
virtual int | typeId () const =0
virtual int | countRecords () const
virtual void | print () 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 dimeObject * | createObject (const char *const name, dimeMemHandler *const memhandler=NULL)

## Protected Member Functions

virtual bool | handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
bool | copyRecords (dimeObject *const newobject, 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 | dimeObjectesSection
class | dimeModel

## 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 dimeObject class is the superclass for the object classes.

## Constructor & Destructor Documentation

## ◆ dimeObject()

dimeObject::dimeObject | ( |  | ) |

Constructor.

## ◆ ~dimeObject()

dimeObject::~dimeObject | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## ◆ copyRecords()

bool dimeObject::copyRecords | ( | dimeObject *const | myobject,
|  | dimeModel *const | model
| ) |  | const

protected

Copies the common and unobjectified records.

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

Referenced by dimeUnknownObject::~dimeUnknownObject().

## ◆ countRecords()

int dimeObject::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 from dimeRecordHolder.

Reimplemented in dimeUnknownObject.

References dimeRecordHolder::countRecords().

Referenced by dimeUnknownObject::countRecords().

## ◆ createObject()

dimeObject * dimeObject::createObject | ( | const char *const | name,
|  | dimeMemHandler *const | memhandler = `NULL`
| ) |  |

static

Static function which creates an object based on its name.

Referenced by dimeObjectsSection::~dimeObjectsSection().

## ◆ handleRecord()

bool dimeObject::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.

## ◆ isOfType()

bool dimeObject::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().

## ◆ read()

bool dimeObject::read | ( | dimeInput *const | file | ) |

virtual

Reads an object from in. Can be overloaded by subobjects, but in most cases this will not be necessary.

See also
  dimeObject::handleRecord().

Reimplemented from dimeRecordHolder.

References dimeRecordHolder::read().

Referenced by dimeObjectsSection::~dimeObjectsSection().

## ◆ typeId()

int dimeObject::typeId | ( |  | ) | const

pure virtual

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

Implements dimeBase.

Implemented in dimeUnknownObject.

## ◆ write()

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

virtual

Writes common and unknown object records to file.

Reimplemented from dimeRecordHolder.

Reimplemented in dimeUnknownObject.

References dimeRecordHolder::write().

Referenced by dimeUnknownObject::write().

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

- Object.h
- Object.cpp

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