public interface IEfferentCommand extends ISensoryObject, java.io.Serializable
IEfferentObject
.
It must implement a single arg constructor with IIdentifier
as the identifier
of the command. This is so that they can be instantiated on remote sides correctly.Modifier and Type | Interface and Description |
---|---|
static class |
IEfferentCommand.ActualState |
static class |
IEfferentCommand.RequestedState |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTUAL_STATE |
static java.lang.String |
COMMAND_CLASS_NAME |
static java.lang.String |
EFFERENT_ID |
static java.lang.String |
ESTIMATED_DURATION |
static java.lang.String |
IS_ADJUSTABLE |
static java.lang.String |
REQUESTED_START_TIME |
static java.lang.String |
REQUESTED_STATE |
static java.lang.String |
RESULT |
Modifier and Type | Method and Description |
---|---|
IEfferentCommand.ActualState |
getActualState() |
ISensoryIdentifier |
getEfferentIdentifier()
the efferent object that this command is operating on
|
double |
getEstimatedDuration() |
double |
getRequestedStartTime() |
IEfferentCommand.RequestedState |
getRequestedState() |
java.lang.Object |
getResult()
what happend to interrupt the command or some outcome
of the command
|
boolean |
isAdjustable()
adjustable commands can be modified by the issuer after it has already
started.
|
IEfferentCommand.ActualState |
waitForActualStateChange(IEfferentCommand.ActualState waitWhileState)
will block until the state is not waitWhileState
|
getIdentifier
getProperties, getProperty, getPropertyMap, hasProperty
static final java.lang.String REQUESTED_STATE
static final java.lang.String ACTUAL_STATE
static final java.lang.String RESULT
static final java.lang.String EFFERENT_ID
static final java.lang.String COMMAND_CLASS_NAME
static final java.lang.String ESTIMATED_DURATION
static final java.lang.String REQUESTED_START_TIME
static final java.lang.String IS_ADJUSTABLE
ISensoryIdentifier getEfferentIdentifier()
IEfferentCommand.RequestedState getRequestedState()
IEfferentCommand.ActualState getActualState()
java.lang.Object getResult()
double getEstimatedDuration()
double getRequestedStartTime()
IEfferentCommand.ActualState waitForActualStateChange(IEfferentCommand.ActualState waitWhileState) throws java.lang.InterruptedException
waitWhileState
- java.lang.InterruptedException
boolean isAdjustable()