fr.esrf.tangoatk.core
Interface IEntity

All Superinterfaces:

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

All Known Subinterfaces:

IAttribute, IBooleanImage, IBooleanScalar, IBooleanSpectrum, ICommand, IDevStateScalar, IDevStateSpectrum, IEnumScalar, INumber, INumberImage, INumberScalar, INumberSpectrum, IRawImage, IScalarAttribute, IStringImage, IStringScalar, IStringSpectrum

All Known Implementing Classes:

AAttribute, ACommand, ANumber, ArrayArrayCommand, ArrayScalarCommand, ArrayTableCommand, ArrayVoidCommand, BooleanImage, BooleanScalar, BooleanSpectrum, BooleanVoidCommand, DevStateScalar, DevStateSpectrum, EnumScalar, InvalidAttribute, InvalidCommand, NumberImage, NumberScalar, NumberSpectrum, RawImage, ScalarArrayCommand, ScalarScalarCommand, ScalarTableCommand, ScalarVoidCommand, StringImage, StringScalar, StringSpectrum, StringVoidCommand, TableArrayCommand, TableScalarCommand, TableTableCommand, TableVoidCommand, VoidArrayCommand, VoidScalarCommand, VoidTableCommand, VoidVoidCommand

public interface IEntity
extends fr.esrf.TangoDs.TangoConst, IRefreshee, java.io.Serializable

IEntity is the basic, uh, entity in TangoATK. Normally it is incarnated as an AAttribute or a ACommand or one of their subclasses. This inteface is created so that the operations which are common to both the Commands and Attributes can be handled by the same code.

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	addErrorListener(IErrorListener listener) An IErrorListener is an object that listens to error property changes from this object.
java.lang.String	getAlias()
Device	getDevice() getDevice returns the device this IEntity belongs to.
AtkEventListenerList	getListenerList()
java.lang.String	getName() Gets the name of this IEntity
java.lang.String	getNameSansDevice()
Property	getProperty(java.lang.String name) getProperty returns property with the name given in the first parameter.
java.util.Map	getPropertyMap() getPropertyMap returns a Map containing this entitys properties.
boolean	isExpert()
boolean	isOperator()
void	removeErrorListener(IErrorListener listener) Removes the given IErrorListener from this objects list of errorlisteners.
void	setAlias(java.lang.String alias)
void	storeConfig()

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

refresh

Method Detail

getName

java.lang.String getName()

Gets the name of this IEntity

Returns:

String the name of the IEntity

getNameSansDevice

java.lang.String getNameSansDevice()

getProperty

Property getProperty(java.lang.String name)

getProperty returns property with the name given in the first parameter.

Parameters:

name - a String value

Returns:

an Property value

getPropertyMap

java.util.Map getPropertyMap()

getPropertyMap returns a Map containing this entitys properties.

Returns:

a Map value

addErrorListener

void addErrorListener(IErrorListener listener)

An IErrorListener is an object that listens to error property changes from this object.

Parameters:

listener - an IErrorListener value

removeErrorListener

void removeErrorListener(IErrorListener listener)

Removes the given IErrorListener from this objects list of errorlisteners.

Parameters:

listener - an IErrorListener value

getDevice

Device getDevice()

getDevice returns the device this IEntity belongs to.

Returns:

a fr.esrf.tangoatk.core.Device value

storeConfig

void storeConfig()

setAlias

void setAlias(java.lang.String alias)

getAlias

java.lang.String getAlias()

isOperator

boolean isOperator()

isExpert

boolean isExpert()

getListenerList

AtkEventListenerList getListenerList()