dimeTable Class Reference

The dimeTable class stores table entries. More...

#include <dime/tables/Table.h>

Inheritance diagram for dimeTable:

dimeBase List of all members.

Public Member Functions

 dimeTable (dimeMemHandler *const memhandler)
virtual ~dimeTable ()
bool read (dimeInput *const in)
bool write (dimeOutput *const out)
dimeTablecopy (dimeModel *const model) const
int typeId () const
int countRecords () const
int tableType () const
void setTableName (const char *name)
const char * tableName () const
int getNumTableEntries () const
dimeTableEntrygetTableEntry (const int idx)
void insertTableEntry (dimeTableEntry *const tableEntry, const int idx=-1)
void removeTableEntry (const int idx)
int getNumTableRecords () const
dimeRecordgetTableRecord (const int idx)
void insertTableRecord (dimeRecord *const record, const int idx=-1)
void removeTableRecord (const int idx)

Detailed Description

The dimeTable class stores table entries.

This class will not be allocated by the memory handler, but it will store a pointer to the memory handler, and it will be used to allocate table entries and records.


Constructor & Destructor Documentation

dimeTable::dimeTable dimeMemHandler *const   memhandler  ) 
 

Constructor.

dimeTable::~dimeTable  )  [virtual]
 

Destructor.


Member Function Documentation

int dimeTable::countRecords  )  const
 

Counts the number of records in this table.

int dimeTable::getNumTableEntries  )  const
 

Returns the number of table enties in this table.

int dimeTable::getNumTableRecords  )  const
 

Returns the number of table records in this table. Table records precedes the table entries, and contain som information about this table. The max. entries record (group code 70), is handled automatically by this class, and should not be set by the user.

dimeTableEntry * dimeTable::getTableEntry const int  idx  ) 
 

Returns the table entry at index idx.

dimeRecord * dimeTable::getTableRecord const int  idx  ) 
 

Returns the table record at index idx.

void dimeTable::insertTableEntry dimeTableEntry *const   tableEntry,
const int  idx = -1
 

Inserts a new table entry at index idx. If idx is negative, the table entry will be inserted at the end of the list of tableEntries.

void dimeTable::insertTableRecord dimeRecord *const   record,
const int  idx = -1
 

Inserts a new record at index idx. If idx is negative, the record will be inserted at the end of the list of records.

bool dimeTable::read dimeInput *const   file  ) 
 

Reads a table.

void dimeTable::removeTableEntry const int  idx  ) 
 

Removes (and deletes if no memhandler is used) the table entry at index idx.

void dimeTable::removeTableRecord const int  idx  ) 
 

Removes (and deletes if no memhandler is used) the record at index idx.

int dimeTable::typeId  )  const [virtual]
 

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

Implements dimeBase.

bool dimeTable::write dimeOutput *const   file  ) 
 

Writes the table to file.


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.