Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.ControllerManagement
Class FollowerControllerModeManager

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ModeManagement.ModeManager
                    |
                    +--RtjAocsFramework.ModeManagement.FollowerModeManager
                          |
                          +--RtjAocsFramework.ControllerManagement.FollowerControllerModeManager
All Implemented Interfaces:
Configurable, ControllerModeManager, EventListener, ModeListener, Monitorable, Resettable, Telemeterable

public class FollowerControllerModeManager
extends FollowerModeManager
implements ControllerModeManager

Encapsulation of a follower 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 follower mode manager. In a typical configuration, this mode manager would be slaved to the AOCS mission mode manager.

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

Change Record:

Copyright: see the Copyright Notice.

Version:
1.2
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
FollowerControllerModeManager()
          Default constructor.
FollowerControllerModeManager(int numberOfListeners, ModeManager masterModeManager)
          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.FollowerModeManager
processModeEvent, setDefaultMode, setMasterModeManager, setNumberOfModes
 
Methods inherited from class RtjAocsFramework.ModeManagement.ModeManager
addChangeListener, addModeListener, changeMode, disableMode, enableMode, fireChangeEvent, fireModeEvent, forceMode, getAocsObject, getDefaultMode, getImplementer, getMode, getModeChangeAction, getMonitorablePropertyValue, getNumberOfModes, getNumberOfMonitorableProperties, getTelemetryImageLength, isConfigured, isModeLegal, loadImplementer, notifyMonitors, releaseMode, removeChangeListener, removeModeListener, reset, resetConfiguration, setMaxNumberOfChangeListeners, setMaxNumberOfModeListeners, setMode, setModeChangeAction, setNumberOfStrategies, setPropertyMonitorListSize, updateMode, 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

FollowerControllerModeManager

public FollowerControllerModeManager()
Default constructor. The object should not be used before it is configured by setting the master mode manager and the maximum number of listeners.


FollowerControllerModeManager

public FollowerControllerModeManager(int numberOfListeners,
                                     ModeManager masterModeManager)
The constructor.

Parameters:
numberOfListeners - the maximum number of listeners
masterModeManager - the master mode manager
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

Real-Time Java AOCS Framework v1.0 API Specification

Real-Time Java AOCS Framework project home page

Automatic Control Laboratory, ETH Zuerich
Physikstrasse 3
CH-8092 Zuerich, Switzerland