class DfcCharKeyword : public DfcScalarKeyword<unsigned char>


Inheritance:


Public Methods

DfcCharKeyword* clone (void)
DfcCharKeyword ( const DfcKeywordInterface &other )
DfcCharKeyword ( const DfcCharKeyword &other )
DfcCharKeyword ( const RWString &newName, const RWString &alias, const RWString &description, int numElements = 1 )
DfcCharKeyword ( const RWString &newName, int numElements = 1 )
virtual RWString getAsString ( int whichElement = 0 )
DfcKeywordInterface::TYPE getType (void)
void loadMidasData ( int fileId, const RWString &keywordName )
DfcCharKeyword& operator= (const DfcKeywordInterface &other)
DfcCharKeyword& operator= (const DfcCharKeyword &other)
void saveAsMidas (int fileId)
virtual ~DfcCharKeyword (void)

Public


Purpose
Perform a shallow copy of the Keyword

Purpose
Used for loading the actual data (not header information like name, helpText etc) in from a midas file

Purpose
copy constructor

Purpose
copy constructor

Purpose
Create a new Keyword capable of storing the specified amount of data

Purpose
Make a copy of this object

VLT On-line Data Flow, Subsystem: df-core
$Id: DfcCharKeyword

Purpose
Perform a shallow copy of the Keyword

{/large Purpose}
An indication of the type of the Keyword

Purpose
Save the keyword data in MIDAS format

Documentation

VLT On-line Data Flow, Subsystem: df-core
$Id: DfcCharKeyword.h,v 1.1 1997/05/15 07:45:30 dataflow Exp $

DESCRIPTION
Only required in order to get the type of the class. It may seem wasteful in terms of space, however the ScalarKeyword class generates templates for every possible instantiation anyway so we are only making this process explicit. Unfortunately we have to supply all the standard constructors and operators as well which is tedious. The alternative is to supply a collection of template matching functions that determine the type. However this may not work if we port to a platform where not all the types are supported.

DfcCharKeyword( const DfcKeywordInterface &other )

Purpose
copy constructor.

Exceptions

  • DfcMemoryException - for some bizarre reason, there isn't enough memory to create a copy of the Keyword.

Arguments

DfcCharKeyword( const DfcCharKeyword &other )

Purpose
copy constructor.

Exceptions

  • DfcMemoryException - for some bizarre reason, there isn't enough memory to create a copy of the Keyword.

Arguments

DfcCharKeyword( const RWString &newName, const RWString &alias, const RWString &description, int numElements = 1 )

Purpose
Create a new Keyword capable of storing the specified amount of data

DfcCharKeyword* clone(void)

Purpose
Make a copy of this object. Altering the copy will not affect this object in any way. (technical - we make a deep copy of this object.)

Returns
A pointer to the copy of this object. The responsibility for the memory management of this copy now lies with the method invoker.

Exceptions

  • DfcMemoryExc - there was not enough memory on the local machine to perform the copy succesfully.
  • DfcAlreadyOpenExc - the original is opened for update. There can only be one copy of a Keyword open for update at any one time, therefore the clone() operation has to fail.

DfcCharKeyword( const RWString &newName, int numElements = 1 )

DfcCharKeyword& operator=(const DfcKeywordInterface &other)

Purpose
Perform a shallow copy of the Keyword. All data will be shared between the original and the new version as the copying is a shallow copy only.

Returns
Reference to this object to allow chaining of assignment operators.

Exceptions

  • DfcMemoryExc - there was not enough memory on the local machine to perform the copy succesfully.
  • DfcAlreadyOpenExc - the original is opened for update. There can only be one copy of a Keyword open for update at any one time, therefore the clone() operation has to fail.

DfcCharKeyword& operator=(const DfcCharKeyword &other)

Purpose
Perform a shallow copy of the Keyword. All data will be shared between the original and the new version as the copying is a shallow copy only.

Returns
Reference to this object to allow chaining of assignment operators.

Exceptions

  • DfcMemoryExc - there was not enough memory on the local machine to perform the copy succesfully.
  • DfcAlreadyOpenExc - the original is opened for update. There can only be one copy of a Keyword open for update at any one time, therefore the clone() operation has to fail.

DfcKeywordInterface::TYPE getType(void)

{/large Purpose}
An indication of the type of the Keyword. This is used while the standard C++ RTTI mechanisms are still in their infancy and may, or may not, become redundant later. The primary purpose of the type field is to allow persistency, not so that users can query it and perform switch statements on the type. Because of this it may be hidden from the public interface later.

virtual RWString getAsString( int whichElement = 0 )

void saveAsMidas(int fileId)

Purpose
Save the keyword data in MIDAS format

void loadMidasData( int fileId, const RWString &keywordName )

Purpose
Used for loading the actual data (not header information like name, helpText etc) in from a midas file. Partitioned this way for code readability ratehr than efficiency or necessity (it may go later because it's too inefficient).

virtual ~DfcCharKeyword(void)


This class has no child classes.

alphabetic index hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de