TQuery is a singleton class offering static methods to acquire information from the control system elements.
More...
|
| static int | GetPropertyInformation (string dev, string prp, ref PrpQueryStruct[] pqs, ref int num) |
| | Returns a list of property query information struct associated with the specified device server, target property More...
|
| |
| static String[] | GetStockProperties () |
| | Retrieves a list of available stock properties More...
|
| |
| static String[] | GetSystemContexts () |
| | Retrieves a list of server contexts via query to the Equipment Name Server. More...
|
| |
| static String[] | GetSystemDevices (String server, String property) |
| | Retrieves a list of device names associated with a given property via query to the server specified. More...
|
| |
| static String[] | GetSystemDevices (String server, String property, ref Boolean hasPropertyQueryPrecedence) |
| | Retrieves a list of device names associated with a given property via query to the server specified. More...
|
| |
| static String[] | GetSystemProperties (String server) |
| | Retrieves a list of properties via query to the server given. More...
|
| |
| static String[] | GetSystemProperties (String server, ref Boolean hasDeviceQueryPrecedence) |
| | Retrieves a list of properties via query to the server given. More...
|
| |
| static String[] | GetSystemProperties (String server, ref Boolean hasDeviceQueryPrecedence, PropertyQueryType flags) |
| | Retrieves a list of properties via query to the server given. More...
|
| |
| static String[] | GetSystemServers (String context) |
| | Retrieves a list of device servers via query to the Equipment Name Server. More...
|
| |
TQuery is a singleton class offering static methods to acquire information from the control system elements.
◆ GetPropertyInformation()
| static int tine.TQuery.GetPropertyInformation |
( |
string |
dev, |
|
|
string |
prp, |
|
|
ref PrpQueryStruct[] |
pqs, |
|
|
ref int |
num |
|
) |
| |
|
inlinestatic |
Returns a list of property query information struct associated with the specified device server, target property
- Parameters
-
| dev | the device server name for which the property information is to be made |
| prp | the property for which the property information is desired |
| pqs | the struct with the property information |
| num | |
- Returns
- 0 on success or a TINE error code
◆ GetStockProperties()
| static String [] tine.TQuery.GetStockProperties |
( |
| ) |
|
|
inlinestatic |
Retrieves a list of available stock properties
- Returns
- a list of available stock properties
◆ GetSystemContexts()
| static String [] tine.TQuery.GetSystemContexts |
( |
| ) |
|
|
inlinestatic |
Retrieves a list of server contexts via query to the Equipment Name Server.
This call retrieves a list of all server context managed by the Equipment Name Server
- Returns
- A string array containing the desired context list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
◆ GetSystemDevices() [1/2]
| static String [] tine.TQuery.GetSystemDevices |
( |
String |
server, |
|
|
String |
property |
|
) |
| |
|
inlinestatic |
Retrieves a list of device names associated with a given property via query to the server specified.
This call retrieves a list of all device names registered on the server associated with the property specified in the call. A classic device server will export its behavior through its properties, and export its "instances" through its "device names", according to the motto "All devices found on this
server have the same set of properties, and all properties apply to any device found on this server". For certain classes of server (in particular middle layer servers) the properties exported might refer to 'apples' and 'oranges' simply because the server is archiving them. Or there might be other reasons why the device list associated with a particular property has little or nothing to do with that associated with some other property. Use this call to obtain the device list associated with a particular property.
- Parameters
-
| server | is the full device server name for which the property query is to be made |
| property | is the property for which the device list is desired. |
- Returns
- A string array containing the desired device list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
◆ GetSystemDevices() [2/2]
| static String [] tine.TQuery.GetSystemDevices |
( |
String |
server, |
|
|
String |
property, |
|
|
ref Boolean |
hasPropertyQueryPrecedence |
|
) |
| |
|
inlinestatic |
Retrieves a list of device names associated with a given property via query to the server specified.
This call retrieves a list of all device names registered on the server associated with the property specified in the call. A classic device server will export its behavior through its properties, and export its "instances" through its "device names", according to the motto "All devices found on this
server have the same set of properties, and all properties apply to any device found on this server". For certain classes of server (in particular middle layer servers) the properties exported might refer to 'apples' and 'oranges' simply because the server is archiving them. Or there might be other reasons why the device list associated with a particular property has little or nothing to do with that associated with some other property. Use this call to obtain the device list associated with a particular property.
- Parameters
-
| server | is the full device server name for which the property query is to be made |
| property | is the property for which the device list is desired. |
| hasPropertyQueryPrecedence | denotes whether the target server is using property query precedence. |
- Returns
- A string array containing the desired device list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
References tine.TLink.Execute().
◆ GetSystemProperties() [1/3]
| static String [] tine.TQuery.GetSystemProperties |
( |
String |
server | ) |
|
|
inlinestatic |
Retrieves a list of properties via query to the server given.
This call retrieves a list of all properties registered on the server associated with full device server name specified. A classic device server will export its behavior through its properties, and export its "instances" through its "device names", according to the motto "All devices found on this server have the same set of properties, and all properties apply to any device found on this server". In this case, simply specifying the device server name as the first input parameter will return the set of properties valid for all devices registered on the server. Under some circumstances, however, the set of properties associated with a particular device might be different from device to device. If this is the case, the full device server name should be used as the first parameter, where the target device name is also sent as part of the query.
- Parameters
-
| server | is the full device server name for which the property query is to be made |
- Returns
- A string array containing the desired property list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
Referenced by tine.TTrace.GetProperties().
◆ GetSystemProperties() [2/3]
| static String [] tine.TQuery.GetSystemProperties |
( |
String |
server, |
|
|
ref Boolean |
hasDeviceQueryPrecedence |
|
) |
| |
|
inlinestatic |
Retrieves a list of properties via query to the server given.
This call retrieves a list of all properties registered on the server associated with full device server name specified. A classic device server will export its behavior through its properties, and export its "instances" through its "device names", according to the motto "All devices found on this server have the same set of properties, and all properties apply to any device found on this server". In this case, simply specifying the device server name as the first input parameter will return the set of properties valid for all devices registered on the server. Under some circumstances, however, the set of properties associated with a particular device might be different from device to device. If this is the case, the full device server name should be used as the first parameter, where the target device name is also sent as part of the query.
- Parameters
-
| server | is the full device server name for which the property query is to be made |
| hasDeviceQueryPrecedence | indicates whether the target server is using device query precedence |
- Returns
- A string array containing the desired property list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
◆ GetSystemProperties() [3/3]
| static String [] tine.TQuery.GetSystemProperties |
( |
String |
server, |
|
|
ref Boolean |
hasDeviceQueryPrecedence, |
|
|
PropertyQueryType |
flags |
|
) |
| |
|
inlinestatic |
Retrieves a list of properties via query to the server given.
This call retrieves a list of all properties registered on the server associated with full device server name specified. A classic device server will export its behavior through its properties, and export its "instances" through its "device names", according to the motto "All devices found on this server have the same set of properties, and all properties apply to any device found on this server". In this case, simply specifying the device server name as the first input parameter will return the set of properties valid for all devices registered on the server. Under some circumstances, however, the set of properties associated with a particular device might be different from device to device. If this is the case, the full device server name should be used as the first parameter, where the target device name is also sent as part of the query.
- Parameters
-
| server | is the full device server name for which the property query is to be made |
| hasDeviceQueryPrecedence | indicates whether the target server is using device query precedence |
| flags | provides specific query instructions as to registered, stock and meta properties |
- Returns
- A string array containing the desired property list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
◆ GetSystemServers()
| static String [] tine.TQuery.GetSystemServers |
( |
String |
context | ) |
|
|
inlinestatic |
Retrieves a list of device servers via query to the Equipment Name Server.
This call retrieves a list of all Front End Computer Names (FECs) associated with the server context given. In addition, the context string can carry a targeted subsystem for a more specific list.
- Parameters
-
| context | is the context for which the query is to be made. A narrower query can also be made, where only servers belonging to a specific subsystem are returned. If this is desired, then pass a context string of the form 'context/subsystem' (e.g. "PETRA/DIAG"). |
- Returns
- A string array containing the desired server list. On error, throw an exception containing the reason for the exception as a string, as well as the error code (embedded between angle brackets).
The documentation for this class was generated from the following file:
