Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.UnitManagement
Class FollowerUnitStrategyModeManager

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

public class FollowerUnitStrategyModeManager
extends FollowerModeManager
implements UnitModeManager

Encapsulation of a follower mode manager for the unit strategy mode manager. Concrete unit strategy mode managers are defined by the mechanism that they use to decide which particular unit trigger strategy should be returned by method getUnitTriggerStrategy() 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:
Vaclav Cechticky (IfA ETHZ), Alessandro Pasetti (University of Konstanz)
See Also:
Unit 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
FollowerUnitStrategyModeManager()
          Default constructor.
 
Method Summary
 UnitTriggerStrategy getUnitTriggerStrategy()
          The method is called by the unit manager to retrieve the currently valid unit trigger strategy.
 void loadUnitTriggerStrategy(int mode, UnitTriggerStrategy uStrategy)
          The method is used to configure the unit strategy mode manager.
 void setUnitTriggerStrategy(int mode, UnitTriggerStrategy uStrategy)
          This method is identical to method loadUnitTriggerStrategy.
 
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

FollowerUnitStrategyModeManager

public FollowerUnitStrategyModeManager()
Default constructor. The object should not be used before it is configured by setting the master mode manager.

Method Detail

loadUnitTriggerStrategy

public void loadUnitTriggerStrategy(int mode,
                                    UnitTriggerStrategy uStrategy)
The method is used to configure the unit strategy mode manager. It associates a unit trigger strategy 'uStrategy' to operational mode 'mode'.

Specified by:
loadUnitTriggerStrategy in interface UnitModeManager
Parameters:
mode - the operational mode
uStrategy - the unit trigger strategy

setUnitTriggerStrategy

public void setUnitTriggerStrategy(int mode,
                                   UnitTriggerStrategy uStrategy)
This method is identical to method loadUnitTriggerStrategy.

Specified by:
setUnitTriggerStrategy in interface UnitModeManager

getUnitTriggerStrategy

public UnitTriggerStrategy getUnitTriggerStrategy()
The method is called by the unit manager to retrieve the currently valid unit trigger strategy.

Specified by:
getUnitTriggerStrategy in interface UnitModeManager
Returns:
the currently valid unit trigger strategy

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