RtjAocsFramework.AocsEvent
Class ChangeEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--RtjAocsFramework.AocsEvent.AocsEvent
              |
              +--RtjAocsFramework.AocsEvent.ChangeEvent

All Implemented Interfaces:

Configurable, Resettable, Serializable, Telemeterable

public class ChangeEvent

extends AocsEvent

This class encapsulates a change event. A change event records the detection of a change in a monitorable property by a change object. Change events are typically generated by the failure detection manager in response to the violation of a monitoring checks.

This class adds the following attribute to the basic AOCS event class: the change object that caught the change, the last value passed through the change object filter, and the monitorable property that underwent the change. The latter is identified by an object of type Monitorable and by the property index within this object.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

The Intercomponent Communication Document., ChangeObject, Monitorable, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

ChangeEvent(Object dummySource)

Method Summary

ChangeObject	getChangeObject()
double	getLastValue()
int	getPropertyIndex()
Monitorable	getPropertyOwner()
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
void	initialize(AocsObject creator, short evtType, ChangeObject changeObject, Monitorable propertyOwner, int propertyIndex, double lastValue) Initialize the change event.
boolean	isConfigured() Return false if some configuration data are missing.
void	resetConfiguration() Clear all configuration information.
void	writeToTelemetry(TelemetryStream tmStream) Direct the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.AocsEvent.AocsEvent

getCreator, getEventType, getTelemetryFormat, getTimeStamp, initialize, reset, setTelemetryFormat

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeEvent

public ChangeEvent(Object dummySource)

Method Detail

initialize

public void initialize(AocsObject creator,
                       short evtType,
                       ChangeObject changeObject,
                       Monitorable propertyOwner,
                       int propertyIndex,
                       double lastValue)

Initialize the change event. Note that the creator and evtType parameters are the same as in the initialize method in the super class AocsEvent.

Parameters:

changeObject - the change object that detected the change

propertyOwner - the owner of the monitorable property that underwent the change

propertyIndex - the index that identifies the property that underwent the change within the property owner

lastValue - the last value that was passed through the change object filter (this is the value in the monitorable property that triggered the change)

See Also:

AocsEvent.initialize(RtjAocsFramework.BasicObjects.AocsObject, short)

getChangeObject

public ChangeObject getChangeObject()

getPropertyOwner

public Monitorable getPropertyOwner()

getPropertyIndex

public int getPropertyIndex()

getLastValue

public double getLastValue()

resetConfiguration

public void resetConfiguration()

Description copied from interface: Configurable

Clear all configuration information.

Calls to resetConfiguration are propagated to objects that are in a relationship of strong aggregation.

Specified by:

resetConfiguration in interface Configurable

Overrides:

resetConfiguration in class AocsEvent

isConfigured

public boolean isConfigured()

Description copied from interface: Configurable

Return false if some configuration data are missing.

Typically, a false value indicates that a plug-in component is missing or that the object has not been initialized. This is a negative check only: a return value of true cannot guarantee that the object is correctly configured.

Calls to resetConfiguration on an object A are normally not propagated objects of type AocsObject that are contained or otherwise aggregated to A. The rationale for this policy is that all objects of type AocsObject implement interface configurable and therefore their configuration status should be checked externally (probably through the configuration check service of the system manager).

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class AocsEvent

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 AocsEvent

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 AocsEvent