Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.FailureRecovery
Class LocalRecoveryActions

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.FailureRecovery.RecoveryStrategy
                    |
                    +--RtjAocsFramework.FailureRecovery.LocalRecoveryActions
All Implemented Interfaces:
Configurable, Resettable, Telemeterable

public class LocalRecoveryActions
extends RecoveryStrategy

This recovery strategy retrieves from the event repository the failure events generated since the last call to doRecovery() and performs the recovery actions associated to each event. 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
LocalRecoveryActions()
           
 
Method Summary
 void doRecovery()
          Calling this method will cause the recovery strategy to be executed.
 int getTelemetryImageLength()
          Return the length (in bits) of the telemetry image of the object.
 void localReset()
           
 void reset()
          Set the state of the recovery strategy to 'enabled'.
 void setFailureEventRepository(FailureEventRepository r)
          This is an initialization method to load the failure event repository and to initialize the internal counter of failure events.
 void writeToTelemetry(TelemetryStream tmStream)
          Direct the object to write its own state to the telemetry stream.
 
Methods inherited from class RtjAocsFramework.FailureRecovery.RecoveryStrategy
addRecoveryListener, fireModeEvent, getFailureEventRepository, getNextRecoveryStrategy, isConfigured, isEnabled, removeRecoveryListener, resetConfiguration, setEnabled, setMaxNumberOfRecoveryListeners, setNextRecoveryStrategy
 
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

LocalRecoveryActions

public LocalRecoveryActions()
Method Detail

localReset

public void localReset()

setFailureEventRepository

public void setFailureEventRepository(FailureEventRepository r)
This is an initialization method to load the failure event repository and to initialize the internal counter of failure events.

Overrides:
setFailureEventRepository in class RecoveryStrategy

doRecovery

public void doRecovery()
Description copied from class: RecoveryStrategy
Calling this method will cause the recovery strategy to be executed. Conceptually, this should be an abstract method. Its implementation in the base class for all recovery strategies simply performs the forwarding of the doRecovery() call to the next recovery strategy in the chain of linked recovery strategies.

Overrides:
doRecovery in class RecoveryStrategy

reset

public void reset()
Description copied from class: RecoveryStrategy
Set the state of the recovery strategy to 'enabled'.

Specified by:
reset in interface Resettable
Overrides:
reset in class RecoveryStrategy

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 RecoveryStrategy

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 RecoveryStrategy

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