RtjAocsFramework.UnitManagement
Interface UnitHousekeeping

All Known Implementing Classes:

Unit

public interface UnitHousekeeping

UnitHousekeeping is an interface for objects representing the housekeeping exchanges between the embedded control software and an external unit (either real or fictitious).

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Vaclav Cechticky (IfA ETHZ), Alessandro Pasetti (University of Konstanz)

See Also:

Unit Framelet Document

Method Summary

void	acquireHousekeepingData() Initiate the transaction(s) for the acquisition of housekeeping data from the unit.
int	getSelfTestResults() Return an integer representing the outcome of the self-test.
void	initialize() Units often have to perform some kind of initialization procedure after being switched on.
boolean	isHousekeepingTransactionFinished() The method returns the completion status of the housekeeping transaction.
void	isInitialized() Check a status of the initialization process.
boolean	isSelfTestFinished() Return true when the self test has been completed.
boolean	isSwitchedOn() Retrieve the power status of the unit.
boolean	isSynchronizeHousekeepingFinished() Check whether the underlying transaction has been completed.
void	performSelfTest() Start a self-test.
void	refreshHousekeepingIn() Housekeeping data are acquired at raw data level and placed in a hardware buffer internal to the unit.
void	resetUnit() Reset the external unit.
void	setHousekeepingConverter(AbstractControlChannel c) Data conversion from raw data level to customized data level, and any other processing on the raw data (eg. bias correction), is done by a control channel object.
void	setHousekeepingLink(DataSink hkLink) Set the housekeeping data link for the housekeeping data.
void	setHousekeepingLink(DataSink hkLink, int i, int j) Set the housekeeping data link for the housekeeping data.
void	switchOff() Switch off the unit.
void	switchOn() Switch on the unit.
void	synchronizeHousekeeping() Initiate a synchronization operation for the housekeeping data

Method Detail

performSelfTest

public void performSelfTest()

Start a self-test.

isSelfTestFinished

public boolean isSelfTestFinished()

Return true when the self test has been completed.

getSelfTestResults

public int getSelfTestResults()

Return an integer representing the outcome of the self-test.

initialize

public void initialize()

Units often have to perform some kind of initialization procedure after being switched on. A call to initialize() causes this initialization procedure to be carried out.

isInitialized

public void isInitialized()

Check a status of the initialization process.

switchOn

public void switchOn()

Switch on the unit.

switchOff

public void switchOff()

Switch off the unit.

isSwitchedOn

public boolean isSwitchedOn()

Retrieve the power status of the unit.

resetUnit

public void resetUnit()

Reset the external unit. Note that this is different from the generic reset method that applies to all objects in the application. The method resetUnit() issues commands to reset an external unit.

acquireHousekeepingData

public void acquireHousekeepingData()

Initiate the transaction(s) for the acquisition of housekeeping data from the unit.

isHousekeepingTransactionFinished

public boolean isHousekeepingTransactionFinished()

The method returns the completion status of the housekeeping transaction.

Returns:

true value if the acquire transaction has been finished

refreshHousekeepingIn

public void refreshHousekeepingIn()

Housekeeping data are acquired at raw data level and placed in a hardware buffer internal to the unit. A call to this method causes them to be converted to customized data level and transferred to a data pool location.

synchronizeHousekeeping

public void synchronizeHousekeeping()

Initiate a synchronization operation for the housekeeping data

isSynchronizeHousekeepingFinished

public boolean isSynchronizeHousekeepingFinished()

Check whether the underlying transaction has been completed.

setHousekeepingLink

public void setHousekeepingLink(DataSink hkLink)

Set the housekeeping data link for the housekeeping data.

setHousekeepingLink

public void setHousekeepingLink(DataSink hkLink,
                                int i,
                                int j)

Set the housekeeping data link for the housekeeping data. Links the j-th housekeeping output of the Unit to the i-th input of a DataSink.

setHousekeepingConverter

public void setHousekeepingConverter(AbstractControlChannel c)

Data conversion from raw data level to customized data level, and any other processing on the raw data (eg. bias correction), is done by a control channel object. This method allows the converter control channel to be loaded. The control channel will in general be a multi-input-multi-output control channel. The correct number of inputs and outputs is checked when the control channel is loaded, the number of inputs and outputs has to be equal. An incorrect number of inputs and/or outputs represents a configuration error.

Parameters:

c - particular control channel object