Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.AocsEvent
Class ManoeuvreEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--RtjAocsFramework.AocsEvent.AocsEvent
              |
              +--RtjAocsFramework.AocsEvent.ManoeuvreEvent
All Implemented Interfaces:
Configurable, Resettable, Serializable, Telemeterable

public class ManoeuvreEvent
extends AocsEvent

This class encapsulates a manoeuvre event. Manoeuvre events are used to record changes in the internal state of a manoeuvre.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz), Vaclav Cechticky (IfA ETHZ)
See Also:
ManoeuvreManager, 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
ManoeuvreEvent(Object dummySource)
          ManoeuvreEvent
 
Method Summary
 Manoeuvre getManoeuvre()
          getManoeuvre
 int getTelemetryImageLength()
          Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.
 void initialize(AocsObject creator, short evtType, Manoeuvre m)
          Initialize the manoeuvre event.
 boolean isConfigured()
          Checks the configuration.
 void resetConfiguration()
          Resets configuration of the super object and performs the local reset of the configuration.
 void writeToTelemetry(TelemetryStream tmStream)
          Causes 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

ManoeuvreEvent

public ManoeuvreEvent(Object dummySource)
ManoeuvreEvent

Method Detail

initialize

public void initialize(AocsObject creator,
                       short evtType,
                       Manoeuvre m)
Initialize the manoeuvre event.

The creator and evtType parameters are the same as in the initialize method in the super class AocsEvent.

Parameters:
creator -
evtType -
m -
See Also:
AocsEvent.initialize(RtjAocsFramework.BasicObjects.AocsObject, short)

getManoeuvre

public Manoeuvre getManoeuvre()
getManoeuvre

Returns:
Manoeuvre

resetConfiguration

public void resetConfiguration()
Resets configuration of the super object and performs the local reset of the configuration.

Specified by:
resetConfiguration in interface Configurable
Overrides:
resetConfiguration in class AocsEvent

isConfigured

public boolean isConfigured()
Checks the configuration.

Specified by:
isConfigured in interface Configurable
Overrides:
isConfigured in class AocsEvent
Returns:
the true value if the object is configured, otherwise returns false

writeToTelemetry

public void writeToTelemetry(TelemetryStream tmStream)
Causes 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()
Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.

Specified by:
getTelemetryImageLength in interface Telemeterable
Overrides:
getTelemetryImageLength in class AocsEvent
Returns:
the length in bits of the telemetry image

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