class rcEventData

Class to handle the event data for the class rcEvent

Public Methods

inline const char* getCharArrayElement( int iElement )
Returns the integer at the location iLocation in the string array
inline int getCharArrayLength()
Returns the length of the string array
inline int getIntArrayElement( int iLocation )
Returns the integer at the location iLocation in the integer array
inline int getIntArrayLength()
Returns the length of the integer array
inline int getInteger()
Returns the integer value
inline const char* getString()
Returns the string that is contained in the rcEventData
void identify( ostream &os = cout )
Prints information about the data to ostream os
inline bool isCharArrayValid()
Returns true if rcEventData has a valid array of strings value
inline bool isIntArrayValid()
Returns true if rcEventData has a valid array of integers value
inline bool isIntValid()
Returns true if rcEventData has a valid integer value
inline bool isStringValid()
Returns true if rcEventData has a valid string value
rcEventData( int i, int *pIntArray, int nbInt, const char *pcString )
Constructor where we define all allowed data types
rcEventData( int i )
Constructor if the event data has one integer
rcEventData( char **pcArray, int iSize )
Constructor for an array of strings
rcEventData()
Constructor if the event data has no data!
rcEventData( const char *pcString )
Constructor if the event data is a string
rcEventData( int *pIntArray, int nbInt )
Constructor if the event data is an array of integers

Documentation

Class to handle the event data for the class rcEvent. It can handle an integer, an array of integers or a string. For other data structures a subtype can be defined. Currently there are no such subtypes defined. If they are ever needed, then one should not forget to make the destructor and the identify members virtual.

See also: rcEvent, rcEventQueue

First version: Feb 7, 2000, CW

Last update: Feb 7, 2000, CW

rcEventData()
Constructor if the event data has no data!

rcEventData( int i )
Constructor if the event data has one integer

rcEventData( int *pIntArray, int nbInt )
Constructor if the event data is an array of integers

rcEventData( const char *pcString )
Constructor if the event data is a string

rcEventData( int i, int *pIntArray, int nbInt, const char *pcString )
Constructor where we define all allowed data types

rcEventData( char **pcArray, int iSize )
Constructor for an array of strings

inline bool isIntValid()
Returns true if rcEventData has a valid integer value

inline int getInteger()
Returns the integer value

inline bool isIntArrayValid()
Returns true if rcEventData has a valid array of integers value

inline int getIntArrayLength()
Returns the length of the integer array

inline int getIntArrayElement( int iLocation )
Returns the integer at the location iLocation in the integer array

inline bool isStringValid()
Returns true if rcEventData has a valid string value

inline const char* getString()
Returns the string that is contained in the rcEventData

inline bool isCharArrayValid()
Returns true if rcEventData has a valid array of strings value

inline int getCharArrayLength()
Returns the length of the string array

inline const char* getCharArrayElement( int iElement )
Returns the integer at the location iLocation in the string array

void identify( ostream &os = cout )
Prints information about the data to ostream os


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