org.tango.server.command
Class CommandImpl

java.lang.Object
  org.tango.server.DeviceBehaviorObject
      org.tango.server.command.CommandImpl

All Implemented Interfaces:

java.lang.Comparable<CommandImpl>, IPollable

public final class CommandImpl
extends DeviceBehaviorObject
implements java.lang.Comparable<CommandImpl>, IPollable

Field Summary

static int	TANGO_EXPERT_CMD
static int	TANGO_OPERATOR_CMD

Constructor Summary

CommandImpl(ICommandBehavior behavior, java.lang.String deviceName)

Method Summary

void	addErrorToHistory(fr.esrf.Tango.DevFailed e)
void	addToHistory(java.lang.Object value)
int	compareTo(CommandImpl o)
void	configurePolling(int pollingPeriod)
boolean	equals(java.lang.Object obj)
java.lang.Object	execute(java.lang.Object dataIn) Execute the command.
ICommandBehavior	getBehavior()
double	getDeltaTime()
fr.esrf.Tango.DispLevel	getDisplayLevel()
double	getExecutionDuration()
CommandHistory	getHistory()
int	getInTangoType()
org.tango.command.CommandTangoType	getInType() Return the input parameter type.
java.lang.String	getInTypeDesc() Return the input parameter description.
java.lang.String	getLastDevFailed()
double	getLastUpdateTime()
java.lang.String	getName() Return the command name.
int	getOutTangoType()
org.tango.command.CommandTangoType	getOutType() Return the output parameter type.
java.lang.String	getOutTypeDesc() Return the output parameter description.
int	getPollingPeriod()
int	getPollRingDepth()
int	getTag()
int	hashCode()
boolean	isArginPrimitive()
boolean	isPolled()
void	resetPolling()
void	setDisplayLevel(fr.esrf.Tango.DispLevel level)
void	setPollingStats(double executionDuration, double lastUpdateTime, double deltaTime)
void	setPollRingDepth(int pollRingDepth)
java.lang.String	toString()
void	updatePollingConfigFromDB()

Methods inherited from class org.tango.server.DeviceBehaviorObject

getDeniedStates, getEndState, isAllowed, setDeniedStates, setEndState, setStateMachine

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TANGO_OPERATOR_CMD

public static final int TANGO_OPERATOR_CMD

See Also:

Constant Field Values

TANGO_EXPERT_CMD

public static final int TANGO_EXPERT_CMD

See Also:

Constant Field Values

Constructor Detail

CommandImpl

public CommandImpl(ICommandBehavior behavior,
                   java.lang.String deviceName)
            throws fr.esrf.Tango.DevFailed

Throws:

fr.esrf.Tango.DevFailed

Method Detail

execute

public java.lang.Object execute(java.lang.Object dataIn)
                         throws fr.esrf.Tango.DevFailed

Execute the command.

Throws:

fr.esrf.Tango.DevFailed

getName

public java.lang.String getName()

Return the command name.

Specified by:

getName in interface IPollable

Returns:

The command name

getInType

public org.tango.command.CommandTangoType getInType()

Return the input parameter type.

Returns:

The input parameter type

getInTangoType

public int getInTangoType()

isArginPrimitive

public boolean isArginPrimitive()

getOutType

public org.tango.command.CommandTangoType getOutType()

Return the output parameter type.

Returns:

The output parameter type

getOutTangoType

public int getOutTangoType()

getInTypeDesc

public java.lang.String getInTypeDesc()

Return the input parameter description.

Returns:

The input parameter description

getOutTypeDesc

public java.lang.String getOutTypeDesc()

Return the output parameter description.

Returns:

The output parameter description

getTag

public int getTag()

getDisplayLevel

public fr.esrf.Tango.DispLevel getDisplayLevel()

setDisplayLevel

public void setDisplayLevel(fr.esrf.Tango.DispLevel level)

addToHistory

public void addToHistory(java.lang.Object value)
                  throws fr.esrf.Tango.DevFailed

Throws:

fr.esrf.Tango.DevFailed

addErrorToHistory

public void addErrorToHistory(fr.esrf.Tango.DevFailed e)
                       throws fr.esrf.Tango.DevFailed

Throws:

fr.esrf.Tango.DevFailed

getHistory

public CommandHistory getHistory()

toString

public java.lang.String toString()

Overrides:

toString in class DeviceBehaviorObject

Returns:

a string

getBehavior

public ICommandBehavior getBehavior()

getPollingPeriod

public int getPollingPeriod()

Specified by:

getPollingPeriod in interface IPollable

isPolled

public boolean isPolled()

Specified by:

isPolled in interface IPollable

configurePolling

public void configurePolling(int pollingPeriod)
                      throws fr.esrf.Tango.DevFailed

Specified by:

configurePolling in interface IPollable

Throws:

fr.esrf.Tango.DevFailed

resetPolling

public void resetPolling()
                  throws fr.esrf.Tango.DevFailed

Specified by:

resetPolling in interface IPollable

Throws:

fr.esrf.Tango.DevFailed

updatePollingConfigFromDB

public void updatePollingConfigFromDB()
                               throws fr.esrf.Tango.DevFailed

Throws:

fr.esrf.Tango.DevFailed

compareTo

public int compareTo(CommandImpl o)

Specified by:

compareTo in interface java.lang.Comparable<CommandImpl>

getPollRingDepth

public int getPollRingDepth()

Specified by:

getPollRingDepth in interface IPollable

setPollRingDepth

public void setPollRingDepth(int pollRingDepth)

Specified by:

setPollRingDepth in interface IPollable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getExecutionDuration

public double getExecutionDuration()

Specified by:

getExecutionDuration in interface IPollable

getLastUpdateTime

public double getLastUpdateTime()

Specified by:

getLastUpdateTime in interface IPollable

getDeltaTime

public double getDeltaTime()

Specified by:

getDeltaTime in interface IPollable

setPollingStats

public void setPollingStats(double executionDuration,
                            double lastUpdateTime,
                            double deltaTime)

Specified by:

setPollingStats in interface IPollable

getLastDevFailed

public java.lang.String getLastDevFailed()

Specified by:

getLastDevFailed in interface IPollable