Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.UnitManagement
Interface UnitModeManager

All Known Implementing Classes:
FollowerUnitStrategyModeManager

public interface UnitModeManager

Interface characterizing the mode manager for the unit managers. This mode manager manages one single strategy representing the "triggering strategy" for the unit manager. A triggering strategy defines a set of units and the operations to be performed upon them.

Change Record:

Copyright: see the Copyright Notice.

Version:
1.1
Author:
Vaclav Cechticky (IfA ETHZ), Alessandro Pasetti (University of Konstanz)
See Also:
Unit Framelet Document

Method Summary
 UnitTriggerStrategy getUnitTriggerStrategy()
          The method is called by the unit manager to retrieve the currently valid unit trigger strategy.
 void loadUnitTriggerStrategy(int mode, UnitTriggerStrategy uStrategy)
          The method is used to configure the unit strategy mode manager.
 void setUnitTriggerStrategy(int mode, UnitTriggerStrategy uStrategy)
          This method is identical to method loadUnitTriggerStrategy.
 

Method Detail

loadUnitTriggerStrategy

public void loadUnitTriggerStrategy(int mode,
                                    UnitTriggerStrategy uStrategy)
The method is used to configure the unit strategy mode manager. It associates an unit trigger strategy 'uStrategy' to operational mode 'mode'.

Parameters:
mode - the operational mode
uStrategy - the unit trigger strategy

setUnitTriggerStrategy

public void setUnitTriggerStrategy(int mode,
                                   UnitTriggerStrategy uStrategy)
This method is identical to method loadUnitTriggerStrategy.


getUnitTriggerStrategy

public UnitTriggerStrategy getUnitTriggerStrategy()
The method is called by the unit manager to retrieve the currently valid unit trigger strategy.

Returns:
the currently valid unit trigger strategy

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