de.desy.tine.queryUtils.TQuery Class Reference

TQuery: Utility with many standard query routines. More...

Static Public Member Functions
static boolean	isStockProperty (String property)
static short	setMaximumQueryBufferSize (int size)
	Sets the maximum size for use in tine queries. More...
static String[]	getContexts ()
	Returns a list of Contexts (obtained from the name services) More...
static String[]	getDeviceContexts (int timeout)
	Returns a list of Contexts (obtained from the name services) More...
static String[]	getContexts (String serverName)
	Returns a list of Contexts (obtained from the name services) which offer a server with the name specified. More...
static String[]	getContexts (String serverName, String importance)
	Returns a list of Contexts (obtained from the name services) which offer a server with the name and importance specified. More...
static String[]	getDeviceContexts (String serverName, String importance, int timeout)
	Returns a list of Contexts (obtained from the name services) which offer a server with the name and importance specified. More...
static String[]	getDeviceServerReport (String context, String server, String device)
	generates an information list as an array of strings pertaining to the input server More...
static String[]	getDeviceServerReport (String context, String server)
	generates an information list as an array of strings pertaining to the input server More...
static String[]	getDeviceServerReport (String context, String server, String device, int limit)
	generates an information list as an array of strings pertaining to the input server More...
static String[]	getDeviceServers (String context)
	Returns a list of device servers associated with the specified context (obtained from the name services) More...
static String[]	getDeviceServers (String context, String search)
	Returns a list of device servers associated with the specified context and subsystem (obtained from the name services) More...
static ServerQuery[]	getDeviceServersEx (String context, String subsys, String importance)
	Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services) More...
static ServerQuery[]	getDeviceServersEx (String context, String subsys, String importance, int timeout)
	Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services) More...
static ServerQuery[]	getDeviceServersEx (String context, String search, int timeout)
	Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services) More...
static String[]	getDeviceSubsystems ()
	Returns a list of registered subsystems (obtained from the name services) More...
static String[]	getDeviceSubsystems (String context)
	Returns a list of registered subsystems in a given context (obtained from the name services) More...
static String[]	getDeviceSubsystems (String context, int timeout)
	Returns a list of registered subsystems in a given context (obtained from the name services) More...
static String[]	getServers (String context)
	Returns a list of front end computers (FECs) associated with the specified context (obtained from the name services) More...
static String[]	getServers (String context, String search)
	Returns a list of front end computers (FECs) associated with the specified context and sub system (obtained from the name services) More...
static ServerQuery[]	getServersEx (String context, String subsys, String importance)
	Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services) More...
static ServerQuery[]	getServersEx (String context, String subsys, String importance, int timeout)
	Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services) More...
static TClientStruct[]	getServerClients (String fullServerName)
static FECInfo	getServerInformation (String frontEndComputer)
	Retrieves information about the specified front-end computer. More...
static String[]	getDeviceProperties (String context, String server, String device)
	Returns a list of properties associated with the specified context and device server and device (obtained from the device server) More...
static String[]	getDeviceProperties (String context, String server, String device, int timeout)
	Returns a list of properties associated with the specified context and device server and device (obtained from the device server) More...
static String[]	getDeviceProperties (String context, String server, String device, String property)
	Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server) More...
static String[]	getDeviceProperties (String context, String server, String device, String property, int timeout)
	Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server) More...
static String[]	getPropertiesWithPattern (String context, String server, String device, String propertyPattern, int timeout) throws IOException
	Returns an array of properties matching the pattern input. More...
static String	getTineVersion (String context, String server)
	Retrieves the TINE version of the input server. More...
static String	getAppVersion (String context, String server)
	Retrieves the application version of the input server. More...
static String	getAppDate (String context, String server)
	Retrieves the application compile date. More...
static String[]	getStockProperties (String context, String server)
	Returns a list of stock properties associated with the specified context and device server (obtained from the device server). More...
static String[]	getStockProperties (String context, String server, String device, String property)
	Returns a list of stock properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server). More...
static String[]	getMetaProperties (String context, String server)
	Returns a list of meta properties associated with the specified context and device server (obtained from the device server). More...
static String[]	getMetaProperties (String context, String server, String device, String property)
	Returns a list of meta properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server). More...
static String[]	getDeviceNames (String context, String server)
	Returns a list of device names associated with the specified context and device server (obtained from the device server) More...
static String[]	getDeviceNames (String context, String server, String property)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server) More...
static String[]	getDeviceNames (String context, String server, String property, String filter)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server) More...
static String[]	getDeviceNames (String context, String server, String property, int timeout)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server) More...
static String[]	getDeviceNames (String context, String server, String property, String filter, int timeout)
	Returns a list of device names associated with the specified context, device server and property (obtained from the device server) More...
static String[]	getDeviceGroupMembers (String context, String server, String device, String property, int timeout)
	acquires the multi-channel device list from a doocs-server with a registered MCA property. More...
static void	flushDeviceGroupmembers ()
	A helper routine which clears all acquired information pertaining to device groups.
static void	flushDeviceGroupmembers (String key)
	A helper routine which clears the acquired information pertaining to the device group specified by the input key. More...
static int	getNumberOfDevices (String context, String server, String property, int timeout) throws IOException
	Returns the number of registered devices for the server and context (and property if non null) given. More...
static int	getNumberOfDevices (String context, String server, String property, String filter, int timeout) throws IOException
	Returns the number of registered devices for the server and context (and property if non null) given. More...
static PropertyQueryEx[]	getDevicePropertyInformation (String context, String server, String device, String property)
static synchronized PropertyQueryEx[]	getDevicePropertyInformation (String context, String server, String device, String property, int timeout)
static synchronized int	AcquireAndRegisterBitfieldInfo (String context, String server, String tag, short format)
	acquires the bitfield information for the given tag from the targeted server and registers the bitfield locally. More...
static synchronized int	AcquireAndRegisterStructInfo (String context, String server, String tag)
	acquires the structure information for the given tag from the targeted server and registers the tagged structure locally. More...
static XPropertyQuery[]	getDevicePropertyInformationX (String context, String server, String device, String property)
static XPropertyQuery[]	getDevicePropertyInformationX (String context, String server, String device, String property, int timeout)
static TPropertyQuery[]	getPropertyInformation (String context, String server, String device, String property)
	Returns a list of property query information objects associated with the specified context, device server, device. More...
static TPropertyQuery[]	getPropertyInformation (String context, String server, String device, String property, int timeout)
	Returns a list of property query information objects associated with the specified context, device server, device. More...
static int	pingServer (String context, String server, int timeout)
	issues a general 'server' ping using the known stock property 'SRVSTARTTIME'. More...
static int	pingServer (String context, String server, int timeout, boolean output)
	issues a general 'server' ping using the known stock property 'SRVSTARTTIME'. More...
static int	pingServer (String context, String server, String device, int timeout, boolean output)
	issues a general 'server' ping using the known stock property 'SRVSTARTTIME'. More...
static int	getNumberOfProperties (String context, String server, int timeout) throws IOException
	Returns the number of registered properties for the give server and context. More...
static TPropertyQuery[]	getStockPropertyInformation (String context, String server, String device, String property)
	Returns a list of extended property query information objects associated with the specified context, device server, device. More...
static TPropertyQuery[]	getStockPropertyInformation (String context, String server, String device, String property, int timeout)
	Returns a list of property query information objects associated with the specified context, device server, device. More...
static synchronized XPropertyQuery[]	getStockPropertyInformationX (String context, String server, String device, String property)
static int	setAccessLock (String context, String server, AccessLockType lockType, int lockDuration)
	Establishes an access lock on the device server specified. More...
static String[]	getAccessLockInformation (String context, String server)
	Retrieves the access lock information on the device server specified. More...
static void	removeAccessLock (String context, String server)
	Removes an access lock on the server specified. More...

Detailed Description

TQuery: Utility with many standard query routines.

This is a static class which can be used to make system queries without the need for instantiating a TQuery object.

Author

duval

Member Function Documentation

AcquireAndRegisterBitfieldInfo()

static synchronized int de.desy.tine.queryUtils.TQuery.AcquireAndRegisterBitfieldInfo ( String  context, String  server, String  tag, short  format  )

static

acquires the bitfield information for the given tag from the targeted server and registers the bitfield locally.

Parameters

context	is the context of the server using the bitfield
server	is the server name of the server using the bitfield
tag	is the bitfield tag identifying the bitfield
format	is the bitfield format (one of CF_BITFIELD8, CF_BITFIELD16, CF_BITFIELD32, or CF_BITFIELD64 from the TFormat class).

Returns

0 upon success or a tine error code.

AcquireAndRegisterStructInfo()

static synchronized int de.desy.tine.queryUtils.TQuery.AcquireAndRegisterStructInfo ( String  context, String  server, String  tag  )

static

acquires the structure information for the given tag from the targeted server and registers the tagged structure locally.

Parameters

context	is the context of the server using the structure
server	is the server name of the server using the structure
tag	is the structure tag identifying the structure

Returns

0 upon success or a tine error code.

References de.desy.tine.client.TLink.close(), and de.desy.tine.client.TLink.execute().

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

flushDeviceGroupmembers()

static void de.desy.tine.queryUtils.TQuery.flushDeviceGroupmembers ( String  key )

static

A helper routine which clears the acquired information pertaining to the device group specified by the input key.

Parameters

key	is the device group key (/<context>/<server>[property]) identifying a device group

getAccessLockInformation()

static String [] de.desy.tine.queryUtils.TQuery.getAccessLockInformation ( String  context, String  server  )

static

Retrieves the access lock information on the device server specified.

Parameters

context	is the context containing the device server
server	is the targeted device server

Returns

a string array containing the user and address of the owner of the current access lock. If there is no access lock, the strings are empty.

References de.desy.tine.client.TLink.close(), and de.desy.tine.client.TLink.execute().

getAppDate()

static String de.desy.tine.queryUtils.TQuery.getAppDate ( String  context, String  server  )

static

Retrieves the application compile date.

Parameters

context	is the desired context
server	is the targeted server

Returns

the current application compile data of the specified server. If this information is not supplied by the server developer, then "January 1, 1970" will be the likely result.

getAppVersion()

static String de.desy.tine.queryUtils.TQuery.getAppVersion ( String  context, String  server  )

static

Retrieves the application version of the input server.

Parameters

context	is the desired context
server	is the targeted server

Returns

the current application version of the specified server. If this information is not supplied by the server developer, then "1.0.0" will be the likely result.

getContexts() [1/3]

static String [] de.desy.tine.queryUtils.TQuery.getContexts ( )

static

Returns a list of Contexts (obtained from the name services)

Returns

A string array containing a list of available contexts as obtained from the Equipment Name Server (ENS) or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

References de.desy.tine.queryUtils.TQuery.getDeviceContexts().

Referenced by de.desy.tine.histUtils.THistory.getArchiveServerContexts(), and de.desy.tine.queryUtils.TQuery.getContexts().

getContexts() [2/3]

static String [] de.desy.tine.queryUtils.TQuery.getContexts ( String  serverName )

static

Returns a list of Contexts (obtained from the name services) which offer a server with the name specified.

Parameters

serverName

is the targeted server name

Returns

A string array containing a list of available contexts which have the named server or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

References de.desy.tine.queryUtils.TQuery.getContexts().

getContexts() [3/3]

static String [] de.desy.tine.queryUtils.TQuery.getContexts ( String  serverName, String  importance  )

static

Returns a list of Contexts (obtained from the name services) which offer a server with the name and importance specified.

Parameters

serverName	is the targeted server name
imporance	is the desired server importance (one of "ALL", "IMPORTANT", "CRITICAL", "ESSENTIAL")

Returns

A string array containing a list of available contexts which have the named server or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

References de.desy.tine.queryUtils.TQuery.getDeviceContexts().

getDeviceContexts() [1/2]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceContexts ( int  timeout )

static

Returns a list of Contexts (obtained from the name services)

Parameters

timeout

is the allowed timeout in milliseconds for the call to complete

Returns

A string array containing a list of available contexts as obtained from the Equipment Name Server (ENS) or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

References de.desy.tine.client.TLinkFactory.getInstance().

Referenced by de.desy.tine.queryUtils.TQuery.getContexts().

getDeviceContexts() [2/2]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceContexts ( String  serverName, String  importance, int  timeout  )

static

Returns a list of Contexts (obtained from the name services) which offer a server with the name and importance specified.

Parameters

serverName	is the targeted server name
imporance	is the desired server importance (one of "ALL", "IMPORTANT", "CRITICAL", "ESSENTIAL")
timeout	Is a timeout in milliseconds to wait for the call to complete

Returns

A string array containing a list of available contexts which have the named server or a null pointer if the call could not complete successfully. If no contexts were found a string array of zero length is returned.

References de.desy.tine.client.TLink.executeAndClose(), de.desy.tine.dataUtils.TDataType.getCompletionLength(), and de.desy.tine.client.TLinkFactory.getInstance().

getDeviceGroupMembers()

static String [] de.desy.tine.queryUtils.TQuery.getDeviceGroupMembers ( String  context, String  server, String  device, String  property, int  timeout  )

static

acquires the multi-channel device list from a doocs-server with a registered MCA property.

Parameters

context	is the context of the target server
server	is the name of the target server
device	is the (group device) device name associated with the MCA property
property	is the target MCA property
timeout	is a completion timeout in milliseconds

Returns

0 upon success or a tine error (connection_timeout if the given timeout is exceeded).

References de.desy.tine.client.TLink.executeAndClose(), de.desy.tine.dataUtils.TDataType.getCompletionLength(), de.desy.tine.queryUtils.TQuery.getDeviceNames(), and de.desy.tine.queryUtils.TQuery.getPropertyInformation().

getDeviceNames() [1/5]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames ( String  context, String  server  )

static

Returns a list of device names associated with the specified context and device server (obtained from the device server)

As the call is directed to the device server, it assumes the return list applies to all properties

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.

Returns

A string array containing a list of devices as obtained from the given device server.
A null pointer is returned if the call fails for any reason.

Referenced by de.desy.tine.histUtils.THistory.getArchivedDevices(), de.desy.tine.queryUtils.TQuery.getDeviceGroupMembers(), de.desy.tine.queryUtils.TQuery.getDeviceNames(), and de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

getDeviceNames() [2/5]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames ( String  context, String  server, String  property  )

static

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters

context	Is the context of the device server for which the device list is desired.
server	Is the device server for which the device list is desired.
property	Is the property for which the device list is desired.

Returns

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getDeviceNames().

getDeviceNames() [3/5]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames ( String  context, String  server, String  property, int  timeout  )

static

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters

context	is the context of the device server for which the device list is desired.
server	is the device server for which the device list is desired.
property	is the property for which the device list is desired.
timeout	is the time in milliseconds to wait for the call to complete

Returns

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getDeviceNames().

getDeviceNames() [4/5]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames ( String  context, String  server, String  property, String  filter  )

static

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters

context	Is the context of the device server for which the device list is desired.
server	Is the device server for which the device list is desired.
property	Is the property for which the device list is desired.
filter	is a device name filter containing the wildcard character '*'

Returns

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getDeviceNames().

getDeviceNames() [5/5]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceNames ( String  context, String  server, String  property, String  filter, int  timeout  )

static

Returns a list of device names associated with the specified context, device server and property (obtained from the device server)

Parameters

context	is the context of the device server for which the device list is desired.
server	is the device server for which the device list is desired.
property	is the property for which the device list is desired.
filter	is a device name filter containing the wildcard character '*'
timeout	is the time in milliseconds to wait for the call to complete

Returns

A string array containing a list of devices as obtained from the given device server A null pointer is returned if the call fails for any reason.

getDeviceProperties() [1/4]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties ( String  context, String  server, String  device  )

static

Returns a list of properties associated with the specified context and device server and device (obtained from the device server)

Parameters

context	is the context of the device server for which the property list is desired.
server	is the device server for which the property list is desired.
device	is the device name (module name) for which the property list is desired.

Returns

A string array containing a list of properties as obtained from the given device server

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceProperties(), and de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

getDeviceProperties() [2/4]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties ( String  context, String  server, String  device, int  timeout  )

static

Returns a list of properties associated with the specified context and device server and device (obtained from the device server)

Parameters

context	is the context of the device server for which the property list is desired.
server	is the device server for which the property list is desired.
device	is the device name (module name) for which the property list is desired.
timeout	is the allowed timeout in milliseconds.

Returns

A string array containing a list of properties as obtained from the given device server

References de.desy.tine.queryUtils.TQuery.getDeviceProperties().

getDeviceProperties() [3/4]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties ( String  context, String  server, String  device, String  property  )

static

Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server)

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all properties whose first letter begins with 'P'.

Returns

A string array containing a list of properties as obtained from the given device server A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getDeviceProperties().

getDeviceProperties() [4/4]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceProperties ( String  context, String  server, String  device, String  property, int  timeout  )

static

Returns a list of properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server)

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all properties whose first letter begins with 'P'.
timeout	is the time in milliseconds to allow the call to complete

Returns

A string array containing a list of properties as obtained from the given device server A null pointer is returned if the call fails for any reason.

getDevicePropertyInformation() [1/2]

static PropertyQueryEx [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformation ( String  context, String  server, String  device, String  property  )

static

Deprecated:

See also

getPropertyInformation

Returns a list of extended property query information objects associated with the specified context, device server, device. and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getDevicePropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items.

Parameters

context	Is the context of the device server for which the property information is desired.
server	Is the device server for which the property information is desired.
device	Is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.

Returns

An array of PropertyQueryEx (extended Property Query) objects, as obtained from the given device server

getDevicePropertyInformation() [2/2]

static synchronized PropertyQueryEx [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformation ( String  context, String  server, String  device, String  property, int  timeout  )

static

Deprecated:

See also

getPropertyInformation

References de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX().

getDevicePropertyInformationX() [1/2]

static XPropertyQuery [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX ( String  context, String  server, String  device, String  property  )

static

Deprecated:

See also

getPropertyInformation

Returns a list of extended property query information objects associated with the specified context, device server, device. and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getDevicePropertyInformationX() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters

context	Is the context of the device server for which the property information is desired.
server	Is the device server for which the property information is desired.
device	Is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.

Returns

An array of XPropertyQuery (extended Property Query) objects, as obtained from the given device server

Referenced by de.desy.tine.queryUtils.TQuery.getDevicePropertyInformation(), de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX(), and de.desy.tine.queryUtils.TQuery.getStockPropertyInformationX().

getDevicePropertyInformationX() [2/2]

static XPropertyQuery [] de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX ( String  context, String  server, String  device, String  property, int  timeout  )

static

Deprecated:

See also

getPropertyInformation

References de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX().

getDeviceServerReport() [1/3]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServerReport ( String  context, String  server  )

static

generates an information list as an array of strings pertaining to the input server

Parameters

context	is the context of the target server
server	is the server name of the target server

Returns

a string list giving the report line-by-line.

References de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

getDeviceServerReport() [2/3]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServerReport ( String  context, String  server, String  device  )

static

generates an information list as an array of strings pertaining to the input server

Parameters

context	is the context of the target server
server	is the server name of the target server
device	is a device name (relevant for device-oriented servers) to be used in making the report.

Returns

a string list giving the report line-by-line.

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

getDeviceServerReport() [3/3]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServerReport ( String  context, String  server, String  device, int  limit  )

static

generates an information list as an array of strings pertaining to the input server

Parameters

context	is the context of the target server
server	is the server name of the target server
device	is a device name (relevant for device-oriented servers) to be used in making the report.
limit	if non-zero, 'limit' provides an upper limit to the number of properties used in making the report.

Returns

a string list giving the report line-by-line.

References de.desy.tine.queryUtils.TQuery.AcquireAndRegisterStructInfo(), de.desy.tine.types.IMAGE.FrameHeader.appendedFrameSize, de.desy.tine.client.TLink.executeAndClose(), de.desy.tine.dataUtils.TDataType.getCompletionLength(), de.desy.tine.dataUtils.TDataType.getDataObject(), de.desy.tine.queryUtils.TQuery.getDeviceNames(), de.desy.tine.queryUtils.TQuery.getDeviceProperties(), de.desy.tine.queryUtils.TQuery.getDeviceServersEx(), de.desy.tine.types.IMAGE.getFrameHeader(), de.desy.tine.client.TLink.getFullDeviceNameAndProperty(), de.desy.tine.client.TLink.getLastError(), de.desy.tine.client.TLink.getOutputDataObject(), de.desy.tine.queryUtils.TQuery.getPropertyInformation(), de.desy.tine.queryUtils.TQuery.getServerInformation(), de.desy.tine.definitions.TErrorList.hasData(), de.desy.tine.definitions.TAccess.isRead(), de.desy.tine.dataUtils.TDataType.setArrayDelimiter(), de.desy.tine.definitions.TArrayType.toString(), de.desy.tine.definitions.TErrorList.toString(), de.desy.tine.definitions.TFormat.toString(), and de.desy.tine.dataUtils.TDataType.toString().

getDeviceServers() [1/2]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServers ( String  context )

static

Returns a list of device servers associated with the specified context (obtained from the name services)

Parameters

context

Is the context for which the device server name list is desired

Returns

A string array containing a list of device servers associated with the given context as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

getDeviceServers() [2/2]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceServers ( String  context, String  search  )

static

Returns a list of device servers associated with the specified context and subsystem (obtained from the name services)

Parameters

context	Is the context for which the device server name list is desired
search	Is an optional search string. If this string does not contain a 'switch' then then /sub=search is assumed (i.e. a subsystem search).

Returns

A string array containing a list of device servers associated with the given context and subsystem as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

References de.desy.tine.client.TLinkFactory.getInstance().

getDeviceServersEx() [1/3]

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getDeviceServersEx ( String  context, String  search, int  timeout  )

static

Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters

context	Is the context for which the device server name list is desired
search	Is an optional search string. If this string does not contain a 'switch' then then /sub=search is assumed (i.e. a subsystem search).
timeout	is the time in milliseconds to wait for the call to complete

Returns

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

References de.desy.tine.definitions.TErrorList.toString().

getDeviceServersEx() [2/3]

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getDeviceServersEx ( String  context, String  subsys, String  importance  )

static

Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")

Returns

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

getDeviceServersEx() [3/3]

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getDeviceServersEx ( String  context, String  subsys, String  importance, int  timeout  )

static

Returns a list of device servers associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")
timeout	is the time in milliseconds to wait for the call to complete

Returns

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

References de.desy.tine.definitions.TErrorList.toString().

getDeviceSubsystems() [1/3]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceSubsystems ( )

static

Returns a list of registered subsystems (obtained from the name services)

Returns

A string array containing a list of subsystems. The subsystem is itself not part of the TINE name space, but can be used to refine queries to the Equipment Name Servers (ENS). A null pointer is returned if the call fails for any reason.

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceSubsystems().

getDeviceSubsystems() [2/3]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceSubsystems ( String  context )

static

Returns a list of registered subsystems in a given context (obtained from the name services)

Parameters

context

Is the context for which the subsystem list is desired

Returns

A string array containing a list of available subsystems in the given context. The subsystem is itself not part of the name space, but can be used to refine queries to the Equipment Name Servers (ENS). A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getDeviceSubsystems().

getDeviceSubsystems() [3/3]

static String [] de.desy.tine.queryUtils.TQuery.getDeviceSubsystems ( String  context, int  timeout  )

static

Returns a list of registered subsystems in a given context (obtained from the name services)

Parameters

context	Is the context for which the subsystem list is desired
timeout	Is a timeout in milliseconds to wait for the call to complete

Returns

A string array containing a list of available subsystems in the given context. The subsystem is itself not part of the name space, but can be used to refine queries to the Equipment Name Servers (ENS). A null pointer is returned if the call fails for any reason.

References de.desy.tine.client.TLinkFactory.getInstance().

getMetaProperties() [1/2]

static String [] de.desy.tine.queryUtils.TQuery.getMetaProperties ( String  context, String  server  )

static

Returns a list of meta properties associated with the specified context and device server (obtained from the device server).

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.

Returns

A string array containing a list of meta properties as obtained from the given device server

getMetaProperties() [2/2]

static String [] de.desy.tine.queryUtils.TQuery.getMetaProperties ( String  context, String  server, String  device, String  property  )

static

Returns a list of meta properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server).

Typically, the device parameter does not play a role in this query.

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all stock properties whose first letter begins with 'P'.

Returns

A string array containing a list of meta properties as obtained from the given device server

References de.desy.tine.client.TLink.close(), de.desy.tine.client.TLink.execute(), de.desy.tine.client.TLink.executeAndClose(), and de.desy.tine.queryUtils.TQuery.getStockPropertyInformation().

getNumberOfDevices() [1/2]

static int de.desy.tine.queryUtils.TQuery.getNumberOfDevices ( String  context, String  server, String  property, int  timeout  ) throws IOException

static

Returns the number of registered devices for the server and context (and property if non null) given.

Parameters

context	is the requested context
server	is the requested device server
property	is the desired property (if null or an empty string) the call returns the number of registered devices, else it returns the number of property-specific devices.
timeout	in milliseconds

Returns

the number of devices

Exceptions

IOException

getNumberOfDevices() [2/2]

static int de.desy.tine.queryUtils.TQuery.getNumberOfDevices ( String  context, String  server, String  property, String  filter, int  timeout  ) throws IOException

static

Returns the number of registered devices for the server and context (and property if non null) given.

Parameters

context	is the requested context
server	is the requested device server
property	is the desired property (if null or an empty string) the call returns the number of registered devices, else it returns the number of property-specific devices.
filter	is a device name filter containing a wildcard character '*'
timeout	in milliseconds

Returns

the number of devices

Exceptions

IOException

getNumberOfProperties()

static int de.desy.tine.queryUtils.TQuery.getNumberOfProperties ( String  context, String  server, int  timeout  ) throws IOException

static

Returns the number of registered properties for the give server and context.

Parameters

context	is the requested context
server	is the requested device server
timeout	in milliseconds

Returns

the number of properties

Exceptions

IOException

Referenced by de.desy.tine.queryUtils.TQuery.getPropertiesWithPattern().

getPropertiesWithPattern()

static String [] de.desy.tine.queryUtils.TQuery.getPropertiesWithPattern ( String  context, String  server, String  device, String  propertyPattern, int  timeout  ) throws IOException

static

Returns an array of properties matching the pattern input.

Parameters

context	is the desired server context
server	is the targeted device server
device	is the targeted device name
propertyPattern	is the property pattern (using the wild card character '*') for which a match is desired.
timeout	is the time in milliseconds to allow the call to complete.

Returns

a string array containing those properties which match the pattern given.

Exceptions

IOException

References de.desy.tine.client.TLink.close(), de.desy.tine.client.TLink.execute(), de.desy.tine.dataUtils.TDataType.getCompletionLength(), de.desy.tine.definitions.TErrorList.getErrorString(), and de.desy.tine.queryUtils.TQuery.getNumberOfProperties().

getPropertyInformation() [1/2]

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getPropertyInformation ( String  context, String  server, String  device, String  property  )

static

Returns a list of property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getPropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters

context	is the context of the device server for which the property information is desired.
server	is the device server for which the property information is desired.
device	is the device name (module name) for which the property information is desired.
property	is the property for which the property information is desired.

Returns

An array of TPropertyQuery objects, as obtained from the given device server A null pointer is returned if the call fails for any reason.

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceGroupMembers(), de.desy.tine.queryUtils.TQuery.getDeviceServerReport(), de.desy.tine.queryUtils.TQuery.getPropertyInformation(), and de.desy.tine.queryUtils.TQuery.getStockPropertyInformation().

getPropertyInformation() [2/2]

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getPropertyInformation ( String  context, String  server, String  device, String  property, int  timeout  )

static

Returns a list of property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server).

Usually a call to getDeviceProperties() returns a property list A secondary call to getPropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is null then the call returns information for the first 10 items. This is an extended method call which returns information as to the array 'type' if the property returns an array, as well as the horizontal axis engineering units and range if the property returns a spectrum and the row size and number or rows if the property returns a double array (matrix).

Parameters

context	is the context of the device server for which the property information is desired.
server	is the device server for which the property information is desired.
device	is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired.
timeout	is the time in milliseconds to wait for the call to complete

Returns

An array of TPropertyQuery objects, as obtained from the given device server. A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getPropertyInformation(), and de.desy.tine.definitions.TErrorList.toString().

getServerClients()

static TClientStruct [] de.desy.tine.queryUtils.TQuery.getServerClients ( String  fullServerName )

static

Parameters

fullServerName

is the fully specified device server for which the information is requested (/<context>/<server>).

Returns

an array of TClientStruct objects containing information about each of the clients attached to the targeted server. Returns null if the information cannot be obtained.

References de.desy.tine.client.TLink.executeAndClose().

getServerInformation()

static FECInfo de.desy.tine.queryUtils.TQuery.getServerInformation ( String  frontEndComputer )

static

Retrieves information about the specified front-end computer.

Parameters

frontEndComputer

Returns

a FECInfo object containing the front end computer information. If the information cannot be obtained for what ever reason, the FECInfo object will contain nothing but "unknown" strings.

References de.desy.tine.client.TLink.executeAndClose().

Referenced by de.desy.tine.queryUtils.TQuery.getDeviceServerReport().

getServers() [1/2]

static String [] de.desy.tine.queryUtils.TQuery.getServers ( String  context )

static

Returns a list of front end computers (FECs) associated with the specified context (obtained from the name services)

Parameters

context

Is the context for which the FEC name list is desired

Returns

A string array containing a list of front end computers associated with the given context as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

getServers() [2/2]

static String [] de.desy.tine.queryUtils.TQuery.getServers ( String  context, String  search  )

static

Returns a list of front end computers (FECs) associated with the specified context and sub system (obtained from the name services)

Parameters

context	Is the context for which the FEC name list is desired
search	Is a search string of the form: /sub=subsystem /eqm=equipment module /os=OS /fec=FEC name /r=responsible /ip=ip address /imp=importance. Multiple filters can be applied. If no slash ('/') appears then the input string is taken as a specific subsystem filter.

Returns

A string array containing a list of front end computers associated with the given context and subsystem as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

getServersEx() [1/2]

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getServersEx ( String  context, String  subsys, String  importance  )

static

Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")

Returns

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

getServersEx() [2/2]

static ServerQuery [] de.desy.tine.queryUtils.TQuery.getServersEx ( String  context, String  subsys, String  importance, int  timeout  )

static

Returns a list of front end computers (FECs) associated with the specified context, subsystem, and importance level (obtained from the name services)

Parameters

context	Is the context for which the device server name list is desired
subsys	Is the subsystem for which the device server name list is desired
imporance	Is the importance level for which the device server name list is desired (one of "ALL", "IMPORTANT", "ESSENTIAL", or "CRITICAL")
timeout	is the time in milliseconds to wait for completion.

Returns

A ServerQuery array containing a list of device servers associated with the given context, subsystem, and importance as obtained from the Equipment Name Server (ENS) A null pointer is returned if the call fails for any reason.

References de.desy.tine.definitions.TErrorList.toString().

getStockProperties() [1/2]

static String [] de.desy.tine.queryUtils.TQuery.getStockProperties ( String  context, String  server  )

static

Returns a list of stock properties associated with the specified context and device server (obtained from the device server).

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.

Returns

A string array containing a list of stock properties as obtained from the given device server

getStockProperties() [2/2]

static String [] de.desy.tine.queryUtils.TQuery.getStockProperties ( String  context, String  server, String  device, String  property  )

static

Returns a list of stock properties associated with the specified context and device server, device, and property (sub)string (obtained from the device server).

Typically, the device parameter does not play a role in this query.

Parameters

context	Is the context of the device server for which the property list is desired.
server	Is the device server for which the property list is desired.
device	Is the device name (module name) for which the property list is desired.
property	Can be a queriable string with wildcard parameter '*'. e.g. property = 'P*' will return all stock properties whose first letter begins with 'P'.

Returns

A string array containing a list of stock properties as obtained from the given device server

References de.desy.tine.client.TLink.close(), de.desy.tine.client.TLink.execute(), and de.desy.tine.client.TLink.executeAndClose().

getStockPropertyInformation() [1/2]

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getStockPropertyInformation ( String  context, String  server, String  device, String  property  )

static

Returns a list of extended property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server). Typically, the device name is ignored in this query.

Usually a call to getStockProperties() returns a property list A secondary call to getStockPropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is not null then the call returns information for the first 10 items.

Parameters

context	Is the context of the device server for which the property information is desired.
server	Is the device server for which the property information is desired.
device	Is the device name (module name) for which the property information is desired.
property	Is the property for which the property information is desired. If 'null' or '*' then a list of all stock properties is returned.

Returns

An array of TPropertyQuery (Property Query) objects, as obtained from the given device server A null pointer is returned if the call fails for any reason.

Referenced by de.desy.tine.queryUtils.TQuery.getMetaProperties().

getStockPropertyInformation() [2/2]

static TPropertyQuery [] de.desy.tine.queryUtils.TQuery.getStockPropertyInformation ( String  context, String  server, String  device, String  property, int  timeout  )

static

Returns a list of property query information objects associated with the specified context, device server, device.

and target property (obtained from the device server). Typically, the device name is ignored in this query.

Usually a call to getStockProperties() returns a property list A secondary call to getStockPropertyInformation() returns a list of all property information pertaining to the specified property including all property overloads (maximum 10). If 'property' is not 'null' then the call returns information for the first 10 overloaded items.

Parameters

context	is the context of the device server for which the property information is desired.
server	is the device server for which the property information is desired.
device	is the device name (module name) for which the property information is desired.
property	is the property for which the property information is desired. If 'null' or '*' then a list of all stock properties is returned.
timeout	is the amount of time in milliseconds to wait for the call to complete

Returns

An array of TPropertyQuery (Property Query) objects, as obtained from the given device server A null pointer is returned if the call fails for any reason.

References de.desy.tine.queryUtils.TQuery.getPropertyInformation(), and de.desy.tine.definitions.TErrorList.toString().

getStockPropertyInformationX()

static synchronized XPropertyQuery [] de.desy.tine.queryUtils.TQuery.getStockPropertyInformationX ( String  context, String  server, String  device, String  property  )

static

Deprecated:

See also

getStockPropertyInformation

References de.desy.tine.queryUtils.TQuery.getDevicePropertyInformationX().

getTineVersion()

static String de.desy.tine.queryUtils.TQuery.getTineVersion ( String  context, String  server  )

static

Retrieves the TINE version of the input server.

Parameters

context	is the desired context
server	is the targeted server

Returns

the current TINE version of the specified server

isStockProperty()

static boolean de.desy.tine.queryUtils.TQuery.isStockProperty ( String  property )

static

Parameters

property

is the targeted property

Returns

true if the input property represents a stock property of the server

Referenced by de.desy.tine.client.TLink.execute().

pingServer() [1/3]

static int de.desy.tine.queryUtils.TQuery.pingServer ( String  context, String  server, int  timeout  )

static

issues a general 'server' ping using the known stock property 'SRVSTARTTIME'.

Parameters

context	is the context of the target server
server	is the name of the target server
timeout	is a timeout in milliseconds to allow the call to complete.

Returns

0 if the server responded successfully, else a tine error code.

Referenced by de.desy.tine.queryUtils.TQuery.pingServer().

pingServer() [2/3]

static int de.desy.tine.queryUtils.TQuery.pingServer ( String  context, String  server, int  timeout, boolean  output  )

static

issues a general 'server' ping using the known stock property 'SRVSTARTTIME'.

Parameters

context	is the context of the target server
server	is the name of the target server
timeout	is a timeout in milliseconds to allow the call to complete.
output	is a boolean flag which if 'true' causes the ping results to be printed on the standard input stream.

Returns

0 if the server responded successfully, else a tine error code.

References de.desy.tine.queryUtils.TQuery.pingServer().

pingServer() [3/3]

static int de.desy.tine.queryUtils.TQuery.pingServer ( String  context, String  server, String  device, int  timeout, boolean  output  )

static

issues a general 'server' ping using the known stock property 'SRVSTARTTIME'.

Parameters

context	is the context of the target server
server	is the name of the target server
device	is the specific device name to use in issuing the ping. A 'null' can be passed if this is not relevant.
timeout	is a timeout in milliseconds to allow the call to complete.
output	is a boolean flag which if 'true' causes the ping results to be printed on the standard input stream.

Returns

0 if the server responded successfully, else a tine error code.

References de.desy.tine.client.TLink.executeAndClose(), and de.desy.tine.definitions.TErrorList.getErrorString().

removeAccessLock()

static void de.desy.tine.queryUtils.TQuery.removeAccessLock ( String  context, String  server  )

static

Removes an access lock on the server specified.

Parameters

context	is the targeted context of the server
server	is the targeted device server

Returns

a tine return code

References de.desy.tine.client.TLinkFactory.removeAccessLock().

setAccessLock()

static int de.desy.tine.queryUtils.TQuery.setAccessLock ( String  context, String  server, AccessLockType  lockType, int  lockDuration  )

static

Establishes an access lock on the device server specified.

Parameters

context	is the context containing the device server
server	is the targeted device server
lockType	is the lock type requested
lockDuration	is the duration of the access lock (in seconds)

Returns

0 upon success or a TINE error code.

References de.desy.tine.client.TLinkFactory.setAccessLock().

setMaximumQueryBufferSize()

static short de.desy.tine.queryUtils.TQuery.setMaximumQueryBufferSize ( int  size )

static

Sets the maximum size for use in tine queries.

Parameters

size	is the size in bytes of the buffer used to hold the query information (65000 bytes is the default)

Returns

0 if successful

---

The documentation for this class was generated from the following file:

• TQuery.java