dimeTableEntry Class Reference

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

Static Public Member Functions
static dimeTableEntry *	createTableEntry (const char *const name, dimeMemHandler *const memhandler=NULL)

Protected Member Functions
bool	copyRecords (dimeTableEntry *const table, dimeModel *const model) const
virtual bool	handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
bool	preWrite (dimeOutput *const output)
Protected Member Functions inherited from dimeRecordHolder
bool	copyRecords (dimeRecordHolder *const rh, dimeMemHandler *const memhandler) const
virtual bool	shouldWriteRecord (const int groupcode) const

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
int	numRecords
dimeRecord **	records

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.

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.

createTableEntry()

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

static

Static function that creates a table based on its name.

handleRecord()

bool dimeTableEntry::handleRecord ( const int groupcode, const dimeParam & param, dimeMemHandler *const memhandler )

protectedvirtual

Must be overloaded by entities that directly support 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.

Reimplemented in dimeLayerTable, and dimeUCSTable.

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.

read()

bool dimeTableEntry::read ( dimeInput *const file )

virtual

Reads records from in until the separator group code (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.

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.

---

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

• TableEntry.h
• TableEntry.cpp