Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeRecord Class Reference

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 List of all members.

Public Methods

 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 dimeRecord * copy (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

Static Public Methods

bool readRecordData (dimeInput *const in, const int group_code, dimeParam &param)
dimeRecord * readRecord (dimeInput *const in)
dimeRecord * createRecord (const int group_code, dimeMemHandler *const memhandler)
dimeRecord * createRecord (const int group_code, const dimeParam &param, dimeMemHandler *const memhandler)
int getRecordType (const int group_code)

Protected Attributes

int groupCode

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    mh const [pure virtual]
 

Returns a copy of this record.

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

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.

int dimeRecord::getGroupCode   const
 

Returns the group code for this record.

int dimeRecord::getRecordType const int    group_code [static]
 

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

void dimeRecord::getValue dimeParam   param const [pure virtual]
 

Returns the value of this record.

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

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 [inline, virtual]
 

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.

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

dimeRecord * dimeRecord::readRecord dimeInput *const    in [static]
 

Reads and returns the next record int file in.

bool dimeRecord::readRecordData dimeInput *const    in,
const int    group_code,
dimeParam   param
[static]
 

Will read the next item from in, and store result in param, based on the group_code.

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.

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

int dimeRecord::typeId   const [pure virtual]
 

This virtual function will return the type of the record.

Reimplemented from dimeBase.

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

bool dimeRecord::write dimeOutput *const    out [virtual]
 

This function will write the record to the dimeOutput file.

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


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.