Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
dimeRecord Class Referenceabstract

The dimeRecord class is the superclass of all record classes. More...

#include <dime/records/Record.h>

Inheritance diagram for dimeRecord:
dimeBase dimeDoubleRecord dimeFloatRecord dimeInt16Record dimeInt32Record dimeInt8Record dimeStringRecord dimeHexRecord

Public Member Functions

 dimeRecord (const int group_code)
 
virtual ~dimeRecord ()
 
virtual void setValue (const dimeParam &param, dimeMemHandler *const memhandler=NULL)=0
 
virtual void getValue (dimeParam &param) const =0
 
virtual dimeRecordcopy (dimeMemHandler *const memhandler) const =0
 
void setGroupCode (const int group_code)
 
int getGroupCode () const
 
virtual bool isEndOfSectionRecord () const
 
virtual bool isEndOfFileRecord () const
 
virtual int typeId () const =0
 
virtual bool read (dimeInput *const in)=0
 
virtual bool write (dimeOutput *const out)
 
virtual void print () const
 
- Public Member Functions inherited from dimeBase
 dimeBase (void)
 
virtual ~dimeBase ()
 
virtual bool isOfType (const int thetypeid) const
 
void * operator new (size_t size, dimeMemHandler *memhandler=NULL, const int alignment=4)
 
void operator delete (void *ptr)
 

Static Public Member Functions

static bool readRecordData (dimeInput *const in, const int group_code, dimeParam &param)
 
static dimeRecordreadRecord (dimeInput *const in)
 
static dimeRecordcreateRecord (const int group_code, dimeMemHandler *const memhandler)
 
static dimeRecordcreateRecord (const int group_code, const dimeParam &param, dimeMemHandler *const memhandler)
 
static int getRecordType (const int group_code)
 

Protected Attributes

int groupCode
 

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
}
 

Detailed Description

The dimeRecord class is the superclass of all record classes.

Constructor & Destructor Documentation

dimeRecord::dimeRecord ( const int  group_code)

Constructor which sets the group code.

dimeRecord::~dimeRecord ( )
virtual

Destructor.

Member Function Documentation

dimeRecord * dimeRecord::copy ( dimeMemHandler *const  memhandler) const
pure virtual
dimeRecord * dimeRecord::createRecord ( const int  group_code,
dimeMemHandler *const  memhandler 
)
static

Static function that creates a record based on the group code. if memhandler != NULL, it will be used to allocate the other, otherwise the default memory handler will be used.

References getRecordType().

Referenced by dimeTable::read(), dimeModel::read(), dimeRecordHolder::read(), readRecord(), dimeRecordHolder::setRecords(), and dimeHeaderSection::setVariable().

int dimeRecord::getGroupCode ( ) const

Returns the group code for this record.

Referenced by dimeTable::insertTableRecord().

int dimeRecord::getRecordType ( const int  group_code)
static

Static function that returns the record type based on the group code.

Referenced by createRecord(), and readRecordData().

void dimeRecord::getValue ( dimeParam param) const
pure virtual

Returns the value of this record.

Implemented in dimeStringRecord, dimeDoubleRecord, dimeFloatRecord, dimeInt16Record, dimeInt32Record, and dimeInt8Record.

Referenced by dimeRecordHolder::getRecord().

bool dimeRecord::isEndOfFileRecord ( ) const
virtual

Returns true if this records is an end of file record.

Reimplemented in dimeStringRecord.

bool dimeRecord::isEndOfSectionRecord ( ) const
virtual

Returns true if this record is an end of section record.

Reimplemented in dimeStringRecord.

dimeRecord::print ( ) const
inlinevirtual

Prints information about this record to stderr.

bool dimeRecord::read ( dimeInput *const  in)
pure virtual

This function will read the record from the dimeInput file.

Implemented in dimeStringRecord, dimeDoubleRecord, dimeFloatRecord, dimeInt16Record, dimeInt32Record, and dimeInt8Record.

Referenced by dimeTable::read(), and readRecord().

dimeRecord * dimeRecord::readRecord ( dimeInput *const  in)
static

Reads and returns the next record int file in.

References createRecord(), dimeInput::getMemHandler(), read(), and dimeInput::readGroupCode().

bool dimeRecord::readRecordData ( dimeInput *const  in,
const int  group_code,
dimeParam param 
)
static
void dimeRecord::setGroupCode ( const int  group_code)

Sets the group code of this record.

void dimeRecord::setValue ( const dimeParam param,
dimeMemHandler *const  memhandler = NULL 
)
pure virtual

Sets the value of this record. The memory handler is needed by dimeStringRecord.

Implemented in dimeStringRecord, dimeDoubleRecord, dimeFloatRecord, dimeInt16Record, dimeInt32Record, and dimeInt8Record.

Referenced by dimeRecordHolder::setRecords().

int dimeRecord::typeId ( ) const
pure virtual

This virtual function will return the type of the record.

Implements dimeBase.

Implemented in dimeStringRecord, dimeDoubleRecord, dimeFloatRecord, dimeInt16Record, dimeInt32Record, dimeInt8Record, and dimeHexRecord.


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