|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface DeviceData for fixed data about accelerator devices. Included is information about related devices.
Some of the information for connecting to the device may be site-specific. The site-specific variable names can be obtained with getSpecialvariableNames and their instance values with getSpecialValue(variableName).
A DeviceData object can be obtained with
DirectoryService#getDeviceData(deviceName).
An array of DeviceData objects in a devicelist can be obtained with
DirectoryService#getDeviceData.
General documentation in DirectoryService .
DeviceData
,
DeviceClass
,
DeviceList
Method Summary | |
java.lang.String |
getClassName()
Gets the name of the device class. |
DeviceClass |
getDeviceClass()
Gets the device class object. |
java.lang.String[] |
getRelatedDevices(java.lang.String role)
Gets array of names of related devices for the role. |
java.lang.String[] |
getRoles()
Gets array of role names (prefix "~" for inverse role). |
java.lang.String |
getSpecialValue(java.lang.String specialVariableName)
Gets value for an implementation-specific variable as a string. |
java.lang.String[] |
getSpecialVariableNames()
Gets the names of implementation-specific variables. |
boolean |
isDefined(java.lang.String role)
Returns true if this device has the role (prefix "~" for inverse role). |
boolean |
needCycleType()
Return true when the device depends on the cycle type. |
Methods inherited from interface cdev.dir.DirectoryItem |
getDescription,
getInfo,
getInfoLines,
getInfoWidth,
getName,
getServiceName,
toString |
Method Detail |
public java.lang.String getClassName()
public DeviceClass getDeviceClass() throws NoSuchDataException, BadConnectionException, TooManyValuesException
public java.lang.String[] getRelatedDevices(java.lang.String role) throws NoSuchDataException, BadConnectionException
role
- the name of the role (may have prefix ~ for passive role).public java.lang.String[] getRoles() throws NoSuchDataException, BadConnectionException
public java.lang.String getSpecialValue(java.lang.String specialVariableName) throws NoSuchDataException, BadConnectionException
SpecialVariableName
- the name of an application-specific variable.public java.lang.String[] getSpecialVariableNames() throws NoSuchDataException, BadConnectionException
public boolean isDefined(java.lang.String role) throws BadConnectionException
role
- the name of the role (may have prefix ~ for passive role).public boolean needCycleType()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |