RtjAocsFramework.UnitManagement
Class TestAnalogActuator

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.UnitManagement.Unit
                    |
                    +--RtjAocsFramework.UnitManagement.TestAnalogActuator

All Implemented Interfaces:

Configurable, DataSink, DataSource, Resettable, Telemeterable, UnitFunctional, UnitHousekeeping

public class TestAnalogActuator

extends Unit

Dummy analog actuator component developed as an example of the particular actuator implementation. Since the actuator is in this case fictitious unit, the output value is not used by any external device.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

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

See Also:

Unit Framelet Document

Field Summary

Fields inherited from class RtjAocsFramework.UnitManagement.Unit

fcDestInput, fcDestLink, fcHwInpBuf, fcHwOutBuf, hkDestInput, hkDestLink, hkHwInpBuf

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

TestAnalogActuator()
Create a new AnalogActuator object.

Method Summary

void	acquireFunctionalData() Initiate the transaction(s) for the acquisition of functional data from the unit.
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.
int	getTelemetryImageLength() Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.
void	initialize() Initialization of the unit.
boolean	isAcquireTransactionFinished() The method returns the completion status of the acquisition.
boolean	isConfigured() Check the analog sensor configuration.
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	isSendTransactionFinished() The method returns the completion status of the send transaction.
boolean	isSwitchedOn() Retrieve the power status of the unit.
boolean	isSynchronizeFunctionalFinished() Check whether the underlying transaction has been completed.
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	reset() Reset super object state and performs a local reset.
void	resetUnit() Reset the external unit.
void	sendFunctionalData() Initiate the transaction(s) to send the functional data to the unit.
void	switchOff() Switch off the unit.
void	switchOn() Switch on the unit.
void	synchronizeFunctional() Initiate a synchronization operation for the functional data.
void	synchronizeHousekeeping() Initiate a synchronization operation for the housekeeping data
void	writeToTelemetry(TelemetryStream stream) Causes the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.UnitManagement.Unit

getNumberOfInputs, getNumberOfOutputs, getOutput, getType, refreshFunctionalIn, refreshFunctionalOut, resetConfiguration, setFunctionalInConverter, setFunctionalInLink, setFunctionalInLink, setFunctionalOutConverter, setFunctionalOutLink, setFunctionalOutLink, setHkBufferSize, setHousekeepingConverter, setHousekeepingLink, setHousekeepingLink, setInBufferSize, setInput, setOutBufferSize

Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject

addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat

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

Constructor Detail

TestAnalogActuator

public TestAnalogActuator()

Create a new AnalogActuator object.

Method Detail

isConfigured

public boolean isConfigured()

Check the analog sensor configuration. The check consists only in testing a configuration of the super class "Unit".

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class Unit

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 Unit

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()

Initialization of the unit.

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.

Specified by:

refreshHousekeepingIn in interface UnitHousekeeping

Overrides:

refreshHousekeepingIn in class Unit

synchronizeHousekeeping

public void synchronizeHousekeeping()

Initiate a synchronization operation for the housekeeping data

isSynchronizeHousekeepingFinished

public boolean isSynchronizeHousekeepingFinished()

Check whether the underlying transaction has been completed.

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. Since the actuator is in the fictitious unit, the output value is not used by any external device.

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

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

getTelemetryImageLength

public int getTelemetryImageLength()

Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.

Specified by:

getTelemetryImageLength in interface Telemeterable

Overrides:

getTelemetryImageLength in class Unit

Returns:

the length in bits of the telemetry image

writeToTelemetry

public void writeToTelemetry(TelemetryStream stream)

Causes the object to write its own state to the telemetry stream.

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class Unit

Parameters:

stream - the telemetry stream