class DfcCharKeyword : public DfcScalarKeyword<unsigned char> | | 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 ) |
| | getAsString ( int whichElement = 0 ) |
| | getType (void) |
| | loadMidasData ( int fileId, const RWString &keywordName ) |
| | operator= (const DfcKeywordInterface &other) |
| | operator= (const DfcCharKeyword &other) |
| | saveAsMidas (int fileId) |
| | ~DfcCharKeyword (void) |
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.
Exceptions Arguments
Exceptions Arguments
Returns Exceptions
Returns Exceptions
Returns Exceptions
DfcCharKeyword( const DfcKeywordInterface &other )
copy constructor.
DfcCharKeyword( const DfcCharKeyword &other )
copy constructor.
DfcCharKeyword( const RWString &newName, const RWString &alias, const RWString &description, int numElements = 1 )
Create a new Keyword capable of storing the specified amount of data
DfcCharKeyword* clone(void)
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.)
A pointer to the copy of this object. The responsibility for the memory management of this copy now lies with the method invoker.
DfcCharKeyword( const RWString &newName, int numElements = 1 )
DfcCharKeyword& operator=(const DfcKeywordInterface &other)
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.
Reference to this object to allow chaining of assignment operators.
DfcCharKeyword& operator=(const DfcCharKeyword &other)
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.
Reference to this object to allow chaining of assignment operators.
DfcKeywordInterface::TYPE getType(void)
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)
Save the keyword data in MIDAS format
void loadMidasData( int fileId, const RWString &keywordName )
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).
this page has been generated automatically by doc++
(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de