public interface ICDIDevice
Modifier and Type | Interface and Description |
---|---|
static class |
ICDIDevice.EApplicationModel
The application model.
|
Modifier and Type | Field and Description |
---|---|
static int |
LOWER_LIMIT_REQUEST_FOR_TIMEOUT
The method
setTINETimeout(int) allows to set a time out for
requesting meta information from a server. |
static int |
UPPER_LIMIT_REQUEST_FOR_TIMEOUT
The method
setTINETimeout(int) allows to set a time out for
requesting meta information from a server. |
Modifier and Type | Method and Description |
---|---|
void |
checkEnumElements()
Deprecated.
|
void |
checkEnumElements(ICDIDevice.EApplicationModel model_)
All enumeration elements in the delivered collection of the
constructor will be checked if they exists for the corresponding CDI device
server element in the table.
|
void |
checkEnumElements(ICDIDevice.EApplicationModel model_,
java.lang.String tineAddress_)
All enumeration elements in the delivered collection of the
constructor will be checked if they exists the corresponding CDI device
server element in the table.
|
void |
checkEnumElements(ICDIDevice.EApplicationModel model_,
java.lang.String tineAddress_,
boolean checkEverytime_,
boolean initAllDevices_)
All enumeration elements in the delivered collection of the
constructor will be checked if they exists for the corresponding CDI device
server element in the table.
|
void |
checkEnumElements(java.lang.String tineAddress_)
Deprecated.
|
void |
checkEnumElements(java.lang.String tineAddress_,
boolean checkEverytime_,
boolean initAllDevices_)
Deprecated.
|
java.lang.String |
fetchDevice(java.lang.String tineAddress_,
int deviceNumber_)
Fetches the current device by its current CDI number.
|
java.util.Collection<java.lang.String> |
fetchDevices(java.lang.String tineAddress_)
Fetches all device names and returns them as a collection.
|
int |
fetchNumber(java.lang.String tineAddress_,
java.lang.String deviceName_)
Fetches the current device by its current CDI name and returns its number.
|
int |
fetchNumberOfDevices()
Returns the number of all devices.
|
IExecute |
getExec(IEExpectList exert_)
Deprecated.
|
int |
getTINETimeout()
Returns the time out limit for requesting data from a TINE server.
|
void |
setTINETimeout(int timeout)
Allows to set for requesting data from a TINE server a time out.
|
static final int LOWER_LIMIT_REQUEST_FOR_TIMEOUT
setTINETimeout(int)
allows to set a time out for
requesting meta information from a server. This is the lower time out limit.static final int UPPER_LIMIT_REQUEST_FOR_TIMEOUT
setTINETimeout(int)
allows to set a time out for
requesting meta information from a server. This is the upper time out limit.void setTINETimeout(int timeout)
TineException
is thrown
with the error code 45 (link timeout).timeout
- Time out in milliseconds should be between 1000 up to
10000 ms. If it exceeds one of these limit is forced to the
corresponding limit.int getTINETimeout()
@Deprecated void checkEnumElements() throws TineException, EnumerationNotFoundException
checkEnumElements(EApplicationModel)
instead.
By default checks the server application model.
TineException
- Throws a TineException if the TINE
connection failed for any reasons.EnumerationNotFoundException
- If one or more elements does not
exits or are misspelled.checkEnumElements(EApplicationModel)
void checkEnumElements(ICDIDevice.EApplicationModel model_) throws TineException, EnumerationNotFoundException
All enumeration elements in the delivered collection of the
constructor will be checked if they exists for the corresponding CDI device
server element in the table. If not an EnumerationNotFoundException
will be thrown. It will get all elements from CDI and set them to the
corresponding device name.
model_
- Devides the two possible application model for initializing
the application. Internally this method will call the refresh method
which reflects via a synchronous TINE call the meta information
from the server, which depends on the application model (for example
the client would be interested in the unit of a value where the
server would be interested in the range of a value).TineException
- Throws a TineException if the TINE
connection failed for any reasons.EnumerationNotFoundException
- If one or more elements does not
exits or are misspelled.@Deprecated void checkEnumElements(java.lang.String tineAddress_) throws TineException, EnumerationNotFoundException
checkEnumElements(EApplicationModel, String)
instead.
By default checks the server application model.
tineAddress_
- Preliminary TINE address (i.e. the TINE context and
server name) allows to specify the
CDI server name to be checked. This can also be null, which means
to check all elements of all CDI servers. If this string value
is set and the corresponding CDI server doesn't exist then a
IllegalArgumentException
is thrown.TineException
- Throws a TineException if the TINE
connection failed for any reasons.EnumerationNotFoundException
- If one or more elements does not
exits or are misspelled.checkEnumElements(EApplicationModel, String)
void checkEnumElements(ICDIDevice.EApplicationModel model_, java.lang.String tineAddress_) throws TineException, EnumerationNotFoundException
All enumeration elements in the delivered collection of the
constructor will be checked if they exists the corresponding CDI device
server element in the table. If not an EnumerationNotFoundException
will be thrown. It will get all elements from CDI and set them to the
corresponding device name.
model_
- Devides the two possible application model for initializing
the application. Internally this method will call the refresh method
which reflects via a synchronous TINE call the meta information
from the server, which depends on the application model (for example
the client would be interested in the unit of a value where the
server would be interested in the range of a value).tineAddress_
- Preliminary TINE address (i.e. the TINE context and
server name) allows to specify the
CDI server name to be checked. This can also be null, which means
to check all elements of all CDI servers. If this string value
is set and the corresponding CDI server doesn't exist then a
IllegalArgumentException
is thrown.TineException
- Throws a TineException if the TINE
connection failed for any reasons.EnumerationNotFoundException
- If one or more elements does not
exits or are misspelled.@Deprecated void checkEnumElements(java.lang.String tineAddress_, boolean checkEverytime_, boolean initAllDevices_) throws TineException, EnumerationNotFoundException
checkEnumElements(EApplicationModel, String, boolean, boolean)
instead.tineAddress_
- Preliminary TINE address (i.e. the TINE context and
server name) allows to specify the
CDI server name to be checked. This can also be null, which means
to check all elements of all CDI servers. If this string value
is set and the corresponding CDI server doesn't exist then a
IllegalArgumentException
is thrown.checkEverytime_
- Checks if this method executes every time you call
this method. If you use true independent of
every other field, it will try to get all device
information over TINE, otherwise it will do nothing.initAllDevices_
- Checks if all device elements should be initialized
(true) or not (false). Is this boolean value
false
then only the device names and numbers are initialize. If
it set to true
will initialize all device elements by getting the device
names, device numbers, units, precision, minimum and max values (range),
the addresses (crate and sub-address), and the description.TineException
- Throws a TineException if the TINE
connection failed for any reasons.EnumerationNotFoundException
- If one or more elements does not
exits or are misspelled.checkEnumElements(EApplicationModel, String, boolean, boolean)
void checkEnumElements(ICDIDevice.EApplicationModel model_, java.lang.String tineAddress_, boolean checkEverytime_, boolean initAllDevices_) throws TineException, EnumerationNotFoundException
EnumerationNotFoundException
is thrown.model_
- Devides the two possible application model for initializing
the application. Internally this method will call the refresh method
which reflects via a synchronous TINE call the meta information
from the server, which depends on the application model (for example
the client would be interested in the unit of a value where the
server would be interested in the range of a value).tineAddress_
- Preliminary TINE address (i.e. the TINE context and
server name) allows to specify the
CDI server name to be checked. This can also be null, which means
to check all elements of all CDI servers. If this string value
is set and the corresponding CDI server doesn't exist then a
IllegalArgumentException
is thrown.checkEverytime_
- Checks if this method executes every time you call
this method. If you use true independent of
every other field, it will try to get all device
information over TINE, otherwise it will do nothing.initAllDevices_
- Checks if all device elements should be initialized
(true) or not (false). Is this boolean value is
false
then only the device names and numbers are initialize. When
it is true
it will initialize all device elements by getting the device
names, device numbers, units, precision, minimum and max values (range),
the addresses (crate and sub-address), and the description.TineException
- Throws a TineException if the TINE
connection failed for any reasons.EnumerationNotFoundException
- If one or more elements does not
exits or are misspelled.java.lang.String fetchDevice(java.lang.String tineAddress_, int deviceNumber_)
tineAddress_
- Is the preliminary TINE address string.deviceNumber_
- Is the current CDI device number.null
value can also be returned.java.util.Collection<java.lang.String> fetchDevices(java.lang.String tineAddress_)
tineAddress_
- The preliminary TINE address context is needed to
get all devices.int fetchNumber(java.lang.String tineAddress_, java.lang.String deviceName_)
tineAddress_
- Is the preliminary TINE address string.deviceName_
- Is the current CDI device name.int fetchNumberOfDevices()
@Deprecated IExecute getExec(IEExpectList exert_)
exert_
- Is the exerted value.14-September-2016 18:23 Deutsches Elektronen-Synchrotron DESY in der Helmholtz-Gemeinschaft