Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.UnitManagement
Class UnitTriggerStrategy

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.UnitManagement.UnitTriggerStrategy
All Implemented Interfaces:
Configurable, Resettable, Telemeterable
Direct Known Subclasses:
DefaultUnitTriggerStrategy

public abstract class UnitTriggerStrategy
extends AocsObject

Abstract class UnitTriggerStrategy provides a list of references to UnitFunctional or UnitHousekeeping objects and abstract operations for data acquisition, data sending or synchronization that needs to be performed upon them. Also provides operations to add and remove items in the lists.

Copyright: see the Copyright Notice. Change Record: Version 1.1: changed method names as follows:

   setFunctionalInList -> setFunctionalInListSize
   setFunctionalOutList -> setFunctionalOutListSize
   setHousekeepingInList -> setHousekeepingInListSize
Done by A. Pasetti on 17.02.03

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

Field Summary
protected  UnitFunctionalList unitFcInList
          The list of objects type unit that are interested to provide functional input data
protected  UnitFunctionalList unitFcOutList
          The list of objects type unit that are interested to provide functional output data
protected  UnitHousekeepingList unitHkList
          The list of objects type unit that are interested to provide housekeeping data
 
Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable
DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM
 
Constructor Summary
UnitTriggerStrategy()
          Create a new UnitManager object.
 
Method Summary
 void addFunctionalUnitIn(UnitFunctional u)
          Load an unit to the functional input data list.
 void addFunctionalUnitOut(UnitFunctional u)
          Load an unit to the functional output data list.
 void addHousekeepingUnit(UnitHousekeeping u)
          Load an unit to the housekeeping data list.
abstract  void executeFcInStrategy()
          Perform operations on UnitFunctional objects stored in a dedicated list.
abstract  void executeFcOutStrategy()
          Perform operations on UnitFunctional objects stored in a dedicated list.
abstract  void executeHkStrategy()
          Perform operations on UnitHousekeeping objects stored in a dedicated list.
 boolean isConfigured()
          Check the configuration of the super class, lists with of units that are responsible for data acquisition, data sending, and housekeeping data.
 void removeFunctionalUnitIn(UnitFunctional u)
          Unload an unit from the functional input data list.
 void removeFunctionalUnitOut(UnitFunctional u)
          Unload an unit from the functional output data list.
 void removeHousekeepingUnit(UnitHousekeeping u)
          Unload an unit from the housekeeping data list.
 void reset()
          Reset super object state and performs a local reset.
 void resetConfiguration()
          Reset configuration of the super object and performs the local reset of the configuration.
 void setFunctionalInListSize(int listSize)
          UnitTriggerSrategy must be statically configured prior to initializing an individual UnitTriggerSrategy.
 void setFunctionalOutListSize(int listSize)
          UnitTriggerSrategy must be statically configured prior to initializing an individual UnitTriggerSrategy.
 void setHousekeepingInListSize(int listSize)
          UnitTriggerSrategy must be statically configured prior to initializing an individual UnitTriggerSrategy.
 
Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject
addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTelemetryImageLength, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat, writeToTelemetry
 
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
 

Field Detail

unitFcInList

protected UnitFunctionalList unitFcInList
The list of objects type unit that are interested to provide functional input data


unitFcOutList

protected UnitFunctionalList unitFcOutList
The list of objects type unit that are interested to provide functional output data


unitHkList

protected UnitHousekeepingList unitHkList
The list of objects type unit that are interested to provide housekeeping data

Constructor Detail

UnitTriggerStrategy

public UnitTriggerStrategy()
Create a new UnitManager object.

Method Detail

isConfigured

public boolean isConfigured()
Check the configuration of the super class, lists with of units that are responsible for data acquisition, data sending, and housekeeping data.

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

reset

public void reset()
Reset super object state and performs a local reset.

Specified by:
reset in interface Resettable
Overrides:
reset in class AocsObject

resetConfiguration

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

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

setFunctionalInListSize

public void setFunctionalInListSize(int listSize)
UnitTriggerSrategy must be statically configured prior to initializing an individual UnitTriggerSrategy.

Parameters:
listSize - the number of unit supported by this UnitTriggerSrategy

setFunctionalOutListSize

public void setFunctionalOutListSize(int listSize)
UnitTriggerSrategy must be statically configured prior to initializing an individual UnitTriggerSrategy.

Parameters:
listSize - the number of unit supported by this UnitTriggerSrategy

setHousekeepingInListSize

public void setHousekeepingInListSize(int listSize)
UnitTriggerSrategy must be statically configured prior to initializing an individual UnitTriggerSrategy.

Parameters:
listSize - the number of unit supported by this UnitTriggerSrategy

addFunctionalUnitIn

public void addFunctionalUnitIn(UnitFunctional u)
Load an unit to the functional input data list.

Parameters:
u - an unit to load

addFunctionalUnitOut

public void addFunctionalUnitOut(UnitFunctional u)
Load an unit to the functional output data list.

Parameters:
u - an unit to load

addHousekeepingUnit

public void addHousekeepingUnit(UnitHousekeeping u)
Load an unit to the housekeeping data list.

Parameters:
u - an unit to load

removeFunctionalUnitIn

public void removeFunctionalUnitIn(UnitFunctional u)
Unload an unit from the functional input data list.

Parameters:
u - an unit to unload

removeFunctionalUnitOut

public void removeFunctionalUnitOut(UnitFunctional u)
Unload an unit from the functional output data list.

Parameters:
u - an unit to unload

removeHousekeepingUnit

public void removeHousekeepingUnit(UnitHousekeeping u)
Unload an unit from the housekeeping data list.

Parameters:
u - an unit to load

executeHkStrategy

public abstract void executeHkStrategy()
Perform operations on UnitHousekeeping objects stored in a dedicated list. The method executes actions related to acquisition of housekeeping input data, synchronization, etc.


executeFcInStrategy

public abstract void executeFcInStrategy()
Perform operations on UnitFunctional objects stored in a dedicated list. The method executes actions related to acquisition of functional input data, synchronization, etc.


executeFcOutStrategy

public abstract void executeFcOutStrategy()
Perform operations on UnitFunctional objects stored in a dedicated list. The method executes actions related to sending of functional output data, synchronization, etc.


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