rcPartitionConfiguration

class rcPartitionConfiguration

Configuration object for the partition

Public Methods
inline bool areTimersDisabled(): Returns true if the timers are disabled
inline bool getAutoRunMode(): Returns true if we are in autorun mode
inline pstring getGl1Configuration(): Returns the current configuration of the GL1
inline int getTimeout(): Returns the current value of the timeout
rcPartitionConfiguration(): Constructor which sets the default values
inline void setAutoRunMode( bool bMode ): To enable/disable the auto run mode
inline void setMusic( bool bOnOff ): To enable/disable the music at SOR/EOR
inline void setTimeout( int iMillisec ): Sets the timeout
inline void setTimerDisable( bool bDisable ): If true the timers are disabled

Private Fields
bool bAutoRunMode: True if we are currently taking data in autorun mode
bool bDisableTimers: True if we download without using timers to detect timeouts
bool bMusic: If true we play some music at SOR/EOR
int iTimeoutMsec: Number of milliseconds after which the partition times out at initialisation/download/start/stop sequence
pstring psGl1Configuration: Name of the loaded GL1 configuration

Private Methods
static pstring getGl1ConfigFile(): Returns the string with the Gl1 mode file

Documentation

Configuration object for the partition. This object is a placeholder to store any partition specific configuration options. The idea is to split the configuration specific part of the partition into a separate object. Currently only a small number of configuration options are enabled.

rcPartitionConfiguration()

Constructor which sets the default values

inline void setMusic( bool bOnOff )

To enable/disable the music at SOR/EOR

inline void setAutoRunMode( bool bMode )

To enable/disable the auto run mode

inline bool getAutoRunMode()

Returns true if we are in autorun mode

inline void setTimerDisable( bool bDisable )

If true the timers are disabled. These timers are used in the state transition operations and they flag a timeout value. They should only be disabled in debug mode, when we are either in the debugger or possibly in the run control stepmode and we don't want to occur any timeouts.

inline bool areTimersDisabled()

Returns true if the timers are disabled

inline void setTimeout( int iMillisec )

Sets the timeout. See getTimeout for explanation.

inline int getTimeout()

Returns the current value of the timeout. This is the number of milliseconds that the partition object waits during the initialise/download sequence before it drops into the error state if not all stages report success.

inline pstring getGl1Configuration()

Returns the current configuration of the GL1

static pstring getGl1ConfigFile()

Returns the string with the Gl1 mode file. The string must be deleted by the owner once it is no longer needed.

pstring psGl1Configuration

Name of the loaded GL1 configuration. Read from the hidden file that the GL1 writes upon download.

bool bMusic

If true we play some music at SOR/EOR. This is currently not implemented.

bool bAutoRunMode

True if we are currently taking data in autorun mode

bool bDisableTimers

True if we download without using timers to detect timeouts. This can be useful if we are using the debugger.

int iTimeoutMsec

Number of milliseconds after which the partition times out at initialisation/download/start/stop sequence

This class has no child classes.

Author:: C.Witzig
Date: Jan 31, 2000
Version:: Last update Jan 31, 2000

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