RtjAocsFramework.ControllerManagement
Class CyclingControllerModeManager

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ModeManagement.ModeManager
                    |
                    +--RtjAocsFramework.ModeManagement.CyclingModeManager
                          |
                          +--RtjAocsFramework.ControllerManagement.CyclingControllerModeManager

All Implemented Interfaces:

Configurable, ControllerModeManager, Monitorable, Resettable, Telemeterable

public class CyclingControllerModeManager

extends CyclingModeManager

implements ControllerModeManager

Encapsulation of a cycling mode manager for the controller mode manager. Concrete controller mode managers are defined by the mechanism that they use to decide which particular controller list should be returned by method getControllerList() at any given point in time. This class defines a mode manager that is based on the cycling mode manager. It manages a fixed number of controllable lists and returns them in sequence at every call of getControllerList().

This class is basically a type-safe wrapper around the cycling mode manager component exported by the operational mode framelet.

Change Record:

• Version 1.1: Added method setControllerList that is semantically identical to the loadControllerList method but has a signature that complies with the JavaBeans indexed property naming pattern. Done by A. Pasetti on 23.03.03

Copyright: see the Copyright Notice.

Version:

1.1

Author:

Tim Brown (St. Louis, MO, U.S.A.), Vaclav Cechticky (IfA ETHZ)

See Also:

The Controller Management Framelet Document.

Field Summary

Fields inherited from class RtjAocsFramework.ModeManagement.ModeManager

currentMode, nModes, nStrategies

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

CyclingControllerModeManager()
Default constructor.

CyclingControllerModeManager(int nModes, int defaultMode, int numberOfListeners)
The constructor.

Method Summary

ControllerList	getControllerList() The method is called by the controller manager to retrieve the currently valid controller list.
void	loadControllerList(int mode, ControllerList r) The method is used to configure the controller mode manager.
void	setControllerList(int mode, ControllerList l) This method is identical to method loadControllerList.

Methods inherited from class RtjAocsFramework.ModeManagement.CyclingModeManager

getImplementer, setNumberOfStrategies, updateMode

Methods inherited from class RtjAocsFramework.ModeManagement.ModeManager

addChangeListener, addModeListener, changeMode, disableMode, enableMode, fireChangeEvent, fireModeEvent, forceMode, getAocsObject, getDefaultMode, getMode, getModeChangeAction, getMonitorablePropertyValue, getNumberOfModes, getNumberOfMonitorableProperties, getTelemetryImageLength, isConfigured, isModeLegal, loadImplementer, notifyMonitors, releaseMode, removeChangeListener, removeModeListener, reset, resetConfiguration, setDefaultMode, setMaxNumberOfChangeListeners, setMaxNumberOfModeListeners, setMode, setModeChangeAction, setNumberOfModes, setPropertyMonitorListSize, writeToTelemetry

Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject

addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat

Methods inherited from class RtjAocsFramework.BasicObjects.RootObject

getClassId, getInstanceId, setClassId

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CyclingControllerModeManager

public CyclingControllerModeManager()

Default constructor. The object should not be used before it is configured by setting the number of modes, the default mode and the maximum number of listeners.

CyclingControllerModeManager

public CyclingControllerModeManager(int nModes,
                                    int defaultMode,
                                    int numberOfListeners)

The constructor.

Parameters:

nModes - the number of modes

defaultMode - the default mode

numberOfListeners - the maximum number of listeners

Method Detail

loadControllerList

public void loadControllerList(int mode,
                               ControllerList r)

The method is used to configure the controller mode manager. It associates controller list 'r' to operational mode 'mode'.

Specified by:

loadControllerList in interface ControllerModeManager

Parameters:

mode - the operational mode

r - a controller list

setControllerList

public void setControllerList(int mode,
                              ControllerList l)

This method is identical to method loadControllerList.

Specified by:

setControllerList in interface ControllerModeManager

getControllerList

public ControllerList getControllerList()

The method is called by the controller manager to retrieve the currently valid controller list.

Specified by:

getControllerList in interface ControllerModeManager

Returns:

the currently valid controller list