Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.ManoeuvreManagement
Class DummyManoeuvre

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ManoeuvreManagement.Manoeuvre
                    |
                    +--RtjAocsFramework.ManoeuvreManagement.DummyManoeuvre
All Implemented Interfaces:
Configurable, Monitorable, Resettable, Telemeterable

public class DummyManoeuvre
extends Manoeuvre

DummyManoeuvre is an example of a concrete manoeuvre. It is intended to be used for testing purposes only.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Tim Brown (St. Louis, MO, U.S.A.), Vaclav Cechticky (IfA ETHZ)
See Also:
The Manoeuvre Management Framelet Document.

Field Summary
 
Fields inherited from class RtjAocsFramework.ManoeuvreManagement.Manoeuvre
aborted, beenReset, currentState, execTime, finished, inProcess, onHold, ready
 
Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable
DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM
 
Constructor Summary
DummyManoeuvre(int t, int steps)
          DummyManoeuvre
DummyManoeuvre(int t, int steps, String n)
          DummyManoeuvre
 
Method Summary
 void doContinue()
          Manoeuvres execute over a prolonged period of time.
 void initialize()
          Manoeuvres may have to perform some special initialization action when their execution begins.
 
Methods inherited from class RtjAocsFramework.ManoeuvreManagement.Manoeuvre
abort, addChangeListener, addManoeuvreListener, addMonitor, canContinue, canHold, canResume, canStart, fireChangeEvent, fireManoeuvreEvent, getAocsObject, getMonitorablePropertyValue, getNumberOfMonitorableProperties, getState, getTelemetryImageLength, getTimeTag, getType, hold, isConfigured, isFinished, isHolding, isInUse, notifyMonitors, removeChangeListener, removeManoeuvreListener, removeMonitor, reset, resetConfiguration, resume, setInUse, setMaxNumberOfChangeListeners, setMaxNumberOfManoeuvreListeners, setPropertyMonitorListSize, setTimeTag, terminate, wasAborted, 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, 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

DummyManoeuvre

public DummyManoeuvre(int t,
                      int steps)
DummyManoeuvre

Parameters:
t - the time tag
steps - the number of steps to take

DummyManoeuvre

public DummyManoeuvre(int t,
                      int steps,
                      String n)
DummyManoeuvre

Parameters:
t - the time tag
steps - the number of steps to take
n - the name of the dummy manoeuvre
Method Detail

initialize

public void initialize()
Manoeuvres may have to perform some special initialization action when their execution begins. This method encapsulates this type of action. It is called by the manoeuvre manager the first time the manoeuvre is executed.

Overrides:
initialize in class Manoeuvre

doContinue

public void doContinue()
Manoeuvres execute over a prolonged period of time. This method is called by the manoeuvre manager to advance the execution of the manoeuvre. When a manoeuvre object receives this command, it retrieves the current aocs time and performs any actions that are due for execution at that time.

Overrides:
doContinue in class Manoeuvre

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