.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaBase.Node Class Reference

More...

Inherits IFormattable, and UnifiedAutomation.UaBase.IEncodeable.

Inherited by UnifiedAutomation.UaBase.InstanceNode, and UnifiedAutomation.UaBase.TypeNode.

Public Member Functions

 Node ()
 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 ()
 
void UnsetAccessRestriction ()
 Unset the AccessRestriction to use the default of the namespace. More...
 
void AddReference (NodeId referenceTypeId, bool isInverse, ExpandedNodeId targetId, bool checkForDuplicates)
 Adds the reference. More...
 
bool RemoveReference (NodeId referenceTypeId, bool isInverse, ExpandedNodeId targetId)
 Removes the reference. More...
 
bool ReferenceExists (NodeId referenceTypeId, bool isInverse, ExpandedNodeId targetId)
 References the exists. More...
 
List< ReferenceNodeFindReferences (NodeId referenceTypeId, bool isInverse)
 Finds the references. More...
 
List< ReferenceNodeFindReferences (NodeId referenceTypeId, bool isInverse, bool includeSubtypes, ITypeTable typeTable)
 Finds the references. More...
 
List< ReferenceNodeFindAllReferences ()
 Finds all references of the node. More...
 
ReferenceNode FindSingleReference (NodeId referenceTypeId, bool isInverse, int index)
 Finds the single reference. More...
 
ReferenceNode FindSingleReference (NodeId referenceTypeId, bool isInverse, bool includeSubtypes, ITypeTable typeTable, int index)
 Finds the single reference. More...
 
virtual bool HasAttribute (uint attributeId)
 Determines whether the specified attribute id has attribute. More...
 
virtual StatusCode Read (IList< string > locales, uint attributeId, RequestEncoding messageEncoding, out Variant value)
 Reads the specified attribute. More...
 
virtual StatusCode Write (uint attributeId, object value)
 Reads the specified attribute. More...
 
virtual NodeAttributes GetAttributes ()
 Gets the attributes. 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...
 

Protected Member Functions

LocalizedText ChooseTranslation (IList< string > locales, IList< LocalizedText > translations, LocalizedText defaultText)
 Chooses the translation. More...
 
List< LocalizedTextUpdateTranslation (List< LocalizedText > translations, LocalizedText newText)
 Updates the translation. More...
 
void GetNodeAttributes (NodeAttributes attributes)
 Updates the attributes with the values for the node. More...
 

Properties

NodeId NodeId [get, set]
 
NodeClass NodeClass [get, set]
 
QualifiedName BrowseName [get, set]
 
LocalizedText DisplayName [get, set]
 
LocalizedText Description [get, set]
 
uint WriteMask [get, set]
 
uint UserWriteMask [get, set]
 
RolePermissionTypeCollection UserRolePermissions [get, set]
 
ReferenceNodeCollection References [get, set]
 
virtual ExpandedNodeId TypeId [get]
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
virtual ExpandedNodeId XmlEncodingId [get]
 
RolePermissionTypeCollection RolePermissions [get, set]
 
bool IsRolePermissionsSet [get]
 Indicates if the optional RolePermissions attribute has been set. More...
 
ushort AccessRestrictions [get, set]
 
bool IsAccessRestrictionsSet [get]
 Indicates if the optional AccessRestrictions attribute has been set. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 
List< LocalizedTextDisplayNameTranslations [get, set]
 Gets or sets the translations for the display name. More...
 
List< LocalizedTextDescriptionTranslations [get, set]
 Gets or sets the translations for the description. More...
 
INodeAccessInfo Permissions [get, set]
 The permissions assigned to the node. More...
 
IRolePermissions IRolePermissions [get, set]
 The RolePermissions for an optimized access. More...
 
List< XmlElementExtensions [get, set]
 Extensions that are serialized with the node. More...
 
ReferenceTable ReferenceTable [get]
 Gets the an indexed table of references. More...
 
- Properties inherited from UnifiedAutomation.UaBase.IEncodeable
ExpandedNodeId TypeId [get]
 Returns the UA type identifier for the encodeable 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

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.Node.Node ( )

The default constructor.

Member Function Documentation

void UnifiedAutomation.UaBase.Node.AddReference ( NodeId  referenceTypeId,
bool  isInverse,
ExpandedNodeId  targetId,
bool  checkForDuplicates 
)

Adds the reference.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
targetIdThe target id.
checkForDuplicatesif set to true raise an exception if the reference already exists.
LocalizedText UnifiedAutomation.UaBase.Node.ChooseTranslation ( IList< string >  locales,
IList< LocalizedText translations,
LocalizedText  defaultText 
)
protected

Chooses the translation.

Parameters
localesThe locales.
translationsThe translations.
defaultTextThe default text.
Returns
The translation.
List<ReferenceNode> UnifiedAutomation.UaBase.Node.FindAllReferences ( )

Finds all references of the node.

Returns
A copy of the list of references.
List<ReferenceNode> UnifiedAutomation.UaBase.Node.FindReferences ( NodeId  referenceTypeId,
bool  isInverse 
)

Finds the references.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
Returns
List<ReferenceNode> UnifiedAutomation.UaBase.Node.FindReferences ( NodeId  referenceTypeId,
bool  isInverse,
bool  includeSubtypes,
ITypeTable  typeTable 
)

Finds the references.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
includeSubtypesif set to true [include subtypes].
typeTableThe type table.
Returns
ReferenceNode UnifiedAutomation.UaBase.Node.FindSingleReference ( NodeId  referenceTypeId,
bool  isInverse,
int  index 
)

Finds the single reference.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
indexThe index.
Returns
ReferenceNode UnifiedAutomation.UaBase.Node.FindSingleReference ( NodeId  referenceTypeId,
bool  isInverse,
bool  includeSubtypes,
ITypeTable  typeTable,
int  index 
)

Finds the single reference.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
includeSubtypesif set to true [include subtypes].
typeTableThe type table.
indexThe index.
Returns
void UnifiedAutomation.UaBase.Node.GetNodeAttributes ( NodeAttributes  attributes)
protected

Updates the attributes with the values for the node.

virtual bool UnifiedAutomation.UaBase.Node.HasAttribute ( uint  attributeId)
virtual

Determines whether the specified attribute id has attribute.

Parameters
attributeIdThe attribute id.
Returns
true if the specified attribute id has attribute; otherwise, false.

Reimplemented in UnifiedAutomation.UaBase.VariableNode, UnifiedAutomation.UaBase.VariableTypeNode, UnifiedAutomation.UaBase.MethodNode, UnifiedAutomation.UaBase.DataTypeNode, UnifiedAutomation.UaBase.ViewNode, UnifiedAutomation.UaBase.ObjectNode, and UnifiedAutomation.UaBase.ObjectTypeNode.

virtual StatusCode UnifiedAutomation.UaBase.Node.Read ( IList< string >  locales,
uint  attributeId,
RequestEncoding  messageEncoding,
out Variant  value 
)
virtual

Reads the specified attribute.

Parameters
localesThe locales.
attributeIdThe attribute id.
messageEncodingThe MessageEncoding
valueThe value.
Returns
The attribute value.

Reimplemented in UnifiedAutomation.UaBase.VariableNode, UnifiedAutomation.UaBase.VariableTypeNode, UnifiedAutomation.UaBase.MethodNode, UnifiedAutomation.UaBase.DataTypeNode, UnifiedAutomation.UaBase.ReferenceTypeNode, UnifiedAutomation.UaBase.ViewNode, UnifiedAutomation.UaBase.ObjectNode, and UnifiedAutomation.UaBase.ObjectTypeNode.

bool UnifiedAutomation.UaBase.Node.ReferenceExists ( NodeId  referenceTypeId,
bool  isInverse,
ExpandedNodeId  targetId 
)

References the exists.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
targetIdThe target id.
Returns
bool UnifiedAutomation.UaBase.Node.RemoveReference ( NodeId  referenceTypeId,
bool  isInverse,
ExpandedNodeId  targetId 
)

Removes the reference.

Parameters
referenceTypeIdThe reference type id.
isInverseSet to true if the reference is an inverse reference.
targetIdThe target id.
override string UnifiedAutomation.UaBase.Node.ToString ( )

Returns a System.String that represents this instance.

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

Returns a System.String that represents this instance.

Parameters
formatThe format.
formatProviderThe format provider.
Returns
A System.String that represents this instance.
void UnifiedAutomation.UaBase.Node.UnsetAccessRestriction ( )

Unset the AccessRestriction to use the default of the namespace.

List<LocalizedText> UnifiedAutomation.UaBase.Node.UpdateTranslation ( List< LocalizedText translations,
LocalizedText  newText 
)
protected

Updates the translation.

Parameters
translationsThe translations.
newTextThe new text.
virtual StatusCode UnifiedAutomation.UaBase.Node.Write ( uint  attributeId,
object  value 
)
virtual

Property Documentation

ushort UnifiedAutomation.UaBase.Node.AccessRestrictions
getset

QualifiedName UnifiedAutomation.UaBase.Node.BrowseName
getset

LocalizedText UnifiedAutomation.UaBase.Node.Description
getset

List<LocalizedText> UnifiedAutomation.UaBase.Node.DescriptionTranslations
getset

Gets or sets the translations for the description.

The translations for the description.

LocalizedText UnifiedAutomation.UaBase.Node.DisplayName
getset

List<LocalizedText> UnifiedAutomation.UaBase.Node.DisplayNameTranslations
getset

Gets or sets the translations for the display name.

The translations for the display name.

List<XmlElement> UnifiedAutomation.UaBase.Node.Extensions
getset

Extensions that are serialized with the node.

IRolePermissions UnifiedAutomation.UaBase.Node.IRolePermissions
getset

The RolePermissions for an optimized access.

bool UnifiedAutomation.UaBase.Node.IsAccessRestrictionsSet
get

Indicates if the optional AccessRestrictions attribute has been set.

bool UnifiedAutomation.UaBase.Node.IsRolePermissionsSet
get

Indicates if the optional RolePermissions attribute has been set.

NodeClass UnifiedAutomation.UaBase.Node.NodeClass
getset

NodeId UnifiedAutomation.UaBase.Node.NodeId
getset

INodeAccessInfo UnifiedAutomation.UaBase.Node.Permissions
getset

The permissions assigned to the node.

ReferenceNodeCollection UnifiedAutomation.UaBase.Node.References
getset

ReferenceTable UnifiedAutomation.UaBase.Node.ReferenceTable
get

Gets the an indexed table of references.

The reference table.

This property should be used instead of References property because it is more efficient.

RolePermissionTypeCollection UnifiedAutomation.UaBase.Node.RolePermissions
getset

object UnifiedAutomation.UaBase.Node.UserData
getset

Gets or sets the user data.

The user data.

RolePermissionTypeCollection UnifiedAutomation.UaBase.Node.UserRolePermissions
getset

uint UnifiedAutomation.UaBase.Node.UserWriteMask
getset

uint UnifiedAutomation.UaBase.Node.WriteMask
getset


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