RtjAocsFramework.FailureRecovery
Class ModeChange

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.FailureRecovery.RecoveryAction
                    |
                    +--RtjAocsFramework.FailureRecovery.ModeChange

All Implemented Interfaces:

Configurable, Resettable, Telemeterable

public class ModeChange

extends RecoveryAction

This recovery action causes an operational mode change in a target mode manager. The target mode manager and the new operational mode are settable configuration parameters.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

The Failure Recovery Framelet Document.

Field Summary

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

ModeChange()
This component should not be used before it is configured by setting the target mode manager and the new mode.

ModeChange(ModeManager targetModeManager, int newMode)

Method Summary

void	doRecovery() Calling this method will cause the recovery action to be executed.
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
boolean	isConfigured() Check that a target mode manager has been loaded
void	resetConfiguration() Unload the target mode manager and set the target mode to 0.
void	setModeManager(ModeManager m) Set the target mode manager whose mode must be changed when the recovery action is executed.
void	setNewMode(int m) Set the target operational mode to which the target mode manager is commanded when the recovery action is executed.
void	writeToTelemetry(TelemetryStream tmStream) Direct the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.FailureRecovery.RecoveryAction

getNextRecoveryAction, isEnabled, reset, setEnabled, setNextRecoveryAction

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

ModeChange

public ModeChange()

This component should not be used before it is configured by setting the target mode manager and the new mode.

ModeChange

public ModeChange(ModeManager targetModeManager,
                  int newMode)

Method Detail

isConfigured

public boolean isConfigured()

Check that a target mode manager has been loaded

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class AocsObject

doRecovery

public void doRecovery()

Description copied from class: RecoveryAction

Calling this method will cause the recovery action to be executed. Conceptually, this should be an abstract method. Its implementation in the base class for all recovery action simply performs the forwarding of the doRecovery() call to the next recovery action in the chain of linked recovery actions.

Overrides:

doRecovery in class RecoveryAction

resetConfiguration

public void resetConfiguration()

Unload the target mode manager and set the target mode to 0.

Specified by:

resetConfiguration in interface Configurable

Overrides:

resetConfiguration in class RecoveryAction

setModeManager

public void setModeManager(ModeManager m)

Set the target mode manager whose mode must be changed when the recovery action is executed.

setNewMode

public void setNewMode(int m)

Set the target operational mode to which the target mode manager is commanded when the recovery action is executed.

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 RecoveryAction

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 RecoveryAction