Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.FailureRecovery
Class Reconfiguration

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

public class Reconfiguration
extends RecoveryAction

This recovery action commands a reconfiguration to a reconfiguration manager. The reconfiguration manager is a 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
Reconfiguration()
          This component should not be used before it is configured by setting the target reconfiguration manager.
Reconfiguration(Reconfigurable objectToBeReconfigured)
           
 
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 the target reconfiguration manager has been loaded.
 void resetConfiguration()
          Unload the target reconfiguration manager.
 void setObjectToBeReconfigured(Reconfigurable r)
          Set the target reconfiguration manager.
 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

Reconfiguration

public Reconfiguration()
This component should not be used before it is configured by setting the target reconfiguration manager.


Reconfiguration

public Reconfiguration(Reconfigurable objectToBeReconfigured)
Method Detail

isConfigured

public boolean isConfigured()
Check that the target reconfiguration 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 reconfiguration manager.

Specified by:
resetConfiguration in interface Configurable
Overrides:
resetConfiguration in class RecoveryAction

setObjectToBeReconfigured

public void setObjectToBeReconfigured(Reconfigurable r)
Set the target reconfiguration manager.


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

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