Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.TelecommandManagement
Class ModeChangeTelecommand

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

public class ModeChangeTelecommand
extends Telecommand

Telecommand to command a change in the operational mode of a mode manager.

Copyright: see the Copyright Notice.

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

Constructor Summary
ModeChangeTelecommand(int timeTag, ModeManager m, int newMode)
          Create the telecommand object by specifying the time tag, the target mode manager and the new operational mode.
 
Method Summary
 short execute()
          Change the mode of the target mode manager and check the mode change was correctly performed.
 
Methods inherited from class RtjAocsFramework.TelecommandManagement.Telecommand
canExecute, getTelecommandId, getTelecommandTypeId, getTimeTag, isEnabled, 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

ModeChangeTelecommand

public ModeChangeTelecommand(int timeTag,
                             ModeManager m,
                             int newMode)
Create the telecommand object by specifying the time tag, the target mode manager and the new operational mode.

Method Detail

execute

public short execute()
Change the mode of the target mode manager and check the mode change was correctly performed. If the mode change was not successful a FAIL_SAFE code is returned.

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

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