Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.TelecommandManagement
Class TelemetryFormatTransactionTelecommand

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.TelecommandManagement.Telecommand
              |
              +--RtjAocsFramework.TelecommandManagement.TransactionTelecommand
                    |
                    +--RtjAocsFramework.TelecommandManagement.TelemetryFormatTransactionTelecommand

public class TelemetryFormatTransactionTelecommand
extends TransactionTelecommand

Transaction telecommand to command the telemetry format of a component.

Copyright: see the Copyright Notice.

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

Constructor Summary
TelemetryFormatTransactionTelecommand(int timeTag, Telemeterable t, byte newFormat)
          Create the telecommand object by specifying the time tag, the target telemeterable object and the target telemetry format.
 
Method Summary
 short execute()
          Change the telemetry format of the target telemeterable object and check that the change was correctly performed.
 short unExecute()
          Restore the telemetry format of the target telemeterable object and check that the restore operation was correctly performed.
 
Methods inherited from class RtjAocsFramework.TelecommandManagement.TransactionTelecommand
canExecute, getNextTransactionTelecommand, getPreviousTransactionTelecommand, getTelecommandManager, isEnabled, setNextTransactionTelecommand, setPreviousTransactionTelecommand, setTelecommandManager
 
Methods inherited from class RtjAocsFramework.TelecommandManagement.Telecommand
getTelecommandId, getTelecommandTypeId, getTimeTag, setEnable
 
Methods inherited from class RtjAocsFramework.BasicObjects.RootObject
getClassId, getInstanceId, setClassId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TelemetryFormatTransactionTelecommand

public TelemetryFormatTransactionTelecommand(int timeTag,
                                             Telemeterable t,
                                             byte newFormat)
Create the telecommand object by specifying the time tag, the target telemeterable object and the target telemetry format.

Method Detail

execute

public short execute()
Change the telemetry format of the target telemeterable object and check that the change was correctly performed. If the telemetry format was not correctly updated, the telecommand is unExecuted.

Overrides:
execute in class TransactionTelecommand
See Also:
Telecommand.execute()

unExecute

public short unExecute()
Restore the telemetry format of the target telemeterable object and check that the restore operation was correctly performed.

Overrides:
unExecute in class TransactionTelecommand

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