BrowseFilter Class Reference

The BrowseFilter serves to specify the parameter of a browse operation on an OPCUA node object. More...

#include <cvb/opcua/browse_filter.hpp>

Inherits enable_shared_from_this< BrowseFilter >.

Public Member Functions
void *	Handle () const noexcept
	Returns C-API style handle to BaseNode Object. More...

Static Public Member Functions
static BrowseFilterPtr	Create (OpcUa::ReferenceDirection direction, OpcUa::ReferenceType referenceType, std::size_t maxReferences, BrowseSubType subTypes, std::uint32_t nodeClassMask)
	Creates a BrowseFilter for browsing the OPCUA client. More...
static BrowseFilterPtr	Create (OpcUa::ReferenceType referenceTypeID)
	Creates a simpler BrowseFilter for browsing the OPCUA client. More...
static BrowseFilterPtr	Create ()
	Creates an even simpler BrowseFilter for browsing the OPCUA client. More...

Detailed Description

The BrowseFilter serves to specify the parameter of a browse operation on an OPCUA node object.

Note

See OpcUa::Node::Browse

Member Function Documentation

Create() [1/3]

static BrowseFilterPtr Create ( )

inlinestatic

Creates an even simpler BrowseFilter for browsing the OPCUA client.

Note

Equivalent to OpcUa::BrowseFilter::Create(NodeAlgorithm::DepthFirst, BrowseDirection::Forward, OpcUa::NodeID::Create(OpcUa::Namespace0NodeID::HIERARCHICALREFERENCES), 10000, BrowseSubType::SubTypesIncluded);

Returns

the Browsefilter object

Exceptions

Any	exception derived from std::exception including CvbException and OpcUaException.

Examples

OpcUa/BareboneClient, and OpcUa/ServerClientInteraction.

Create() [2/3]

static BrowseFilterPtr Create ( OpcUa::ReferenceDirection  direction, OpcUa::ReferenceType  referenceType, std::size_t  maxReferences, BrowseSubType  subTypes, std::uint32_t  nodeClassMask  )

inlinestatic

Creates a BrowseFilter for browsing the OPCUA client.

Parameters

[in]	direction	forward or backward browsing
[in]	referenceType	reference type for the browse, i.e. only items which have the "hasChild" relationship.
[in]	maxReferences	Limit for number of references from the start node, elements exceeding the limit will not be included in the BrowseResult
[in]	nodeClassMask	Bitwise AND of OpcUa::NodeClass
[in]	subTypes	Include/Exclude sub types of the desired classes

Returns

the Browsefilter object

Exceptions

Any	exception derived from std::exception including CvbException and OpcUaException.

Create() [3/3]

static BrowseFilterPtr Create ( OpcUa::ReferenceType  referenceTypeID )

inlinestatic

Creates a simpler BrowseFilter for browsing the OPCUA client.

Note

Equivalent to OpcUa::BrowseFilter::Create(BrowseDirection::Forward, referenceTypeID, 10000, BrowseSubType::SubTypesIncluded, 0)

Parameters

[in]

referenceTypeID

reference type for the browse, i.e. only items which have the "hasChild" relationship.

Returns

the Browsefilter object

Exceptions

Any	exception derived from std::exception including CvbException and OpcUaException.

Handle()

void * Handle ( ) const

inlinenoexcept

Returns C-API style handle to BaseNode Object.

Returns

C-API handle