RtjAocsFramework.FailureDetection
Class MonitoringCheck

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.FailureDetection.MonitoringCheck

All Implemented Interfaces:

Configurable, Resettable, Telemeterable

public class MonitoringCheck

extends AocsObject

This class encapsulates the object of a monitoring check action by the failure detection manager. The failure detection manager detects failures by, among others, monitoring the properties of some objects for specific changes. Property monitoring can be performed in several manners but the failure detection manager performs it exclusively through the direct monitoring mechanism.

A monitoring check object packages in a single object a monitorable property to be checked, the change object defining the type of change and the recovery action to be performed in case the change is found to have occurred. The property to be monitored is specified by its property owner (an object of type Monitorable) and by the an integer index that identifies the property within it.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

Field Summary

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

MonitoringCheck()
Default constructor.

MonitoringCheck(Monitorable propertyOwner, int propertyIndex, ChangeObject c, RecoveryAction r)

Method Summary

ChangeObject	getChangeObject()
int	getPropertyIndex()
Monitorable	getPropertyOwner()
double	getPropertyValue() Return the value of the property to be monitored.
RecoveryAction	getRecoveryAction()
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
void	setChangeObject(ChangeObject c) Initialization method to set the change object (to be used in conjunction with the default constructor).
void	setPropertyIndex(int n) Initialization method to set the property index (to be used in conjunction with the default constructor).
void	setPropertyOwner(Monitorable m) Initialization method to set the property owner (to be used in conjunction with the default constructor).
void	setRecoveryAction(RecoveryAction r) Initialization method to set the recovery action (to be used in conjunction with the default constructor).
void	writeToTelemetry(TelemetryStream tmStream) Direct the object to write its own state to the telemetry stream.

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

MonitoringCheck

public MonitoringCheck()

Default constructor. The object should not be used before it is configured by setting the property owner, the change action and the recovery action. The property index is given a default value of 0.

MonitoringCheck

public MonitoringCheck(Monitorable propertyOwner,
                       int propertyIndex,
                       ChangeObject c,
                       RecoveryAction r)

Method Detail

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

setPropertyOwner

public void setPropertyOwner(Monitorable m)

Initialization method to set the property owner (to be used in conjunction with the default constructor).

setPropertyIndex

public void setPropertyIndex(int n)

Initialization method to set the property index (to be used in conjunction with the default constructor).

setChangeObject

public void setChangeObject(ChangeObject c)

Initialization method to set the change object (to be used in conjunction with the default constructor).

setRecoveryAction

public void setRecoveryAction(RecoveryAction r)

Initialization method to set the recovery action (to be used in conjunction with the default constructor).

getChangeObject

public ChangeObject getChangeObject()

getPropertyIndex

public int getPropertyIndex()

getPropertyOwner

public Monitorable getPropertyOwner()

getRecoveryAction

public RecoveryAction getRecoveryAction()

getPropertyValue

public double getPropertyValue()

Return the value of the property to be monitored. The property value is accessed from the property owner.