Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeObject Class Reference

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

#include <dime/objects/Object.h>

Inheritance diagram for dimeObject::

dimeRecordHolder dimeBase dimeUnknownObject List of all members.

Public Methods

 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

Static Public Methods

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

Protected Methods

virtual bool handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
bool copyRecords (dimeObject *const newobject, dimeModel *const model) const

Friends

class dimeObjectesSection
class dimeModel

Detailed Description

The dimeObject class is the superclass for the object classes.


Constructor & Destructor Documentation

dimeObject::dimeObject  
 

Constructor.

dimeObject::~dimeObject   [virtual]
 

Destructor.


Member Function Documentation

bool dimeObject::copyRecords dimeObject *const    myobject,
dimeModel *const    model
const [protected]
 

Copies the common and unobjectified records.

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.

dimeObject * dimeObject::createObject const char *const    name,
dimeMemHandler *const    memhandler = NULL
[static]
 

Static function which creates an object based on its name.

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 \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 dimeRecordHolder.

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.

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.

int dimeObject::typeId   const [pure virtual]
 

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

Reimplemented from dimeBase.

Reimplemented in dimeUnknownObject.

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

Writes common and unknown object records to file.

Reimplemented from dimeRecordHolder.

Reimplemented in dimeUnknownObject.


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.