Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dimeStringRecord Class Reference

The dimeStringRecord class is a container class for string records. More...

#include <dime/records/StringRecord.h>

Inheritance diagram for dimeStringRecord::

dimeRecord dimeBase dimeHexRecord List of all members.

Public Methods

 dimeStringRecord (const int group_code=0)
virtual ~dimeStringRecord ()
virtual dimeRecordcopy (dimeMemHandler *const mh) const
virtual void setValue (const dimeParam &param, dimeMemHandler *const memhandler=NULL)
virtual void getValue (dimeParam &param) const
void setStringPointer (char *const s)
bool setString (const char *const s, dimeMemHandler *const memhandler=NULL)
char * getString ()
bool isEndOfSectionRecord () const
bool isEndOfFileRecord () const
int typeId () const
bool read (dimeInput *const in)
bool write (dimeOutput *const out)

Protected Attributes

char * string

Detailed Description

The dimeStringRecord class is a container class for string records.


Constructor & Destructor Documentation

dimeStringRecord::dimeStringRecord const int    group_code = 0
 

Constructor.

dimeStringRecord::~dimeStringRecord   [virtual]
 

Destructor.


Member Function Documentation

dimeRecord * dimeStringRecord::copy dimeMemHandler *const    mh const [virtual]
 

Returns a copy of this record.

Reimplemented from dimeRecord.

char * dimeStringRecord::getString  
 

Returns a pointer to the string.

void dimeStringRecord::getValue dimeParam   param const [virtual]
 

Returns the value of this record.

Reimplemented from dimeRecord.

bool dimeStringRecord::isEndOfFileRecord   const [virtual]
 

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

Reimplemented from dimeRecord.

bool dimeStringRecord::isEndOfSectionRecord   const [virtual]
 

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

Reimplemented from dimeRecord.

bool dimeStringRecord::read dimeInput *const    in [virtual]
 

This function will read the record from the dimeInput file.

Reimplemented from dimeRecord.

bool dimeStringRecord::setString const char *const    s,
dimeMemHandler *const    memhandler = NULL
 

Will store a copy of string s. If memhandler != NULL, it will be used to allocate the needed memory. If memhandler == NULL, the memory will be allocated from the heap.

void dimeStringRecord::setStringPointer char *const    s
 

Sets the objects string pointer to point to 's'. Be aware that if the destructor is called for this object, the object will attempt to delete the string.

See also:
dimeStringRecord::setString().

void dimeStringRecord::setValue const dimeParam   param,
dimeMemHandler *const    memhandler = NULL
[virtual]
 

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

Reimplemented from dimeRecord.

int dimeStringRecord::typeId   const [virtual]
 

This virtual function will return the type of the record.

Reimplemented from dimeRecord.

Reimplemented in dimeHexRecord.

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

This function will write the record to the dimeOutput file.

Reimplemented from dimeRecord.


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.