Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.FailureDetection
Class FollowerFailureDetectionModeManager

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

public class FollowerFailureDetectionModeManager
extends FollowerModeManager
implements FailureDetectionModeManager

Encapsulation of a follower mode manager for the failure detection manager. Concrete failure detection mode managers are defined by the mechanism that they use to decide which particular consistency checkable and monitoring check lists should be returned 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.

This failure detection mode manager also performs hard-coded mode change actions: when there a mode transition, all the change objects in the monitoring check list that becomes active are reset. This is advisable because change objects normally have an internal state.

Change Record:

Copyright: see the Copyright Notice.

Version:
1.3
Author:
Alessandro Pasetti (University of Konstanz)

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
FollowerFailureDetectionModeManager()
          Default constructor.
FollowerFailureDetectionModeManager(int numberOfListeners, ModeManager masterModeManager)
           
 
Method Summary
 ConsistencyCheckableList getConsistencyCheckableList()
          Method called by the failure detection manager to retrieve the list of objects to be subjected to a consistency check in the current activation cycle.
 MonitoringCheckList getMonitoringCheckList()
          Return the currently active monitoring check list.
 void loadConsistencyCheckableList(int mode, ConsistencyCheckableList l)
          Method to configure the failure detection mode manager.
 void loadMonitoringCheckList(int mode, MonitoringCheckList l)
          Method to configure the failure detection mode manager.
 void setConsistencyCheckableList(int mode, ConsistencyCheckableList l)
          This method is identical to method loadConsistencyCheckableList.
 void setMonitoringCheckList(int mode, MonitoringCheckList l)
          This method is identical to method loadConsistencyCheckableList.
 
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

FollowerFailureDetectionModeManager

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


FollowerFailureDetectionModeManager

public FollowerFailureDetectionModeManager(int numberOfListeners,
                                           ModeManager masterModeManager)
Method Detail

loadConsistencyCheckableList

public void loadConsistencyCheckableList(int mode,
                                         ConsistencyCheckableList l)
Description copied from interface: FailureDetectionModeManager
Method to configure the failure detection mode manager. It associates the consistency checkable list l to operational mode 'mode'.

Specified by:
loadConsistencyCheckableList in interface FailureDetectionModeManager

setConsistencyCheckableList

public void setConsistencyCheckableList(int mode,
                                        ConsistencyCheckableList l)
Description copied from interface: FailureDetectionModeManager
This method is identical to method loadConsistencyCheckableList.

Specified by:
setConsistencyCheckableList in interface FailureDetectionModeManager

loadMonitoringCheckList

public void loadMonitoringCheckList(int mode,
                                    MonitoringCheckList l)
Description copied from interface: FailureDetectionModeManager
Method to configure the failure detection mode manager. It associates the monitoring check list l to operational mode 'mode'.

Specified by:
loadMonitoringCheckList in interface FailureDetectionModeManager

setMonitoringCheckList

public void setMonitoringCheckList(int mode,
                                   MonitoringCheckList l)
Description copied from interface: FailureDetectionModeManager
This method is identical to method loadConsistencyCheckableList.

Specified by:
setMonitoringCheckList in interface FailureDetectionModeManager

getConsistencyCheckableList

public ConsistencyCheckableList getConsistencyCheckableList()
Description copied from interface: FailureDetectionModeManager
Method called by the failure detection manager to retrieve the list of objects to be subjected to a consistency check in the current activation cycle.

Specified by:
getConsistencyCheckableList in interface FailureDetectionModeManager

getMonitoringCheckList

public MonitoringCheckList getMonitoringCheckList()
Return the currently active monitoring check list. If this is different from the monitoring check list returned at the previous activation (which would indicate that a mode change has just taken place), the all the change objects associated to the monitoring check objects in the list are reset.

Specified by:
getMonitoringCheckList in interface FailureDetectionModeManager
See Also:
FailureDetectionModeManager.getMonitoringCheckList()

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