|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectfr.esrf.tangoatk.core.attribute.AAttribute
public abstract class AAttribute
| Field Summary | |
|---|---|
protected java.lang.String |
alias
|
protected boolean |
attPropertiesLoaded
|
protected fr.esrf.TangoApi.DeviceAttribute |
attribute
|
protected long |
changeCount
|
protected fr.esrf.TangoApi.AttributeInfoEx |
config
|
protected Device |
device
|
protected java.lang.String |
error
|
protected fr.esrf.Tango.DevFailed |
eventError
|
protected java.lang.String |
name
|
protected java.lang.String |
nameSansDevice
|
protected long |
periodicCount
|
protected EventSupport |
propChanges
|
protected PropertyStorage |
propertyStorage
|
protected long |
refreshCount
|
protected boolean |
skippingRefresh
|
protected java.lang.String |
state
|
protected AtkTimer |
timer
|
protected long |
timeStamp
|
| Fields inherited from interface fr.esrf.tangoatk.core.IAttribute |
|---|
ALARM, CHANGING, INVALID, OK, UNKNOWN, VALID, WARNING |
| 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 |
| Constructor Summary | |
|---|---|
protected |
AAttribute()
|
| Method Summary | |
|---|---|
void |
addErrorListener(IErrorListener l)
An IErrorListener is an object that listens to
error property changes from this object. |
void |
addSetErrorListener(ISetErrorListener l)
An ISetErrorListener is an object that listens to
setting error property changes from this sttribute. |
void |
addStateListener(IAttributeStateListener l)
addStateListener adds a listener to state-changes
for this attribute. |
boolean |
areAttPropertiesLoaded()
areAttPropertiesLoaded returns true if the some ATK specific attribute properties have already
been loaded from the Tango DB. |
protected void |
checkDimensions(boolean[][] o)
|
protected void |
checkDimensions(double[][] o)
|
protected void |
checkDimensions(java.lang.Object[][] o)
|
static java.lang.String[] |
flatten(java.lang.String[][] src)
|
void |
freeInternalData()
|
java.lang.String |
getAlias()
|
fr.esrf.TangoApi.DeviceAttribute |
getAttribute()
getAttribute returns the lowlevel attribute of this
attribute. |
long |
getChangeCount()
|
java.lang.String |
getDescription()
getDescription returns the description of this attribute. |
Device |
getDevice()
getDevice returns the device this IEntity belongs to. |
fr.esrf.TangoApi.DeviceAttribute |
getDeviceAttribute()
|
java.lang.String |
getDisplayUnit()
getDisplayUnit returns the display unit of this attribute |
double |
getDisplayUnitFactor()
getDisplayUnitFactor returns the DisplayUnit Multiplication factor of this attribute. |
java.lang.String |
getFormat()
getFormat returns the human readable representation
of the format of this attribute. |
int |
getHeight()
getHeight alias for getYDimension() |
java.lang.String |
getLabel()
getLabel returns the label of this attribute. |
int |
getLevel()
|
AtkEventListenerList |
getListenerList()
|
int |
getMaxXDimension()
getMaxXDimension returns the max x-dimension of the
attribute |
int |
getMaxYDimension()
getMaxYDimension returns the max y-dimension of the
attribute |
java.lang.String |
getName()
Gets the name of this IEntity |
java.lang.String |
getNameSansDevice()
|
long |
getPeriodicCount()
|
EventSupport |
getPropChanges()
|
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. |
static java.lang.String[] |
getPropertyNames()
|
PropertyStorage |
getPropertyStorage()
|
long |
getRefreshCount()
|
java.lang.String |
getStandardUnit()
getStandardUnit returns the standard unit of this attribute |
double |
getStandardUnitFactor()
getStandardUnitFactor returns the standard unit of this attribute. |
java.lang.String |
getState()
getState returns a human-readable representation of
the state. |
java.lang.String |
getSubscriptionError()
Returns a string that describe the error which occurs during event subscription. |
fr.esrf.Tango.AttrDataFormat |
getTangoDataFormat()
getTangoDataFormat returns the data format of this
attribute. |
int |
getTangoDataType()
getTangoDataType returns the type of this attribute. |
java.lang.String |
getType()
getType returns a human-readable representaion of the
type of this attribute. |
java.lang.String |
getUnit()
getUnit returns the unit of this attribute. |
java.lang.String |
getVersion()
|
int |
getWidth()
getWidth alias for getXDimension() |
int |
getXDimension()
getXDimension returns the actual x-dimension of the
attribute. |
int |
getYDimension()
getYDimension returns the actual y-dimension of the
attribute |
boolean |
hasEvents()
hasEvents returns true if the attribute is refreshed by event system |
protected void |
init(Device d,
java.lang.String name,
fr.esrf.TangoApi.AttributeInfoEx config,
boolean doEvent)
|
boolean |
isExpert()
|
boolean |
isOperator()
|
boolean |
isSkippingRefresh()
|
boolean |
isWritable()
isWritable returns true if this attribute is writable |
void |
loadAttProperties()
Method used by some attribute viewers to force the reading of some specific at setModel(). |
protected void |
readAttError(java.lang.String s,
java.lang.Throwable t)
|
protected fr.esrf.TangoApi.DeviceDataHistory[] |
readAttHistoryFromNetwork()
|
protected fr.esrf.TangoApi.DeviceAttribute |
readDeviceValueFromNetwork()
|
protected fr.esrf.TangoApi.DeviceAttribute |
readValueFromNetwork()
|
void |
removeErrorListener(IErrorListener l)
Removes the given IErrorListener from this objects
list of errorlisteners. |
void |
removeSetErrorListener(ISetErrorListener l)
Removes a setErrorListener. |
void |
removeStateListener(IAttributeStateListener l)
removeStateListener removes a listener to state-changes
for this attribute. |
protected void |
serializeInit()
|
void |
setAlias(java.lang.String alias)
|
protected void |
setAttError(java.lang.String s,
java.lang.Throwable t)
|
protected void |
setConfiguration(fr.esrf.TangoApi.AttributeInfoEx c)
|
void |
setDescription(java.lang.String desc)
setDescription sets the description of this attribute |
void |
setDevice(Device d)
|
void |
setLabel(java.lang.String label)
setLabel sets the label of this attribute |
void |
setName(java.lang.String s)
setName sets the name of this attribute. |
void |
setProperty(java.lang.String name,
java.lang.Number value)
setProperty |
void |
setProperty(java.lang.String name,
java.lang.Number value,
boolean editable)
setProperty |
void |
setPropertyStorage(PropertyStorage propertyStorage)
|
void |
setSkippingRefresh(boolean b)
Setting this property to true means that the attribute should not read nor distribute new values when its refresh is called |
protected void |
setState()
|
protected void |
setState(fr.esrf.TangoApi.DeviceAttribute da)
|
protected void |
setState(java.lang.String s)
|
void |
storeConfig()
|
java.lang.String |
toString()
|
protected void |
writeAtt()
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface fr.esrf.tangoatk.core.IAttribute |
|---|
dispatch, dispatchError |
| Methods inherited from interface fr.esrf.tangoatk.core.IRefreshee |
|---|
refresh |
| Methods inherited from interface fr.esrf.TangoApi.events.ITangoPeriodicListener |
|---|
periodic |
| Methods inherited from interface fr.esrf.TangoApi.events.ITangoChangeListener |
|---|
change |
| Field Detail |
|---|
protected transient fr.esrf.TangoApi.AttributeInfoEx config
protected PropertyStorage propertyStorage
protected EventSupport propChanges
protected Device device
protected fr.esrf.TangoApi.DeviceAttribute attribute
protected java.lang.String error
protected java.lang.String nameSansDevice
protected java.lang.String name
protected transient AtkTimer timer
protected java.lang.String state
protected long timeStamp
protected boolean skippingRefresh
protected java.lang.String alias
protected long refreshCount
protected long changeCount
protected long periodicCount
protected fr.esrf.Tango.DevFailed eventError
protected boolean attPropertiesLoaded
| Constructor Detail |
|---|
protected AAttribute()
| Method Detail |
|---|
public java.lang.String getVersion()
protected void serializeInit()
throws java.io.IOException
java.io.IOException
protected void init(Device d,
java.lang.String name,
fr.esrf.TangoApi.AttributeInfoEx config,
boolean doEvent)
public boolean hasEvents()
IAttributehasEvents returns true if the attribute is refreshed by event system
hasEvents in interface IAttributepublic long getRefreshCount()
public long getChangeCount()
public long getPeriodicCount()
public java.lang.String getSubscriptionError()
public fr.esrf.TangoApi.DeviceAttribute getDeviceAttribute()
public java.lang.String toString()
toString in class java.lang.Objectpublic EventSupport getPropChanges()
public java.lang.String getType()
IAttributegetType returns a human-readable representaion of the
type of this attribute.
getType in interface IAttributeString valuepublic int getTangoDataType()
IAttributegetTangoDataType returns the type of this attribute.
getTangoDataType in interface IAttributeint valuepublic fr.esrf.Tango.AttrDataFormat getTangoDataFormat()
IAttributegetTangoDataFormat returns the data format of this
attribute.
getTangoDataFormat in interface IAttributeAttrDataFormat valuepublic void storeConfig()
storeConfig in interface IEntitypublic java.lang.String getFormat()
IAttributegetFormat returns the human readable representation
of the format of this attribute. To obtain the numeric code of the
format, please consult getPropertyMap("format");
getFormat in interface IAttributeString valuepublic void addErrorListener(IErrorListener l)
IEntityIErrorListener is an object that listens to
error property changes from this object.
addErrorListener in interface IEntityl - an IErrorListener valuepublic void removeErrorListener(IErrorListener l)
IEntityIErrorListener from this objects
list of errorlisteners.
removeErrorListener in interface IEntityl - an IErrorListener valuepublic void addSetErrorListener(ISetErrorListener l)
IAttributeISetErrorListener is an object that listens to
setting error property changes from this sttribute.
addSetErrorListener in interface IAttributel - an ISetErrorListener valuepublic void removeSetErrorListener(ISetErrorListener l)
IAttributeISetErrorListener is an object that listens to
setting error property changes from this attribute.
removeSetErrorListener in interface IAttributel - an ISetErrorListener valuepublic void addStateListener(IAttributeStateListener l)
IAttributeaddStateListener adds a listener to state-changes
for this attribute.
addStateListener in interface IAttributel - an IAttributeStateListener valuepublic void removeStateListener(IAttributeStateListener l)
IAttributeremoveStateListener removes a listener to state-changes
for this attribute.
removeStateListener in interface IAttributel - an IAttributeStateListener valuepublic void setDevice(Device d)
public Device getDevice()
IEntitygetDevice returns the device this IEntity belongs to.
getDevice in interface IEntityfr.esrf.tangoatk.core.Device value
protected void readAttError(java.lang.String s,
java.lang.Throwable t)
protected void setAttError(java.lang.String s,
java.lang.Throwable t)
public java.lang.String getUnit()
IAttributegetUnit returns the unit of this attribute.
getUnit in interface IAttributeString valuepublic java.lang.String getStandardUnit()
IAttributegetStandardUnit returns the standard unit of this attribute
getStandardUnit in interface IAttributeString valuepublic double getStandardUnitFactor()
IAttributegetStandardUnitFactor returns the standard unit of this attribute.
The standard unit is the value which must be multiplied with the
value of the attribute to obtain the value in a unit conforming to
the standard metric system.
getStandardUnitFactor in interface IAttributedouble valuepublic java.lang.String getDisplayUnit()
IAttributegetDisplayUnit returns the display unit of this attribute
getDisplayUnit in interface IAttributeString valuepublic double getDisplayUnitFactor()
IAttributegetDisplayUnitFactor returns the DisplayUnit Multiplication factor of this attribute.
The display unit factor is the value which must be multiplied with the
value of the attribute (returned by the device server) to obtain the value
which should be displayed (the value converted into display unit).
All the Number Change Events inside ATK and the Viewers use the value converted into
the display unit.
getDisplayUnitFactor in interface IAttributedouble value
returns 1.0 if the attribute property "display_unit" is not defined or has an invalid value
returns the value defined by the attribute property "display_unit".public java.lang.String getLabel()
IAttributegetLabel returns the label of this attribute.
getLabel in interface IAttributeString valuepublic void setLabel(java.lang.String label)
IAttributesetLabel sets the label of this attribute
setLabel in interface IAttributelabel - a String valuepublic void setName(java.lang.String s)
IAttributesetName sets the name of this attribute.
setName in interface IAttributes - a String valuepublic void setDescription(java.lang.String desc)
IAttributesetDescription sets the description of this attribute
setDescription in interface IAttributedesc - a String valuepublic java.lang.String getDescription()
IAttributegetDescription returns the description of this attribute.
getDescription in interface IAttributeString valuepublic int getLevel()
public boolean isOperator()
isOperator in interface IEntitypublic boolean isExpert()
isExpert in interface IEntityprotected void setConfiguration(fr.esrf.TangoApi.AttributeInfoEx c)
public static java.lang.String[] getPropertyNames()
public java.lang.String getAlias()
getAlias in interface IEntitypublic void setAlias(java.lang.String alias)
setAlias in interface IEntitypublic java.lang.String getName()
IEntityIEntity
getName in interface IEntityString the name of the IEntitypublic java.lang.String getNameSansDevice()
getNameSansDevice in interface IEntitypublic boolean isWritable()
IAttributeisWritable returns true if this attribute is writable
isWritable in interface IAttributeboolean value
protected final fr.esrf.TangoApi.DeviceAttribute readValueFromNetwork()
throws fr.esrf.Tango.DevFailed
fr.esrf.Tango.DevFailed
protected final fr.esrf.TangoApi.DeviceAttribute readDeviceValueFromNetwork()
throws fr.esrf.Tango.DevFailed
fr.esrf.Tango.DevFailed
protected void setState()
throws fr.esrf.Tango.DevFailed
fr.esrf.Tango.DevFailed
protected void setState(fr.esrf.TangoApi.DeviceAttribute da)
throws fr.esrf.Tango.DevFailed
fr.esrf.Tango.DevFailedpublic fr.esrf.TangoApi.DeviceAttribute getAttribute()
IAttributegetAttribute returns the lowlevel attribute of this
attribute.
getAttribute in interface IAttributeDeviceAttribute valueprotected void setState(java.lang.String s)
public java.lang.String getState()
IAttributegetState returns a human-readable representation of
the state.
getState in interface IAttributeString value
protected void writeAtt()
throws fr.esrf.Tango.DevFailed
fr.esrf.Tango.DevFailedpublic int getMaxXDimension()
IAttributegetMaxXDimension returns the max x-dimension of the
attribute
getMaxXDimension in interface IAttributeint valuepublic int getMaxYDimension()
IAttributegetMaxYDimension returns the max y-dimension of the
attribute
getMaxYDimension in interface IAttributeint valuepublic int getYDimension()
IAttributegetYDimension returns the actual y-dimension of the
attribute
getYDimension in interface IAttributeint valuepublic int getHeight()
IAttributegetHeight alias for getYDimension()
getHeight in interface IAttributeint valuepublic int getXDimension()
IAttributegetXDimension returns the actual x-dimension of the
attribute.
getXDimension in interface IAttributeint valuepublic int getWidth()
IAttributegetWidth alias for getXDimension()
getWidth in interface IAttributeint valuepublic void setSkippingRefresh(boolean b)
IAttribute
setSkippingRefresh in interface IAttributepublic boolean isSkippingRefresh()
isSkippingRefresh in interface IAttributeprotected void checkDimensions(java.lang.Object[][] o)
protected void checkDimensions(double[][] o)
protected void checkDimensions(boolean[][] o)
public static java.lang.String[] flatten(java.lang.String[][] src)
protected final fr.esrf.TangoApi.DeviceDataHistory[] readAttHistoryFromNetwork()
throws fr.esrf.Tango.DevFailed
fr.esrf.Tango.DevFailedpublic AtkEventListenerList getListenerList()
getListenerList in interface IEntitypublic void freeInternalData()
public Property getProperty(java.lang.String name)
getProperty returns property with the name given in the
first parameter.
getProperty in interface IEntityname - a String value
Property valuepublic java.util.Map getPropertyMap()
getPropertyMap returns a Map containing this entitys
properties.
getPropertyMap in interface IEntityMap value
public void setProperty(java.lang.String name,
java.lang.Number value)
setProperty
setProperty in interface IAttributename - a String value containing the name of the
propertyn - a Number value containing the numeric value of
the property
public void setProperty(java.lang.String name,
java.lang.Number value,
boolean editable)
setProperty
setProperty in interface IAttributename - a String value containing the name of the
propertyn - a Number value containing the value of the
propertyeditable - a boolean value which decides if the property
is editable or not.public PropertyStorage getPropertyStorage()
public void setPropertyStorage(PropertyStorage propertyStorage)
public boolean areAttPropertiesLoaded()
IAttributeareAttPropertiesLoaded returns true if the some ATK specific attribute properties have already
been loaded from the Tango DB. One example for these ATK specific attribute properties is : OpenCloseInverted for a DevStateScalar
attribute
areAttPropertiesLoaded in interface IAttributepublic void loadAttProperties()
IAttribute
loadAttProperties in interface IAttribute
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||