RtjAocsFramework.ControllerManagement
Class ControllerManager

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.ControllerManagement.ControllerManager

All Implemented Interfaces:

ActiveObject, Configurable, Resettable, Telemeterable

public class ControllerManager

extends AocsObject

implements ActiveObject

This class encapsulates a controller manager.

Controllers are passive objects that model a closed-loop control system. The object that is responsible for their activation and for controlling their operations is the controller manager. A controller manager is an active object. It maintains a list of controllers that are represented as objects of type Controller. When the controller manager is activated by the scheduler, it goes through the list, checks whether the controllers are stable and, if they are, it calls their 'doControl()' method.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Tim Brown (St. Louis, MO, U.S.A.), Vaclav Cechticky (IfA ETHZ)

See Also:

The Controller Management Framelet Document.

Field Summary

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

ControllerManager()
ControllerManager

Method Summary

ControllerModeManager	getModeManager() Gets the mode manager.
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.
boolean	initialize() The method inherited from the interface ActiveObject.
boolean	isConfigured() Checks the configuration.
void	resetConfiguration() Resets configuration of the super object and performs the local reset of the configuration.
void	runOneCycle(int deadline) Scheduler entry point.
void	setModeManager(ControllerModeManager cmm) Sets the mode manager.
boolean	terminate() The method inherited from the interface ActiveObject.
void	writeToTelemetry(TelemetryStream stream) Causes the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject

addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, reset, 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

ControllerManager

public ControllerManager()

ControllerManager

Method Detail

runOneCycle

public void runOneCycle(int deadline)

Scheduler entry point.

Specified by:

runOneCycle in interface ActiveObject

Parameters:

deadline - the method must return before this time

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 AocsObject

isConfigured

public boolean isConfigured()

Checks the configuration.

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class AocsObject

Returns:

the true value if the object is configured, otherwise returns false

writeToTelemetry

public void writeToTelemetry(TelemetryStream stream)

Causes the object to write its own state to the telemetry stream.

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class AocsObject

Parameters:

stream - the telemetry stream

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 AocsObject

Returns:

the length in bits of the telemetry image

setModeManager

public void setModeManager(ControllerModeManager cmm)

Sets the mode manager.

Parameters:

cmm - particular controller mode manager

getModeManager

public ControllerModeManager getModeManager()

Gets the mode manager.

Returns:

the controller mode manager

initialize

public boolean initialize()

The method inherited from the interface ActiveObject. Not implemented in this class.

Specified by:

initialize in interface ActiveObject

Returns:

true if initialization was successful.

terminate

public boolean terminate()

The method inherited from the interface ActiveObject. Not implemented in this class.

Specified by:

terminate in interface ActiveObject

Returns:

true if shutdown was successful.