.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaBase.BrowseDescription Class Reference

A structure defined as the type of the parameter nodesToBrowse of the Browse service. More...

Inherits IFormattable, and UnifiedAutomation.UaBase.IEncodeable.

Public Member Functions

 BrowseDescription ()
 The default constructor. More...
 
virtual void Encode (IEncoder encoder)
 
virtual void Decode (IDecoder decoder)
 
virtual bool IsEqual (IEncodeable encodeable)
 Checks if encodeable is the same object or has the same content More...
 
virtual object Clone ()
 
bool IsReferenceSelected (NodeId referenceTypeId, bool isInverse, ITypeTable typeTable)
 Determines whether the reference selected. More...
 
bool IsNodeClassSelected (NodeClass nodeClass)
 Determines whether [is node class selected] [the specified node class]. More...
 
ReferenceDescription ApplyResultMask (ReferenceDescription reference)
 Applies the result filter (modifies the reference passed in and returns it). More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Returns a System.String that represents this instance. More...
 

Properties

NodeId NodeId [get, set]
 NodeId of the Node to be browsed. More...
 
BrowseDirection BrowseDirection [get, set]
 An enumeration that specifies the direction of References to follow. More...
 
NodeId ReferenceTypeId [get, set]
 Specifies the NodeId of the ReferenceType to follow. More...
 
bool IncludeSubtypes [get, set]
 Indicates whether subtypes of the ReferenceType should be included in the browse. More...
 
uint NodeClassMask [get, set]
 Specifies the NodeClasses of the TargetNodes. More...
 
uint ResultMask [get, set]
 Specifies the fields in the ReferenceDescription structure that should be returned. More...
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
object UserData [get, set]
 Gets or sets the user data. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodable type. More...
 
ExpandedNodeId BinaryEncodingId [get]
 Returns the UA type identifier for the default binary encoding for the type. More...
 
ExpandedNodeId XmlEncodingId [get]
 Returns the UA type identifier for the default XML encoding for the type. More...
 

Detailed Description

A structure defined as the type of the parameter nodesToBrowse of the Browse service.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.BrowseDescription.BrowseDescription ( )
inline

The default constructor.

Member Function Documentation

ReferenceDescription UnifiedAutomation.UaBase.BrowseDescription.ApplyResultMask ( ReferenceDescription  reference)
inline

Applies the result filter (modifies the reference passed in and returns it).

Parameters
referenceThe reference to modify.
Returns
The modified reference.
virtual bool UnifiedAutomation.UaBase.BrowseDescription.IsEqual ( IEncodeable  encodeable)
inlinevirtual

Checks if encodeable is the same object or has the same content

Parameters
encodeable
Returns

Implements UnifiedAutomation.UaBase.IEncodeable.

bool UnifiedAutomation.UaBase.BrowseDescription.IsNodeClassSelected ( NodeClass  nodeClass)
inline

Determines whether [is node class selected] [the specified node class].

Parameters
nodeClassThe node class.
Returns
true if [is node class selected] [the specified node class]; otherwise, false.
bool UnifiedAutomation.UaBase.BrowseDescription.IsReferenceSelected ( NodeId  referenceTypeId,
bool  isInverse,
ITypeTable  typeTable 
)
inline

Determines whether the reference selected.

Parameters
referenceTypeIdThe reference type id.
isInverseiIf TRUE the reference is an inverse reference.
typeTableThe type table.
Returns
TRUE if the reference is selected.
override string UnifiedAutomation.UaBase.BrowseDescription.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.
string UnifiedAutomation.UaBase.BrowseDescription.ToString ( string  format,
IFormatProvider  formatProvider 
)
inline

Returns a System.String that represents this instance.

Parameters
formatThe format.
formatProviderThe format provider.
Returns
A System.String that represents this instance.

Property Documentation

BrowseDirection UnifiedAutomation.UaBase.BrowseDescription.BrowseDirection
getset

An enumeration that specifies the direction of References to follow.

The returned references do indicate the direction the Server followed in the isForward parameter of the ReferenceDescription.

Symmetric references are always considered to be in forward direction, therefore the isForward flag is always set to TRUE and symmetric references are not returned if browseDirection is set to INVERSE_1.

bool UnifiedAutomation.UaBase.BrowseDescription.IncludeSubtypes
getset

Indicates whether subtypes of the ReferenceType should be included in the browse.

If TRUE, then instances of referenceTypeId and all of its subtypes are returned.

uint UnifiedAutomation.UaBase.BrowseDescription.NodeClassMask
getset

Specifies the NodeClasses of the TargetNodes.

Only TargetNodes with the selected NodeClasses are returned. The NodeClasses are assigned the following bits:

Bit Node Class
0 Object
1 Variable
2 Method
3 ObjectType
4 VariableType
5 ReferenceType
6 DataType
7 View

If set to zero, then all NodeClasses are returned.

NodeId UnifiedAutomation.UaBase.BrowseDescription.NodeId
getset

NodeId of the Node to be browsed.

If a view is provided, it shall include this Node.

NodeId UnifiedAutomation.UaBase.BrowseDescription.ReferenceTypeId
getset

Specifies the NodeId of the ReferenceType to follow.

Only instances of this ReferenceType or its subtypes are returned.

If not specified, all References are returned and includeSubtypes is ignored.

uint UnifiedAutomation.UaBase.BrowseDescription.ResultMask
getset

Specifies the fields in the ReferenceDescription structure that should be returned.

The fields are assigned the following bits:

Bit Result
0 ReferenceType
1 IsForward
2 NodeClass
3 BrowseName
4 DisplayName
5 TypeDefinition
object UnifiedAutomation.UaBase.BrowseDescription.UserData
getset

Gets or sets the user data.

The user data.


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