UnifiedAutomation.UaBase.BrowseDescription Class Reference

A request to browse the the references from a node. 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)
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]
	The id of the node to browse. More...
BrowseDirection	BrowseDirection [get, set]
	The direction of the references to return. More...
NodeId	ReferenceTypeId [get, set]
	The type of references to return. More...
bool	IncludeSubtypes [get, set]
	Includes subtypes of the reference type. More...
uint	NodeClassMask [get, set]
	A mask indicating which node classes to return. 0 means return all nodes. More...
uint	ResultMask [get, set]
	A mask indicating which fields should be returned in the results. 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 request to browse the the references from a node.

<exclude>

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.BrowseDescription.BrowseDescription

(

)

The default constructor.

Member Function Documentation

ReferenceDescription UnifiedAutomation.UaBase.BrowseDescription.ApplyResultMask

(

ReferenceDescription

reference

)

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

Parameters

reference

The reference to modify.

Returns

The modified reference.

bool UnifiedAutomation.UaBase.BrowseDescription.IsNodeClassSelected

(

NodeClass

nodeClass

)

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

Parameters

nodeClass

The 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
	)

Determines whether the reference selected.

Parameters

referenceTypeId	The reference type id.
isInverse	iIf TRUE the reference is an inverse reference.
typeTable	The type table.

Returns

TRUE if the reference is selected.

override string UnifiedAutomation.UaBase.BrowseDescription.ToString

(

)

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
	)

Returns a System.String that represents this instance.

Parameters

format	The format.
formatProvider	The format provider.

Returns

A System.String that represents this instance.

Property Documentation

BrowseDirection UnifiedAutomation.UaBase.BrowseDescription.BrowseDirection

getset

The direction of the references to return.

bool UnifiedAutomation.UaBase.BrowseDescription.IncludeSubtypes

getset

Includes subtypes of the reference type.

uint UnifiedAutomation.UaBase.BrowseDescription.NodeClassMask

getset

A mask indicating which node classes to return. 0 means return all nodes.

NodeId UnifiedAutomation.UaBase.BrowseDescription.NodeId

getset

The id of the node to browse.

NodeId UnifiedAutomation.UaBase.BrowseDescription.ReferenceTypeId

getset

The type of references to return.

uint UnifiedAutomation.UaBase.BrowseDescription.ResultMask

getset

A mask indicating which fields should be returned in the results.

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:

• C:/work/uasdknet/src/UaBase/Generated/Opc.Ua.DataTypes.cs
• C:/work/uasdknet/src/UaBase/Helpers/BrowseDescription.cs