RtjAocsFramework.ObjectMonitoring
Class OutOfRangeChange

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ObjectMonitoring.ChangeObject
                    |
                    +--RtjAocsFramework.ObjectMonitoring.OutOfRangeChange

All Implemented Interfaces:

Configurable, Resettable, Telemeterable

public class OutOfRangeChange

extends ChangeObject

Check that a value remains within a specified range.

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

OutOfRangeChange()
Default constructor: the upper and lower bounds are set to +1 and -1.

OutOfRangeChange(double lowerBound, double upperBound)

Method Summary

boolean	checkValue(double value) Returns true if the value is outside the [lowerBound,upperBound] range.
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
void	setLowerBound(double r)
void	setUpperBound(double r)
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, reset, 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

OutOfRangeChange

public OutOfRangeChange(double lowerBound,
                        double upperBound)

OutOfRangeChange

public OutOfRangeChange()

Default constructor: the upper and lower bounds are set to +1 and -1.

Method Detail

setUpperBound

public void setUpperBound(double r)

setLowerBound

public void setLowerBound(double r)

checkValue

public boolean checkValue(double value)

Returns true if the value is outside the [lowerBound,upperBound] range. When the change has occurred, the reference value is given by the bound that was violated.

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