CVBpy 14.0
BrowseFilter Class Reference

Specifies the parameter of a browse operation on an arbitrary OPCUA node. More...

Inherits object.

Public Member Functions

cvb.opcua.BrowseFilter create (int direction, int reference_type, int max_references, int include_sub_types, int node_class_mask)
 Creates a BrowseFilter object for browsing the OPCUA client. More...
 
cvb.opcua.BrowseFilter create_reference (int reference_type)
 Creates a BrowseFilter object for browsing the OPCUA client. More...
 
cvb.opcua.BrowseFilter create_simple ()
 Creates a BrowseFilter object for browsing the OPCUA client. More...
 

Detailed Description

Specifies the parameter of a browse operation on an arbitrary OPCUA node.

See cvb.opcua.BaseNode.browse method for further understanding.

Member Function Documentation

◆ create()

cvb.opcua.BrowseFilter create ( int  direction,
int  reference_type,
int  max_references,
int  include_sub_types,
int  node_class_mask 
)

Creates a BrowseFilter object for browsing the OPCUA client.

Parameters

direction : int Direction for browsing (see cvb.opcua.ReferenceDirection).

reference_type : int Reference type for the browse, i.e. only items which have the hasChild (or similar) relationship (see cvb.opcua.ReferenceType).

max_references : int Limit for number of references from the start node, elements exceeding the limit will not be included in the result.

include_sub_types : int Should sub-types of the starting node be included or excluded from the browse (see cvb.opcua.BrowseSubType).

node_class_mask : int Bitwise AND of the desired cvb.opcua.NodeClass.

Returns

cvb.opcua.BrowseFilter The specified object.

◆ create_reference()

cvb.opcua.BrowseFilter create_reference ( int  reference_type)

Creates a BrowseFilter object for browsing the OPCUA client.

Equivalent to call the cvb.opcua.BrowseFilter.create method with the following parameters: cvb.opcua.ReferenceDirection.Forward, reference_type, 10000, cvb.opcua.BrowseSubTypes.SubTypesIncluded, and 0 in that order.

Parameters

reference_type : int Reference type for the browse, i.e. only items which have the hasChild (or similar) relationship.

Returns

cvb.opcua.BrowseFilter The specified object.

◆ create_simple()

cvb.opcua.BrowseFilter create_simple ( )

Creates a BrowseFilter object for browsing the OPCUA client.

Equivalent to call the cvb.opcua.BrowseFilter.create method with the following parameters: cvb.opcua.ReferenceDirection.Forward, cvb.opcua.Namespace0NodeID.HIERARCHICALREFERENCES, 10000, cvb.opcua.SubTypesIncluded, and 0 in that order.

Returns

cvb.opcua.BrowseFilter The specified object.