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

Public Member Functions | Protected Member Functions | List of all members
dimeUCSTable Class Reference

The dimeUCSTable class reads and writes UCS tables. More...

`#include <dime/tables/UCSTable.h>`

Inheritance diagram for dimeUCSTable:

## Public Member Functions

| dimeUCSTable ()
virtual dimeTableEntry * | copy (dimeModel *const model) const
virtual const char * | getTableName () const
const dimeVec3f & | getOrigin () const
const dimeVec3f & | getXaxis () const
const dimeVec3f & | getYaxis () const
void | setOrigin (const dimeVec3f &v)
void | setXaxis (const dimeVec3f &v)
void | setYaxis (const dimeVec3f &v)
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 | read (dimeInput *const in)
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 groupcodes, 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 dimeUCSTable class reads and writes UCS tables.

## Constructor & Destructor Documentation

## ◆ dimeUCSTable()

dimeUCSTable::dimeUCSTable | ( |  | ) |

Constructor.

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

## Member Function Documentation

## ◆ countRecords()

int dimeUCSTable::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().

## ◆ handleRecord()

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

References dimeTableEntry::handleRecord().

## ◆ typeId()

int dimeUCSTable::typeId | ( |  | ) | const

virtual

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

Implements dimeTableEntry.

## ◆ write()

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

virtual

Will write the records to file.

Reimplemented from dimeTableEntry.

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

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

- UCSTable.h
- UCSTable.cpp

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