fr.esrf.tangoatk.core
Interface ICommand

All Superinterfaces:

IEntity, IRefreshee, java.io.Serializable, fr.esrf.TangoDs.TangoConst

All Known Implementing Classes:

ACommand, ArrayArrayCommand, ArrayScalarCommand, ArrayTableCommand, ArrayVoidCommand, BooleanVoidCommand, InvalidCommand, ScalarArrayCommand, ScalarScalarCommand, ScalarTableCommand, ScalarVoidCommand, StringVoidCommand, TableArrayCommand, TableScalarCommand, TableTableCommand, TableVoidCommand, VoidArrayCommand, VoidScalarCommand, VoidTableCommand, VoidVoidCommand

public interface ICommand
extends IEntity, fr.esrf.TangoDs.TangoConst

ICommand is the interface that defines a command. Generally speaking, to work with commands, one registers as a result listener throught the addResultListener, and calls the execute execute method that pleases you. The result of the command is delivered shortly after through the method resultChange in your IResultListener

See Also:

IResultListener

Field Summary

Fields inherited from interface fr.esrf.TangoDs.TangoConst

ACCESS_READ, ACCESS_SERVICE, ACCESS_WRITE, ARCHIVE_EVENT, ATT_CONF_EVENT, Attr_AdmName, Attr_Description, Attr_Name, Attr_State, Attr_Status, Attr_Unknown, ATTRIBUTE, BY_CLASS, BY_DEVICE, BY_PROCESS, CHANGE_EVENT, COMMAND, CONTROL_SYSTEM, DATA_READY_EVENT, DEFAULT_LOCK_VALIDITY, eventNames, LOGGING_CONSOLE_TARGET, LOGGING_CONSOLE_TARGET_ID, LOGGING_DEBUG, LOGGING_DEF_RFT, LOGGING_DEVICE_TARGET, LOGGING_DEVICE_TARGET_ID, LOGGING_ERROR, LOGGING_FATAL, LOGGING_FILE_TARGET, LOGGING_FILE_TARGET_ID, LOGGING_INFO, LOGGING_LEVELS, LOGGING_MAX_RFT, LOGGING_MIN_RFT, LOGGING_OFF, LOGGING_SEPARATOR, LOGGING_UNKNOWN_TARGET_ID, LOGGING_WARN, NO_SYNC, NOT_STATELESS, NotANumber, Op_BlackBox, Op_Command, Op_Command_2, Op_Command_inout, Op_Command_inout_2, Op_Command_inout_history_2, Op_Command_list, Op_Command_list_2, Op_Get_Attr_Config, Op_Get_Attr_Config_2, Op_Info, Op_Ping, Op_Read_Attr, Op_Read_Attr_2, Op_Read_Attr_history_2, Op_Set_Attr_Config, Op_Unknown, Op_Write_Attr, PERIODIC_EVENT, QUALITY_EVENT, Req_Attribute, Req_Operation, Req_Unknown, SERVICE_PROP_NAME, STATELESS, Tango_AllAttr, Tango_AllAttr_3, Tango_AlrmValueNotSpec, Tango_AssocWritNotSpec, Tango_AttrDataFormatName, Tango_CLNT_TIMEOUT, Tango_CmdArgTypeName, Tango_CONST_DEV_STRING, Tango_DbObjName, Tango_DEFAULT_POLL_OLD_FACTOR, Tango_DEFAULT_TIMEOUT, Tango_DEFAULT_TIMEOUT_SEC, Tango_DefaultBlackBoxDepth, Tango_DefaultDocUrl, Tango_DefaultPollRingDepth, Tango_DefaultWritableProp, Tango_DELTA_T, Tango_DescNotSet, Tango_DescNotSpec, Tango_DEV_BOOLEAN, Tango_DEV_CHAR, Tango_DEV_DOUBLE, Tango_DEV_ENCODED, Tango_DEV_FLOAT, Tango_DEV_INT, Tango_DEV_LONG, Tango_DEV_LONG64, Tango_DEV_SHORT, Tango_DEV_STATE, Tango_DEV_STRING, Tango_DEV_UCHAR, Tango_DEV_ULONG, Tango_DEV_ULONG64, Tango_DEV_USHORT, Tango_DEV_VOID, Tango_DevStateName, Tango_DEVVAR_CHARARRAY, Tango_DEVVAR_DOUBLEARRAY, Tango_DEVVAR_DOUBLESTRINGARRAY, Tango_DEVVAR_FLOATARRAY, Tango_DEVVAR_LONG64ARRAY, Tango_DEVVAR_LONGARRAY, Tango_DEVVAR_LONGSTRINGARRAY, Tango_DEVVAR_SHORTARRAY, Tango_DEVVAR_STRINGARRAY, Tango_DEVVAR_ULONG64ARRAY, Tango_DEVVAR_ULONGARRAY, Tango_DEVVAR_USHORTARRAY, Tango_DevVersion, Tango_DISCARD_THRESHOLD, Tango_DispUnitNotSpec, Tango_DSDeviceDomain, Tango_EXPERT_ATTR, Tango_EXPERT_CMD, Tango_FormatNotSpec, Tango_InitialOutput, Tango_LabelNotSpec, TANGO_LOG_PATH, Tango_MAX_TRANSFER_SIZE, Tango_MaxServerNameLength, Tango_MIN_POLL_PERIOD, Tango_OPERATOR_ATTR, Tango_OPERATOR_CMD, Tango_POLL_ADD_OBJ, Tango_POLL_ATTR, Tango_POLL_CMD, Tango_POLL_REM_DEV, Tango_POLL_REM_OBJ, Tango_POLL_START, Tango_POLL_STOP, Tango_POLL_UPD_PERIOD, Tango_PollAttribute, Tango_PollCommand, Tango_QualityName, Tango_REL_1, Tango_REL_2, Tango_ResNotDefined, Tango_StdUnitNotSpec, Tango_SysProperty, Tango_TG_IMP_MINOR_DEVFAILED, Tango_TG_IMP_MINOR_NON_DEVFAILED, Tango_TG_IMP_MINOR_TO, Tango_TgLibVers, Tango_UnitNotSpec, USER_EVENT

Method Summary

void	addResultListener(IResultListener listener) addResultListener adds a listener to the result of executing this command.
boolean	doesArrayOutput() doesArrayOutput returns true if this command does output in form of an array
boolean	doesOutput() doesOutput returns true if this command does ouput
void	execute() execute executes the command without input.
void	execute(java.util.List input) execute executes the command and uses the input in whatever way it feels appropriate.
java.lang.String	getInTypeDescription()
java.lang.String	getInTypeElemName() getInTypeElemName returns the type name of an element of the array if this command has an "array" input argument.
java.lang.String	getLevel()
java.lang.String	getOutTypeDescription()
java.lang.String	getOutTypeElemName()
java.lang.String	getTag()
void	removeResultListener(IResultListener listener) removeResultListener removes a listenener from this command
boolean	takesArrayInput() takesArrayInput returns true if this command takes array-input
boolean	takesInput() takesInput returns true if this command takes input
boolean	takesScalarInput() takesScalarInput return strue if this command takes scalar-input
boolean	takesTableInput() takesArrayInput returns true if this command takes array-input

Methods inherited from interface fr.esrf.tangoatk.core.IEntity

addErrorListener, getAlias, getDevice, getListenerList, getName, getNameSansDevice, getProperty, getPropertyMap, isExpert, isOperator, removeErrorListener, setAlias, storeConfig

Methods inherited from interface fr.esrf.tangoatk.core.IRefreshee

refresh

Method Detail

execute

void execute()

execute executes the command without input.

See Also:

execute(java.util.List input)

execute

void execute(java.util.List input)

execute executes the command and uses the input in whatever way it feels appropriate. Results are published to all listeners which have registered by calling addResultListener

Parameters:

input - a java.util.List value

addResultListener

void addResultListener(IResultListener listener)

addResultListener adds a listener to the result of executing this command.

Parameters:

listener - an IResultListener value

See Also:

IResultListener

removeResultListener

void removeResultListener(IResultListener listener)

removeResultListener removes a listenener from this command

Parameters:

listener - an IResultListener value

takesInput

boolean takesInput()

takesInput returns true if this command takes input

Returns:

a boolean value

takesArrayInput

boolean takesArrayInput()

takesArrayInput returns true if this command takes array-input

Returns:

a boolean value

takesTableInput

boolean takesTableInput()

takesArrayInput returns true if this command takes array-input

Returns:

a boolean value

takesScalarInput

boolean takesScalarInput()

takesScalarInput return strue if this command takes scalar-input

Returns:

a boolean value

doesOutput

boolean doesOutput()

doesOutput returns true if this command does ouput

Returns:

a boolean value

doesArrayOutput

boolean doesArrayOutput()

doesArrayOutput returns true if this command does output in form of an array

Returns:

a boolean value

getInTypeElemName

java.lang.String getInTypeElemName()

getInTypeElemName returns the type name of an element of the array if this command has an "array" input argument.

Returns:

an int value containing the in_type.

Throws:

NoSuchElementException - if no such property exists.

See Also:

TangoConst

getOutTypeElemName

java.lang.String getOutTypeElemName()

getInTypeDescription

java.lang.String getInTypeDescription()

getOutTypeDescription

java.lang.String getOutTypeDescription()

getLevel

java.lang.String getLevel()

getTag

java.lang.String getTag()