dimeLayerTable Class Reference

The dimeLayerTable class reads and writes LAYER tables. More...

#include <dime/tables/LayerTable.h>

Inheritance diagram for dimeLayerTable:

Public Member Functions
	dimeLayerTable ()
void	setLayerName (const char *name, dimeMemHandler *const memhandler)
const char *	getLayerName (void) const
void	setColorNumber (const int16 colnum)
int16	getColorNumber (void) const
void	registerLayer (dimeModel *model)
virtual dimeTableEntry *	copy (dimeModel *const model) const
virtual const char *	getTableName () const
virtual bool	read (dimeInput *const in)
virtual bool	write (dimeOutput *const out)
virtual int	typeId () const
virtual int	countRecords () const
Public Member Functions inherited from dimeTableEntry
	dimeTableEntry ()
virtual	~dimeTableEntry ()
virtual bool	isOfType (const int thetypeid) 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)

Protected Member Functions
virtual bool	handleRecord (const int groupcode, const dimeParam &param, dimeMemHandler *const memhandler)
Protected Member Functions inherited from dimeTableEntry
bool	preWrite (dimeOutput *const output)
bool	copyRecords (dimeTableEntry *const table, 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

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 }
Static Public Member Functions inherited from dimeTableEntry
static dimeTableEntry *	createTableEntry (const char *const name, dimeMemHandler *const memhandler=NULL)
Protected Attributes inherited from dimeRecordHolder
dimeRecord **	records
int	numRecords

Detailed Description

The dimeLayerTable class reads and writes LAYER tables.

Constructor & Destructor Documentation

dimeLayerTable()

dimeLayerTable::dimeLayerTable

(

)

Constructor.

Member Function Documentation

copy()

dimeTableEntry * dimeLayerTable::copy ( dimeModel *const model ) const

virtual

Implements dimeTableEntry.

countRecords()

int dimeLayerTable::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 dimeTableEntry.

References dimeTableEntry::countRecords().

getColorNumber()

int16 dimeLayerTable::getColorNumber

(

void

)

const

Returns the color number.

getLayerName()

const char * dimeLayerTable::getLayerName

(

void

)

const

Returns the layer name.

getTableName()

const char * dimeLayerTable::getTableName ( ) const

virtual

Implements dimeTableEntry.

handleRecord()

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

protectedvirtual

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 dimeTableEntry.

References dimeTableEntry::handleRecord(), setColorNumber(), and setLayerName().

read()

bool dimeLayerTable::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 from dimeTableEntry.

References dimeInput::getModel(), dimeTableEntry::read(), and registerLayer().

registerLayer()

void dimeLayerTable::registerLayer

(

dimeModel *

model

)

Should be called once after you've finished setting up your layer (name and color number). Calling this method more than once for a layer might lead to hard-to-find bugs. After calling this method, the layer information (color number) will be available to entities using this layer.

References dimeModel::addLayer().

Referenced by read().

setColorNumber()

void dimeLayerTable::setColorNumber

(

const int16

colnum

)

Sets the color number.

Referenced by handleRecord().

setLayerName()

void dimeLayerTable::setLayerName	(	const char *	name,
		dimeMemHandler *const	memhandler )

Sets the layer name.

Referenced by handleRecord().

typeId()

int dimeLayerTable::typeId ( ) const

virtual

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

Implements dimeTableEntry.

write()

bool dimeLayerTable::write ( dimeOutput *const file )

virtual

Will write the records to file.

Reimplemented from dimeTableEntry.

References dimeTableEntry::write(), dimeOutput::writeGroupCode(), dimeOutput::writeInt16(), and dimeOutput::writeString().

---

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

• LayerTable.h
• LayerTable.cpp