Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.TelecommandManagement
Interface TelecommandLoader

All Superinterfaces:
ActiveObject
All Known Implementing Classes:
JbedSmmTelecommandLoader, TestTelecommandLoader

public interface TelecommandLoader
extends ActiveObject

Interface implemented by all telecommand loaders. The telecommand loader is responsible for loading telecommands into the telecommand manager. The loading mechanism cannot be specified by the framework as it is application dependent. For this reason, telecommand loaders are represented by an abstract interface.

A typical telecommand loader performs the following actions in a telecommand loading cycle: 1) the telecommand (its data and\or its code) is retrieved from an input device and packaged as an object of type Telecommand; 2) the telecommand is loaded into the telecommand manager through a call to the latterīs loadTelecommand method.

The loading of telecommands may involve the dynamic allocation of resources that have to be released after the telecommand has been executed. For this reason, the interface defines a release() method that must be called by the telecommand manager after it has executed a telecommand.

The telecommand loader is an active object and telecommand loading might be triggered by an interrupt (indicating the arrival of a new telecommand) or it might be activated periodically by a scheduler.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz)
See Also:
The Telecommand Management Framelet Document.

Method Summary
 TelecommandManager getTelecommandManager()
           
 void release(int TelecommandId)
          Release resource allocated to the telecommand with given identifier.
 void release(Telecommand telecommand)
          Release resources allocated to argument telecommand.
 void releaseAll()
          Release all resources allocated to the currently loaded telecommands.
 void setTelecommandManager(TelecommandManager m)
          A telecommand loader needs a reference to the telecommand manager in order to be able to add the newly-loaded telecommands to its list of pending telecommands.
 
Methods inherited from interface RtjAocsFramework.OperatingSystemObjects.ActiveObject
initialize, runOneCycle, terminate
 

Method Detail

release

public void release(int TelecommandId)
Release resource allocated to the telecommand with given identifier. A telecommand loader manages memory and other resources that it allocates to the telecommands that it loads. This method will cause the resources allocated to the specified telecommand. The method is normally called by the telecommand manager after the telecommand has been executed. In this version of the method, the telecommand is identified by an identifier. Another version of the same method exist that uses as argument the telecommand itself.


release

public void release(Telecommand telecommand)
Release resources allocated to argument telecommand.

See Also:
release(int)

releaseAll

public void releaseAll()
Release all resources allocated to the currently loaded telecommands.

See Also:
release(int)

setTelecommandManager

public void setTelecommandManager(TelecommandManager m)
A telecommand loader needs a reference to the telecommand manager in order to be able to add the newly-loaded telecommands to its list of pending telecommands.


getTelecommandManager

public TelecommandManager getTelecommandManager()
See Also:
setTelecommandManager(TelecommandManager)

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