Book Creator
 Add this page to your book

Book Creator
 Remove this page from your book  

 Manage book (0 page(s))

 Help

~~NOTRANS~~ ====== OpcNodeTypeInfo Members ====== **Namespace:** Opc.UaFx \\ **Assemblies:** Opc.UaFx.Advanced.dll, Opc.UaFx.Advanced.dll \\ The [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] type exposes the following members. ===== Properties ===== ==== BaseType ==== <panel> Gets the type from which the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] directly inherits. **C#** \\ <code csharp> public virtual OpcNodeTypeInfo BaseType { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] \\ An instance of the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] which represents the type from which the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] directly inherits or a null reference (Nothing in Visual Basic) if the type does not inherit from a different [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== Category ==== <panel> Gets the [[Opc.UaFx.OpcAttributeMembers#NodeCategory|NodeCategory]][[Opc.UaFx.OpcAttribute|OpcAttribute]] which identifies the kind of node and is therefore used to classify the node regarding its use and purpose. **C#** \\ <code csharp> public abstract OpcNodeCategory Category { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcNodeCategory|OpcNodeCategory]] \\ One of the members defined by the [[Opc.UaFx.OpcNodeCategory|OpcNodeCategory]] enumeration. </panel> ==== Documentation ==== <panel> Gets any semantic information that would help a human to understand what the type represents. **C#** \\ <code csharp> public virtual string Documentation { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ A human readable text that describes the type and that would help a human to understand what the type represents. </panel> ==== Empty ==== <panel> Gets the type to use if their is no specific type data available. **C#** \\ <code csharp> public static OpcNodeTypeInfo Empty { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] \\ An instance of the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] class which refers to the [[Opc.UaFx.OpcNodeTypeSystemMembers#Empty|Empty]]. </panel> ==== IsAbstract ==== <panel> **C#** \\ <code csharp> public virtual bool IsAbstract { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.boolean|Boolean]] \\ </panel> ==== IsEmpty ==== <panel> Gets a value indicating whether the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] represents a type to use if there is no specific type described. **C#** \\ <code csharp> public virtual bool IsEmpty { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.boolean|Boolean]] \\ The value true if the type does not declare a specific type; otherwise the value false. </panel> ==== IsUnknown ==== <panel> Gets a value indicating whether the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] acts as a placeholder for a referenced type its type declaration could not resolved. **C#** \\ <code csharp> public virtual bool IsUnknown { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.boolean|Boolean]] \\ The value true if the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] acts as a placeholder for an unresolved type declaration; otherwise the value false. </panel> ==== Name ==== <panel> Gets a value which defines the human-readable name of the type represented. A node which represents this [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] uses the [[Opc.UaFx.OpcNodeTypeInfoMembers#Name|Name]] as its [[Opc.UaFx.OpcAttributeMembers#BrowseName|BrowseName]]. **C#** \\ <code csharp> public OpcName Name { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcName|OpcName]] \\ An instance of the [[Opc.UaFx.OpcName|OpcName]] class with the [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] used as the name of the type which does not unambiguously identify the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== SymbolicName ==== <panel> **C#** \\ <code csharp> public virtual string SymbolicName { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ </panel> ==== TypeId ==== <panel> Gets a value which identifies the type represented. A node which represents this [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]] uses the [[Opc.UaFx.OpcNodeTypeInfoMembers#TypeId|TypeId]] as its [[Opc.UaFx.OpcAttributeMembers#NodeId|NodeId]]. **C#** \\ <code csharp> public OpcNodeId TypeId { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcNodeId|OpcNodeId]] \\ An instance of the [[Opc.UaFx.OpcNodeId|OpcNodeId]] class used as the identifier of the type which unambiguously identifies the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== TypeSystem ==== <panel> Gets the the [[Opc.UaFx.OpcNodeTypeSystem|OpcNodeTypeSystem]] which conains the node type declaration represented. **C#** \\ <code csharp> public OpcNodeTypeSystem TypeSystem { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcNodeTypeSystem|OpcNodeTypeSystem]] \\ An instance of the [[Opc.UaFx.OpcNodeTypeSystem|OpcNodeTypeSystem]] class which defines the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== UnderlyingType ==== <panel> Gets the type which provides the implementation of the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. **C#** \\ <code csharp> public Type UnderlyingType { get; } </code> \\ **Property Value** [[https://docs.microsoft.com/en-us/dotnet/api/system.type|Type]] \\ The [[https://docs.microsoft.com/en-us/dotnet/api/system.type|Type]] which implements the type declared or a null reference (Nothing in Visual Basic) if there does not exist a declaration of the type described by this [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== UserWriteAccess ==== <panel> **C#** \\ <code csharp> public virtual OpcAttributeWriteAccess UserWriteAccess { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcAttributeWriteAccess|OpcAttributeWriteAccess]] \\ </panel> ==== WriteAccess ==== <panel> **C#** \\ <code csharp> public virtual OpcAttributeWriteAccess WriteAccess { get; } </code> \\ **Property Value** [[Opc.UaFx.OpcAttributeWriteAccess|OpcAttributeWriteAccess]] \\ </panel> ===== Methods ===== ==== AttributeValue(OpcAttribute) ==== <panel> Retrieves the value of the ''attribute'' specified. **C#** \\ <code csharp> public virtual object AttributeValue(OpcAttribute attribute) </code> \\ **Parameters** ''attribute'' [[Opc.UaFx.OpcAttribute|OpcAttribute]] \\ One of the members defined by the [[Opc.UaFx.OpcAttribute|OpcAttribute]] enumeration which identifies the attribute its value is queried.\\ \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.object|Object]] \\ The value of the ''attribute'' specified or a null reference (Nothing in Visual Basic) in case there the value of the attribute is a null reference or it is not supported by the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== AttributeValue<T>(OpcAttribute) ==== <panel> Retrieves the value of the ''attribute'' specified. **C#** \\ <code csharp> public T AttributeValue<T>(OpcAttribute attribute) </code> \\ **Parameters** ''attribute'' [[Opc.UaFx.OpcAttribute|OpcAttribute]] \\ One of the members defined by the [[Opc.UaFx.OpcAttribute|OpcAttribute]] enumeration which identifies the attribute its value is queried.\\ \\ **Returns** [[Members#T|T]] \\ The value of the ''attribute'' as the type ''T'' specified or the default value of the type ''T'' in case there the value of the attribute is a null reference (Nothing in Visual Basic) or it is not supported by the current [[Opc.UaFx.IOpcNodeInfo|IOpcNodeInfo]]. </panel> ==== Child(OpcName) ==== <panel> **C#** \\ <code csharp> public IOpcNodeInfo Child(OpcName name) </code> \\ **Parameters** ''name'' [[Opc.UaFx.OpcName|OpcName]] \\ \\ \\ **Returns** [[Opc.UaFx.IOpcNodeInfo|IOpcNodeInfo]] \\ </panel> ==== Children() ==== <panel> **C#** \\ <code csharp> public virtual IEnumerable<IOpcNodeInfo> Children() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable|IEnumerable]]<[[Opc.UaFx.IOpcNodeInfo|IOpcNodeInfo]]> \\ </panel> ==== Description(String) ==== <panel> **C#** \\ <code csharp> public OpcText Description(string cultureName) </code> \\ **Parameters** ''cultureName'' [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ \\ \\ **Returns** [[Opc.UaFx.OpcText|OpcText]] \\ </panel> ==== Descriptions() ==== <panel> **C#** \\ <code csharp> public virtual IEnumerable<OpcText> Descriptions() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable|IEnumerable]]<[[Opc.UaFx.OpcText|OpcText]]> \\ </panel> ==== DisplayName(String) ==== <panel> **C#** \\ <code csharp> public OpcText DisplayName(string cultureName) </code> \\ **Parameters** ''cultureName'' [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ \\ \\ **Returns** [[Opc.UaFx.OpcText|OpcText]] \\ </panel> ==== DisplayNames() ==== <panel> **C#** \\ <code csharp> public virtual IEnumerable<OpcText> DisplayNames() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable|IEnumerable]]<[[Opc.UaFx.OpcText|OpcText]]> \\ </panel> ==== GetUnderlyingType() ==== <panel> Retrieves the [[https://docs.microsoft.com/en-us/dotnet/api/system.type|Type]] which provides the implementation of the [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. **C#** \\ <code csharp> protected virtual Type GetUnderlyingType() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.type|Type]] \\ The [[https://docs.microsoft.com/en-us/dotnet/api/system.type|Type]] which implements the type declared or a null reference (Nothing in Visual Basic) if there does not exist a declaration of the type described by this [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel> ==== References() ==== <panel> **C#** \\ <code csharp> public virtual IEnumerable<OpcReference> References() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable|IEnumerable]]<[[Opc.UaFx.OpcReference|OpcReference]]> \\ </panel> ==== ToString() ==== <panel> Returns a [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] representing the [[Opc.UaFx.OpcNodeTypeInfoMembers#Name|Name]] or the [[Opc.UaFx.OpcNodeTypeInfoMembers#UnderlyingType|UnderlyingType]] of the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. **C#** \\ <code csharp> public override string ToString() </code> \\ **Returns** [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] \\ A [[https://docs.microsoft.com/en-us/dotnet/api/system.string|String]] representing the [[Opc.UaFx.OpcNodeTypeInfoMembers#Name|Name]] or the [[Opc.UaFx.OpcNodeTypeInfoMembers#UnderlyingType|UnderlyingType]] of the current [[Opc.UaFx.OpcNodeTypeInfo|OpcNodeTypeInfo]]. </panel>