Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.ObjectMonitoring
Class DeltaChange

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ObjectMonitoring.ChangeObject
                    |
                    +--RtjAocsFramework.ObjectMonitoring.DeltaChange
All Implemented Interfaces:
Configurable, Resettable, Telemeterable

public class DeltaChange
extends ChangeObject

Check that a variable does not change value across successive checks by more than a pre-specified delta threshold. The delta threshold is the reference value of the change object. The first time the change object is activated after creation or after a reset.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz)
See Also:
The Object Monitoring Document.

Field Summary
 
Fields inherited from class RtjAocsFramework.ObjectMonitoring.ChangeObject
referenceValue
 
Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable
DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM
 
Constructor Summary
DeltaChange()
          Default constructor: the delta threshold is set to 1.
DeltaChange(double deltaThreshold)
           
 
Method Summary
 boolean checkValue(double value)
          Returns true if the value is different from the previous value that was passed through the change object filter.
 int getTelemetryImageLength()
          Return the length (in bits) of the telemetry image of the object.
 void reset()
          Bring the resettable state of the object to its initial default value.
 void writeToTelemetry(TelemetryStream tmStream)
          Direct the object to write its own state to the telemetry stream.
 
Methods inherited from class RtjAocsFramework.ObjectMonitoring.ChangeObject
getReferenceValue, setReferenceValue
 
Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject
addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, isConfigured, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetConfiguration, 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

DeltaChange

public DeltaChange(double deltaThreshold)

DeltaChange

public DeltaChange()
Default constructor: the delta threshold is set to 1.

Method Detail

reset

public void reset()
Description copied from interface: Resettable
Bring the resettable state of the object to its initial default value. A call to method reset on an object A is sometimes propagated to objects that are logically contained in A (relationship of strong aggregation).

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

checkValue

public boolean checkValue(double value)
Returns true if the value is different from the previous value that was passed through the change object filter. The reference value is equal to the value passed through the change object filter.

Specified by:
checkValue in class ChangeObject

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 AocsObject

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 AocsObject

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