Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.AocsEvent
Class ModeEventRepository

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

public class ModeEventRepository
extends EventRepository
implements ModeListener

Event repository mode events.

Copyright: see the Copyright Notice.

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

Field Summary
 
Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable
DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM
 
Constructor Summary
ModeEventRepository()
           
 
Method Summary
 ModeEvent latestModeEvent()
          Type-safe iterator.
 ModeEvent previousModeEvent()
          Type-safe iterator.
 void processModeEvent(ModeEvent evt)
          This method is called when a mode event 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

ModeEventRepository

public ModeEventRepository()
Method Detail

processModeEvent

public void processModeEvent(ModeEvent evt)
Description copied from interface: ModeListener
This method is called when a mode event has been detected. The information about the mode event is contained in the argument. 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:
processModeEvent in interface ModeListener

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

latestModeEvent

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


previousModeEvent

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


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