Main Page | Class Hierarchy | Compound List | File List | Compound Members

dimeClass Class Reference

The dimeClass class is the superclass for all the class classes. More...

#include <dime/classes/Class.h>

Inheritance diagram for dimeClass:

dimeRecordHolder dimeBase dimeUnknownClass List of all members.

Public Member Functions

 dimeClass ()
virtual ~dimeClass ()
virtual const char * getDxfClassName () const=0
virtual dimeClasscopy (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 countRecords () const
const char * getClassName () const
const char * getApplicationName () const
int32 getVersionNumber () const
int8 getFlag280 () const
int8 getFlag281 () const
void setClassName (const char *const classname, dimeMemHandler *const memhandler=NULL)
void setApplicationName (const char *const appname, dimeMemHandler *const memhandler=NULL)
void setVersionNumber (const int32 v)
void setFlag280 (const int8 flag)
void setFlag281 (const int8 flag)

Static Public Member Functions

dimeClasscreateClass (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 (dimeClass *const newclass, dimeModel *const model) const

Friends

class dimeClassesSection
class dimeModel

Detailed Description

The dimeClass class is the superclass for all the class classes.


Constructor & Destructor Documentation

dimeClass::dimeClass  ) 
 

Constructor.

dimeClass::~dimeClass  )  [virtual]
 

Destructor.


Member Function Documentation

dimeClass * dimeClass::copy dimeModel *const  model  )  const [pure virtual]
 

Must be implemented by subclasses to return a copy of the class.

Implemented in dimeUnknownClass.

bool dimeClass::copyRecords dimeClass *const  myclass,
dimeModel *const  model
const [protected]
 

Copies the common and unclassified records.

int dimeClass::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 dimeUnknownClass.

dimeClass * dimeClass::createClass const char *const  name,
dimeMemHandler *const  memhandler = NULL
[static]
 

Static function which creates an class based on its name.

const char * dimeClass::getApplicationName  )  const [inline]
 

Returns the class application name.

const char * dimeClass::getClassName  )  const [inline]
 

Returns the C++ class name.

const char * dimeClass::getDxfClassName  )  const [pure virtual]
 

Must be implemented by subclasses to return the dxf name of the class.

Implemented in dimeUnknownClass.

int8 dimeClass::getFlag280  )  const [inline]
 

Returns the flag with group code 280.

int8 dimeClass::getFlag281  )  const [inline]
 

Returns the flag with group code 281.

int32 dimeClass::getVersionNumber  )  const [inline]
 

Returns the version number of this class.

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

bool dimeClass::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 dimeClass::read dimeInput *const  file  )  [virtual]
 

Reads a class from in. Can be overloaded by subclasses, but in most cases this will not be necessary.

See also:
dimeClass::handleRecord().

Reimplemented from dimeRecordHolder.

void dimeClass::setApplicationName const char *const  appname,
dimeMemHandler *const  memhandler = NULL
 

Sets the application name for this class.

void dimeClass::setClassName const char *const  classname,
dimeMemHandler *const  memhandler = NULL
 

Sets the C++ class name for this class.

void dimeClass::setFlag280 const int8  flag  )  [inline]
 

Sets the flag for the flag with group code 280.

void dimeClass::setFlag281 const int8  flag  )  [inline]
 

Sets the group code for the flag with group code 281.

void dimeClass::setVersionNumber const int32  v  )  [inline]
 

Sets the version number for this class.

bool dimeClass::write dimeOutput *const  file  )  [virtual]
 

Writes common and unknown class records to file.

Reimplemented from dimeRecordHolder.

Reimplemented in dimeUnknownClass.


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.