C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa_QueryFirstRequest Struct Reference

Asynchronously queries the address space. More...

#include <opcua_types.h>

Public Attributes

OpcUa_ViewDescription View
 Specifies a view and temporal context to a Server.
 
OpcUa_NodeTypeDescriptionNodeTypes
 The node type description.
 
OpcUa_ContentFilter Filter
 Resulting nodes shall be limited to the nodes matching the criteria defined by the filter. More...
 
OpcUa_UInt32 MaxDataSetsToReturn
 The number of QueryDataSets that the Client wants the Server to return in the response and on each subsequent continuation call response. More...
 
OpcUa_UInt32 MaxReferencesToReturn
 The number of references that the Client wants the Server to return in the response for each QueryDataSet and on each subsequent continuation call response. More...
 

Detailed Description

Asynchronously queries the address space.

This Service is used to issue a query request to the Server. The complexity of the query can range from very simple to highly sophisticated. The query can simply request data from instances of a TypeDefinitionNode or TypeDefinitionNode subject to restrictions specified by the filter. On the other hand, the query can request data from instances of related node types by specifying a RelativePath from an originating TypeDefinitionNode.In the filter, a separate set of paths can be constructed for limiting the instances that supply data. A filtering path can include multiple RelatedTo operators to define a multi-hop path between source instances and target instances.

The Client provides an array of NodeTypeDescription which specify the NodeId of a TypeDefinitionNode and selects what attributes are to be returned in the response. A client can also provide a set of RelativePaths through the type system starting from an originating TypeDefinitionNode. Using these paths, the client selects a set of attributes from nodes that are related to instances of the originating TypeDefinitionNode. Additionally, the Client can request the Server return instances of subtypes of TypeDefinitionNodes. If a selected Attribute does not exist in a TypeDefinitionNode but does exist in a subtype, it is assumed to have a null value in the TypeDefinitionNode in question. Therefore, this does not constitute an error condition and a null value is returned for the Attribute.

The Client can use the filter parameter to limit the result set by restricting attributes and properties to certain values. Another way the Client can use a filter to limit the result set is by specifying how instances should be related, using RelatedTo operators. In this case, if an instance at the top of the RelatedTo path cannot be followed to the bottom of the path via specified hops, no QueryDataSets are returned for the starting instance or any of the intermediate instances.

When querying for related instances in the RelativePath, the Client can optionally ask for references. A reference is requested via a RelativePath that only includes a ReferenceType. If all references are desired than the root ReferenceType is listed. These references are returned as part of the QueryDataSets.

Query services allow a special handling of the targetName field in the RelativePath. In several query use cases, a type NodeId is necessary in the path instead of a QualifiedName. Therefore, the Client is allowed to specify a NodeId in the QualifiedName. This is done by setting the namespaceIndex of the targetName to zero and the name part of the targetName to the XML representation of the NodeId. When matching instances are returned as the target node, the target node shall be an instance of the specified type or subtype of the specified type.


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