RtjAocsFramework.ModeManagement
Class AocsMissionModeManager

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ModeManagement.ModeManager
                    |
                    +--RtjAocsFramework.ModeManagement.AocsMissionModeManager

All Implemented Interfaces:

Configurable, Monitorable, Resettable, Telemeterable

public class AocsMissionModeManager

extends ModeManager

This class encapsulates a mission mode manager.

In the mode model used by the framework, components are responsible for managing their own operational mode. They decide on mode changes based on their observation of the external environment. Part of this information can come from monitoring the state of other components but part must come from external signals.

The ground station could, for instance, provide information about changes in orbital conditions, or the beginning of delta-V manoeuvres. Similarly, the central data handling system might be sending commands to switch mode.

The AOCS Mission Mode Manager is the component that is responsible for supplying this information to the rest of the application software. This component encapsulates an operational mode. Its operational mode plays a special role and is therefore given a special name: mission mode. The mission mode would normally be set by telecommands originating either in the central data handling system or at the ground station.

Components whose mode is affected by the agents outside the application software should register as listeners to mode events fired by the mission mode manager.

The mission mode manager basically is a mode manager with no switching logic and without any implementers.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

The Operational Mode 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

AocsMissionModeManager()
Default constructor: the object should not be used before being initialized.

AocsMissionModeManager(int nModes, int defaultMode, int numberOfListeners)
Constructor for the AOCS mission mode manager.

Method Summary

int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
void	setNumberOfModes(int n) Initialization method to set the number of modes.
void	setNumberOfStrategies(int n) Calling this method causes a configuration error.
void	writeToTelemetry(TelemetryStream tmStream) Direct the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.ModeManagement.ModeManager

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

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

AocsMissionModeManager

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

Constructor for the AOCS mission mode manager. Recall that the mission mode manager always has only one strategy and therefore the "number of strategies" parameter is not specified.

Parameters:

nModes - number of modes managed by the mode manager

defaultMode - default mode upon creation and after reset

numberOfListeners - maximum number of listeners to mode events

AocsMissionModeManager

public AocsMissionModeManager()

Default constructor: the object should not be used before being initialized. Initialization is performed by setting the number of modes, the default mode, the maximum number of mode event listeners and the mode change action. The number of strategies is set by default equal to 1.

Method Detail

setNumberOfStrategies

public void setNumberOfStrategies(int n)

Calling this method causes a configuration error. The number of strategies is always equal to 1 in an AOCS mission mode manager.

Overrides:

setNumberOfStrategies in class ModeManager

setNumberOfModes

public void setNumberOfModes(int n)

Initialization method to set the number of modes. The mission mode manager does not have any implementers. This method also loads dummy implementers.

Overrides:

setNumberOfModes in class ModeManager

writeToTelemetry

public void writeToTelemetry(TelemetryStream tmStream)

Description copied from interface: Telemeterable

Direct the object to write its own state to the telemetry stream.

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class ModeManager

getTelemetryImageLength

public int getTelemetryImageLength()

Description copied from interface: Telemeterable

Return the length (in bits) of the telemetry image of the object. This method is useful to verify that the quantity of data generated by a given object is compatible with the capacity of the telemetry channel.

Specified by:

getTelemetryImageLength in interface Telemeterable

Overrides:

getTelemetryImageLength in class ModeManager