Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.FailureDetection
Interface ConsistencyCheckable

All Known Implementing Classes:
AocsData, AocsDataPool, EventRepository

public interface ConsistencyCheckable

Interface characterizing objects that can perform a consistency check upon themselves. A consistency check test verifies that the internal state of the object is consistent. For instance, a consistency check on a quaternion object might verify that the squared sum of the quaternion components is equal to 1 (within a certain tolerance band). In another example, a consistency check on a sensor object verifies that the sensor's outputs are in the range of physically possible values.

Consistency checks are failure detection tests. The framework stipulates that to each failure detection test a recovery action be associated. The interface accordingly defines methods to get and set the recovery action.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz)
See Also:
RecoveryAction, The Failure Detection Management Framelet Document.

Method Summary
 boolean doConsistencyCheck()
          Direct the object to perform a consistency check.
 RecoveryAction getRecoveryAction()
          Get the recovery action associated to the consistency check.
 void setRecoveryAction(RecoveryAction r)
          Set the recovery action associated to the consistency check.
 

Method Detail

doConsistencyCheck

public boolean doConsistencyCheck()
Direct the object to perform a consistency check.

Returns:
true if the internal state was found to be consistent, false otherwise

getRecoveryAction

public RecoveryAction getRecoveryAction()
Get the recovery action associated to the consistency check.


setRecoveryAction

public void setRecoveryAction(RecoveryAction r)
Set the recovery action associated to the consistency check.


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