public interface ILinkData
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TINE_MISSING_ADDRESS
Message: No TINE address found.
|
Modifier and Type | Method and Description |
---|---|
void |
cancelAllLinks(IEDeviceGroup[] devices_)
This will cancel all set links in the map.
|
void |
cancelLink(IEDeviceGroup device_)
Will cancel the current device link.
|
void |
cancelLinkGroup(IEDeviceGroup device_)
Will cancel the current device group of links from the list.
|
de.desy.tine.client.TLink |
getLink(IEDeviceGroup devices_,
EAccess access_)
Get the TINE link for the enumeration of devices and the access to it.
|
de.desy.tine.client.TLink |
getLink(IEDeviceGroup devices_,
EAccess access_,
de.desy.tine.dataUtils.TDataType data_)
Get the TINE link for the enumeration of devices and the access to it.
|
de.desy.tine.client.TLink |
getLink(IEDeviceGroup devices_,
EAccess access_,
de.desy.tine.dataUtils.TDataType data_,
boolean isUnsortedDevicenames_)
Get the TINE link for the enumeration of devices and the access to it.
|
java.util.Map<IEData,de.desy.tine.client.TLink> |
getLinkGroup(IEDeviceGroup devices_,
EAccess access_,
de.desy.tine.dataUtils.TDataType... dataTypes_)
This method will, instead of the method
#getLink(IEDeviceGroup, EAccess) ,
return a device group as a collection of TINE links. |
java.lang.String |
getRangeNumbers(IEDeviceGroup devices_,
boolean unsortDevices_)
This method will return from a range with CDI names to a range of the
corresponding CDI numbers.
|
java.lang.String |
getTINEAddress(IEDeviceGroup devices_)
Returns on the given device group enumeration the corresponding TINE
address including the host name.
|
java.lang.String |
getTINEAddress(IEDeviceGroup devices_,
EAccess access_)
Returns on the given device group enumeration the corresponding TINE
address including the host name.
|
java.lang.String |
getTINEAddress(IEDeviceGroup devices_,
EAccess access_,
boolean isHTMLStyle_)
Returns on the given device group enumeration the corresponding TINE
address including the host name.
|
boolean |
hasLink(IEDeviceGroup devices_,
EAccess access_)
Checks if the device group has already been initialized by this instance
or not.
|
boolean |
hasLinkGroup(IEDeviceGroup devices_,
EAccess access_)
Checks if the device group has already been initialized by this instance
or not.
|
void |
removeAllLinks(IEDeviceGroup[] devices_)
This will cancel all positive set links in the array and after that deleting
it (i.e.
|
void |
removeLink(IEDeviceGroup device_)
Will remove the current device link from the list.
|
void |
removeLinkGroup(IEDeviceGroup device_)
Will remove the current device group links from the list.
|
static final java.lang.String TINE_MISSING_ADDRESS
java.lang.String getTINEAddress(IEDeviceGroup devices_)
Returns on the given device group enumeration the corresponding TINE
address including the host name. The address is received by default from
a READ access: EAccess.READ
. Moreover the returned address string
is published with HTML flavored tags.
devices_
- Device group enumeration.getTINEAddress(IEDeviceGroup, EAccess)
java.lang.String getTINEAddress(IEDeviceGroup devices_, EAccess access_)
Returns on the given device group enumeration the corresponding TINE address including the host name.
First it internally looks if the the device group only contains
one TINE link. If this is true it returns the corresponding address.
If a negative request is fetched then it looks if their exists a
group of TINE links. If this is true it returns from the
first fetched link the TINE address. If this also fails then the
content of the field TINE_MISSING_ADDRESS
is returned. If one of
the parameters is null
then a null
is returned.
Moreover the returned address string is published with HTML flavored tags.
devices_
- Device group enumeration.access_
- TINE access enumeration.java.lang.String getTINEAddress(IEDeviceGroup devices_, EAccess access_, boolean isHTMLStyle_)
Returns on the given device group enumeration the corresponding TINE address including the host name.
First it internally looks if the the device group only contains
one TINE link. If this is true it returns the corresponding address.
If a negative request is fetched then it looks if their exists a
group of TINE links. If this is true it returns from the
first fetched link the TINE address. If this also fails then the
content of the field TINE_MISSING_ADDRESS
is returned. If one of
the parameters is null
then a null
is returned.
Furthermore the output depends on the last parameter. So, if this is set to true then the output will deliver HTML-stylish new line tags; if this is false it will deliver the normal carriage return tag.
devices_
- Device group enumeration.access_
- TINE access enumeration.isHTMLStyle_
- HTML stylish flag.de.desy.tine.client.TLink getLink(IEDeviceGroup devices_, EAccess access_) throws TineException
Get the TINE link for the enumeration of devices and the access to it. Currently there are read, write and read-write access allowed. Other access will throw an exception.
When the TINE link is created then all data elements, which are taken
from the IEDeviceGroup.getDataComponent()
, are sorted before
requesting its range.
devices_
- Is the devices of the derivated enumeration ones.access_
- Is the access to the devices. It is of the TINE form
of de.desy.tine.definitons.TAccess
.TineException
- A TINE exception is thrown if the current link can
not be established.de.desy.tine.client.TLink getLink(IEDeviceGroup devices_, EAccess access_, de.desy.tine.dataUtils.TDataType data_) throws TineException
Get the TINE link for the enumeration of devices and the access to it. Currently there are read, write and read-write access allowed. Other access will throw an exception.
The extension of this method according to
getLink(IEDeviceGroup, EAccess)
is that
it will take the TINE data element, which also can possibly by
set in the constructor of the monitor, but it can also be null
.
When the TINE link is created then all data elements, which are taken
from the IEDeviceGroup.getDataComponent()
, are sorted before
requesting its range.
devices_
- Is the devices of the derivated enumeration ones.access_
- Is the access to the devices. It is of the TINE form
of de.desy.tine.definitons.TAccess
.data_
- Is the data type of the TINE link, which can also be
null
.TineException
- A TINE exception is thrown if the current link can
not be established.de.desy.tine.client.TLink getLink(IEDeviceGroup devices_, EAccess access_, de.desy.tine.dataUtils.TDataType data_, boolean isUnsortedDevicenames_) throws TineException
Get the TINE link for the enumeration of devices and the access to it. Currently there are read, write and read-write access allowed. Other access will throw an exception.
The extension of this method according to
getLink(IEDeviceGroup, EAccess)
is that
it will take the TINE data element, which also can possibly by
set in the constructor of the monitor, but it can also be null
.
The boolean argument of unsortedDevicename_
allows the user
to sort the CDI device numbers, which are taken from
IEDeviceGroup.getDataComponent()
, in a sorted way by setting
this argument to false
. Otherwise it will created the
actual TINE link with the unsorted man as they are delivered by the
device group. For more information about the sorting of the device
numbers you should have a look at the method of
getRangeNumbers(IEDeviceGroup, boolean)
.
devices_
- Is the devices of the derivated enumeration ones.access_
- Is the access to the devices. It is of the TINE form
of de.desy.tine.definitons.TAccess
.data_
- Is the data type of the TINE link, which can also be
null
.isUnsortedDevicenames_
- Allows the user to sort the device numbers
by introducing a false
to this argument. Otherwise it will
sort the device numbers and, perhaps, also transform it into a
range of device numbers.TineException
- A TINE exception is thrown if the current link can
not be established.java.util.Map<IEData,de.desy.tine.client.TLink> getLinkGroup(IEDeviceGroup devices_, EAccess access_, de.desy.tine.dataUtils.TDataType... dataTypes_) throws TineException
#getLink(IEDeviceGroup, EAccess)
,
return a device group as a collection of TINE links. Currently
there are read, write and read-write access allowed. Other access will
throw an exception.devices_
- Is the devices of the derivated enumeration ones.access_
- Is the access to the device name. It is of the TINE form
of de.desy.tine.definitons.TAccess
.dataTypes_
- Possibly all TINE data types.TineException
- A TINE exception is thrown if the current link can
not be established.boolean hasLink(IEDeviceGroup devices_, EAccess access_)
devices_
- Is the device group on which the link(s) should exist.access_
- Is the access mode of the link.true
if the link already
exists or false
if not.boolean hasLinkGroup(IEDeviceGroup devices_, EAccess access_)
devices_
- Is the device group on which the link(s) should exist.access_
- Is the access mode of the link.true
if the link already
exists or false
if not.java.lang.String getRangeNumbers(IEDeviceGroup devices_, boolean unsortDevices_)
This method will return from a range with CDI names to a range of the corresponding CDI numbers. All are enclosed with the number sign (#) and aligned with a - sign, if it fits a range.
For example, the range value, which is returned by the device group of HF104ESUANODE - HF104CAVSTEMPE2, will be returned as #1 - #17.
The argument of unsortedDevices_
permit the user to get all
CDI device numbers in an unsorted way, as they are delivered by the
device group of IEDeviceGroup.getDataComponent()
if it set to
true
.
If this argument is set to true
then
all data elements are converted to their CDI device numbers, each number
filled in the string value, separated by commas, without any
sorting, for example #3,#2,#6,#4,#5,#1.
If this argument is set to false
, then at first the list
of device numbers is sorted, and looked if their exists a difference
between two numbers which is greater then 1. Then all numbers will be
returned as a sorted list of device numbers, each separated with a
comma, for example #1,#2,#5,#6. If not it returns a range of the
device numbers from the first to the last one, separated both with a
hyphen, for example #1 - #6.
devices_
- Is the corresponding enumeration interface of a device
group.unsortDevices_
- Request if the user wants the CDI device names in
an unsorted manner as they are delivered or sorted.void removeAllLinks(IEDeviceGroup[] devices_)
null
).devices_
- Is a collection of all devices which should be removed.void removeLink(IEDeviceGroup device_)
device_
- Is the devices of the derivated enumeration ones.void cancelLinkGroup(IEDeviceGroup device_)
device_
- Is the devices of the derivated enumeration ones.void cancelAllLinks(IEDeviceGroup[] devices_)
devices_
- Is a collection of all devices which should be canceled.void cancelLink(IEDeviceGroup device_)
device_
- Is the devices of the derivated enumeration ones.void removeLinkGroup(IEDeviceGroup device_)
device_
- Is the devices of the derivated enumeration ones.14-September-2016 18:23 Deutsches Elektronen-Synchrotron DESY in der Helmholtz-Gemeinschaft