UA Bundle SDK .NET  2.1.2.227
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaBase.Node Class Reference

Specifies the attributes which belong to all nodes. 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)
 
 
virtual object Clone ()
 
 
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...
 
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, 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]
 A unique identifier for the node. More...
 
NodeClass NodeClass [get, set]
 The class of the node. More...
 
QualifiedName BrowseName [get, set]
 The browse name of the node. More...
 
LocalizedText DisplayName [get, set]
 The display name of the node. More...
 
LocalizedText Description [get, set]
 The description of the node. More...
 
uint WriteMask [get, set]
 A mask indicating which attributes are writeable. More...
 
uint UserWriteMask [get, set]
 A mask indicating which attributes are writeable by the current user. More...
 
ReferenceNodeCollection References [get, set]
 The references that belong to the node. More...
 
virtual ExpandedNodeId TypeId [get]
 
 
virtual ExpandedNodeId BinaryEncodingId [get]
 
 
virtual ExpandedNodeId XmlEncodingId [get]
 
 
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...
 
- 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

Specifies the attributes which belong to all nodes.

<exclude>

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 [check for duplicates].
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.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.MethodNode, UnifiedAutomation.UaBase.DataTypeNode, UnifiedAutomation.UaBase.ObjectNode, UnifiedAutomation.UaBase.ObjectTypeNode, UnifiedAutomation.UaBase.VariableTypeNode, and UnifiedAutomation.UaBase.ViewNode.

virtual StatusCode UnifiedAutomation.UaBase.Node.Read ( IList< string >  locales,
uint  attributeId,
out Variant  value 
)
virtual
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.
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

QualifiedName UnifiedAutomation.UaBase.Node.BrowseName
getset

The browse name of the node.

LocalizedText UnifiedAutomation.UaBase.Node.Description
getset

The description of the node.

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

The display name of the node.

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

Gets or sets the translations for the display name.

The translations for the display name.

NodeClass UnifiedAutomation.UaBase.Node.NodeClass
getset

The class of the node.

NodeId UnifiedAutomation.UaBase.Node.NodeId
getset

A unique identifier for the node.

ReferenceNodeCollection UnifiedAutomation.UaBase.Node.References
getset

The references that belong to the node.

object UnifiedAutomation.UaBase.Node.UserData
getset

Gets or sets the user data.

The user data.

uint UnifiedAutomation.UaBase.Node.UserWriteMask
getset

A mask indicating which attributes are writeable by the current user.

uint UnifiedAutomation.UaBase.Node.WriteMask
getset

A mask indicating which attributes are writeable.


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