Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.Factories
Class SystemFactory

java.lang.Object
  |
  +--RtjAocsFramework.Factories.SystemFactory
Direct Known Subclasses:
JbedSmmSystemFactory, TestSmmSystemFactory

public abstract class SystemFactory
extends Object

Framework-level factory for system management components. This factory implements methods to create the system manager, the mission mode manager and the event repositories and declares methods to create the clock component and to create the data pool. Additionally, a method is offered to configure the AOCS object class.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
V. Cechticky/A. Pasetti (ETH-Zurich)

Constructor Summary
SystemFactory()
          Create and configure the system manager and the event repositories.
 
Method Summary
 void configureAocsObject(RecoveryAction destructionRecoveryAction)
          Configure the AocsObject class.
 ChangeEventRepository getChangeEventRepository()
          Getter method for the event repository.
protected abstract  AocsClock getClock()
          Return the AOCS clock component.
 ConfigurationEventRepository getConfigurationEventRepository()
          Getter method for the event repository.
 FailureEventRepository getFailureEventRepository()
          Getter method for the event repository.
 ManoeuvreEventRepository getManoeuvreEventRepository()
          Getter method for the event repository.
 AocsMissionModeManager getMissionModeManager()
          Return the mission mode manager.
 ModeEventRepository getModeEventRepository()
          Getter method for the event repository.
 ReconfigurationEventRepository getReconfigurationEventRepository()
          Getter method for the event repository.
 RecoveryEventRepository getRecoveryEventRepository()
          Getter method for the event repository.
 SystemEventRepository getSystemEventRepository()
          Getter method for the event repository.
 SystemManager getSystemManager()
          Return the system manager.
 TelecommandEventRepository getTelecommandEventRepository()
          Getter method for the event repository.
protected abstract  void makeClock()
          Make the AOCS clock component.
abstract  void makeDataPools(RecoveryAction r)
          Make the data pools.
 void makeMissionModeManager(ModeChangeAction mca)
          Create and configure the mission mode manager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SystemFactory

public SystemFactory()
Create and configure the system manager and the event repositories. The creation of the system factory should be the first step in the initialization process. The constructor creates the system manager and the event repositories. The system manager is plugged into the AocsObject class which ensures that all further created objects are registered with the system manager.

Method Detail

configureAocsObject

public void configureAocsObject(RecoveryAction destructionRecoveryAction)
Configure the AocsObject class. This method should be called only after the clock component has been created with the makeAocsClock method. This method must not be called more than once.

Parameters:
destructionRecoveryAction - recovery action associated to the failure arising when an AocsObject is dynamically destroyed

getChangeEventRepository

public ChangeEventRepository getChangeEventRepository()
Getter method for the event repository.


getConfigurationEventRepository

public ConfigurationEventRepository getConfigurationEventRepository()
Getter method for the event repository.


getFailureEventRepository

public FailureEventRepository getFailureEventRepository()
Getter method for the event repository.


getManoeuvreEventRepository

public ManoeuvreEventRepository getManoeuvreEventRepository()
Getter method for the event repository.


getModeEventRepository

public ModeEventRepository getModeEventRepository()
Getter method for the event repository.


getReconfigurationEventRepository

public ReconfigurationEventRepository getReconfigurationEventRepository()
Getter method for the event repository.


getRecoveryEventRepository

public RecoveryEventRepository getRecoveryEventRepository()
Getter method for the event repository.


getSystemEventRepository

public SystemEventRepository getSystemEventRepository()
Getter method for the event repository.


getTelecommandEventRepository

public TelecommandEventRepository getTelecommandEventRepository()
Getter method for the event repository.


getSystemManager

public SystemManager getSystemManager()
Return the system manager.


makeMissionModeManager

public void makeMissionModeManager(ModeChangeAction mca)
Create and configure the mission mode manager.

Parameters:
mca - mode change action associated to the mission mode manager

getMissionModeManager

public AocsMissionModeManager getMissionModeManager()
Return the mission mode manager.


makeClock

protected abstract void makeClock()
Make the AOCS clock component. This should be called by the constructor of the derived concrete factory.


getClock

protected abstract AocsClock getClock()
Return the AOCS clock component. This method is abstract because the clock component can only be created in the application factory.


makeDataPools

public abstract void makeDataPools(RecoveryAction r)
Make the data pools. This method is abstract because data pools is application specific component.


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