Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.UnitManagement
Class ResetCommand

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.UnitManagement.ResetCommand
All Implemented Interfaces:
UnitCommand

public class ResetCommand
extends RootObject
implements UnitCommand

The ResetCommand class represents default implementation of a reset command for smart units or for any external units.

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Vaclav Cechticky (IfA ETHZ), Alessandro Pasetti (University of Konstanz)
See Also:
Unit Framelet Document

Constructor Summary
ResetCommand()
          Create a new ResetCommand object.
 
Method Summary
 void execute()
          A call of this method causes that the actions associated to the reset commnad will be executed.
 boolean getIterationFlag()
          Return a value of the iteration flag.
 void setIterationFlag(boolean iFlag)
          Set a value of the iteration flag.
 void setUnit(Unit u)
          Set an unit that on which the reset command will be executed..
 
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

ResetCommand

public ResetCommand()
Create a new ResetCommand object.

Method Detail

execute

public void execute()
A call of this method causes that the actions associated to the reset commnad will be executed.

Specified by:
execute in interface UnitCommand

getIterationFlag

public boolean getIterationFlag()
Return a value of the iteration flag.

Specified by:
getIterationFlag in interface UnitCommand
Returns:
the false value if the the commnad is executed only once, the true value if is executed at each UnitManager invocation

setIterationFlag

public void setIterationFlag(boolean iFlag)
Set a value of the iteration flag.

Specified by:
setIterationFlag in interface UnitCommand
Parameters:
iFlag - value of the iteration flag, the false value if the the commnad has to be executed only once, the true value if is executed at each UnitManager invocation

setUnit

public void setUnit(Unit u)
Set an unit that on which the reset command will be executed..

Parameters:
u - a particular unit

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