Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.AocsEvent
Class FailureEventRepository

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.AocsEvent.EventRepository
                    |
                    +--RtjAocsFramework.AocsEvent.FailureEventRepository
All Implemented Interfaces:
Configurable, ConsistencyCheckable, EventListener, FailureListener, Resettable, Telemeterable

public class FailureEventRepository
extends EventRepository
implements FailureListener

Event repository for failure events.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz)
See Also:
FailureEvent, The Intercomponent Communication Document.

Field Summary
 
Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable
DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM
 
Constructor Summary
FailureEventRepository()
           
 
Method Summary
 FailureEvent latestFailureEvent()
          Type-safe iterator.
 FailureEvent previousFailureEvent()
          Type-safe iterator.
 void processFailureEvent(FailureEvent evt)
          This method is called when a failure has been detected.
 void setRepositorySize(int n)
          Initialization method to set the capacity of the repository.
 
Methods inherited from class RtjAocsFramework.AocsEvent.EventRepository
doConsistencyCheck, getCounter, getListSize, getRecoveryAction, getTelemetryImageLength, insert, isConfigured, isIterationEnded, latest, previous, reset, resetConfiguration, setEvent, setRecoveryAction, setTelemetryFormat, writeToTelemetry
 
Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject
addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager
 
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

FailureEventRepository

public FailureEventRepository()
Method Detail

processFailureEvent

public void processFailureEvent(FailureEvent evt)
Description copied from interface: FailureListener
This method is called when a failure has been detected. The information about the failure is contained in the argument event. The argument event however should not be used by the listener. The listener should retrieve any information it needs from the event and then release it.

Specified by:
processFailureEvent in interface FailureListener

setRepositorySize

public void setRepositorySize(int n)
Initialization method to set the capacity of the repository. This method should only be called once before the components is used. Attempts to call it more than once result in a configuration report being generated.

Overrides:
setRepositorySize in class EventRepository

latestFailureEvent

public FailureEvent latestFailureEvent()
Type-safe iterator. Wraps latestEvent method in super class adding cast from Object to FailureEvent.


previousFailureEvent

public FailureEvent previousFailureEvent()
Type-safe iterator. Wraps previousEvent method in super class adding cast from Object to FailureEvent.


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