RtjAocsFramework.UnitManagement
Interface UnitFunctional

All Superinterfaces:

DataSink, DataSource

All Known Implementing Classes:

BasicUnitReconfigurer, Unit

public interface UnitFunctional

extends DataSource, DataSink

UnitFunctional is an interface for objects representing the functional 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	acquireFunctionalData() Initiate the transaction(s) for the acquisition of functional data from the unit.
boolean	isAcquireTransactionFinished() The method returns the completion status of the acquisition.
boolean	isSendTransactionFinished() The method returns the completion status of the send transaction.
boolean	isSynchronizeFunctionalFinished() Check whether the underlying transaction has been completed.
void	refreshFunctionalIn() Functional data are acquired at raw data level and placed in a hardware buffer internal to the unit.
void	refreshFunctionalOut() Sent functional data to the external unit are taken from hardware buffer internal to the unit.
void	sendFunctionalData() Initiate the transaction(s) to send the functional data to the unit.
void	setFunctionalInConverter(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	setFunctionalInLink(DataSink destLink) Set the functional input data link for the data converted from raw data level to customized data level.
void	setFunctionalInLink(DataSink destLink, int i, int j) Set the functional input data link for the data converted from raw data level to customized data level.
void	setFunctionalOutConverter(AbstractControlChannel c) Data conversion from customized data level (in the source buffers) to raw data level (in the hardware buffer) is done by a control channel object.
void	setFunctionalOutLink(DataSource sourceLink) Set the functional output data link for the data at customized data level.
void	setFunctionalOutLink(DataSource sourceLink, int i, int j) Set the functional output data link for the data at customized data level.
void	synchronizeFunctional() Initiate a synchronization operation for the functional data.

Methods inherited from interface RtjAocsFramework.AocsData.DataSource

getNumberOfOutputs, getOutput

Methods inherited from interface RtjAocsFramework.AocsData.DataSink

getNumberOfInputs, setInput

Method Detail

acquireFunctionalData

public void acquireFunctionalData()

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

sendFunctionalData

public void sendFunctionalData()

Initiate the transaction(s) to send the functional data to the unit.

isAcquireTransactionFinished

public boolean isAcquireTransactionFinished()

The method returns the completion status of the acquisition.

Returns:

true value if the acquire transaction has been finished

isSendTransactionFinished

public boolean isSendTransactionFinished()

The method returns the completion status of the send transaction.

Returns:

true value if the send transaction has been finished

refreshFunctionalIn

public void refreshFunctionalIn()

Functional 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 linked DataSink object.

refreshFunctionalOut

public void refreshFunctionalOut()

Sent functional data to the external unit are taken from hardware buffer internal to the unit. A call to this method causes the content of the hardware buffer to be updated with the latest data from linked DataSource object.

synchronizeFunctional

public void synchronizeFunctional()

Initiate a synchronization operation for the functional data.

isSynchronizeFunctionalFinished

public boolean isSynchronizeFunctionalFinished()

Check whether the underlying transaction has been completed.

Returns:

true value if the transaction has been completed

setFunctionalInLink

public void setFunctionalInLink(DataSink destLink)

Set the functional input data link for the data converted from raw data level to customized data level.

setFunctionalInLink

public void setFunctionalInLink(DataSink destLink,
                                int i,
                                int j)

Set the functional input data link for the data converted from raw data level to customized data level. Links the j-th output of the Unit to the i-th input of a DataSink.

setFunctionalOutLink

public void setFunctionalOutLink(DataSource sourceLink)

Set the functional output data link for the data at customized data level.

setFunctionalOutLink

public void setFunctionalOutLink(DataSource sourceLink,
                                 int i,
                                 int j)

Set the functional output data link for the data at customized data level. Links the j-th input of the Unit to the i-th output of a DataSource.

setFunctionalInConverter

public void setFunctionalInConverter(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

setFunctionalOutConverter

public void setFunctionalOutConverter(AbstractControlChannel c)

Data conversion from customized data level (in the source buffers) to raw data level (in the hardware buffer) is done by a control channel object. This method allows the converter control channel for outgoing data 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