UA Bundle SDK .NET  2.2.1.258
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaServer.IAdvancedNodeManager Interface Reference

Functions that can be used to optimize common operations in a NodeManager. More...

Inherited by UnifiedAutomation.UaServer.BaseNodeManager.

Public Member Functions

NodeMetadata GetNodeMetadata (RequestContext context, BrowseHandle browseHandle, NodeMetadataMask fieldsToReturn, NodeClass nodeClassFilter)
 Gets the node metadata. More...
 
Node GetNodeAttributes (RequestContext context, BrowseHandle browseHandle, NodeClass expectedNodeClass)
 Gets the node attributes. More...
 
DataValue ReadAttribute (RequestContext context, NodeAttributeHandle nodeHandle)
 Reads the attribute. More...
 
ReadValue< T > (RequestContext context, NodeAttributeHandle nodeHandle, QualifiedName componentName, T defaultValue)
 Reads the attribute value for a child node. More...
 
ReadValue< T > (RequestContext context, NodeAttributeHandle nodeHandle, QualifiedName[] browsePath, T defaultValue)
 Reads the attribute value for a child node. More...
 
StatusCode WriteAttribute (RequestContext context, NodeAttributeHandle nodeHandle, Variant valueToWrite)
 Writes the attribute. More...
 
StatusCode WriteValue (RequestContext context, NodeAttributeHandle nodeHandle, QualifiedName componentName, Variant valueToWrite)
 Writes the attribute value for a child node. More...
 
StatusCode WriteValue (RequestContext context, NodeAttributeHandle nodeHandle, QualifiedName[] browsePath, Variant valueToWrite)
 Writes the attribute value for a child node. More...
 

Properties

AdvancedNodeManagerMethods SupportedMethods [get]
 Gets the supported methods. More...
 

Detailed Description

Functions that can be used to optimize common operations in a NodeManager.

Member Function Documentation

Node UnifiedAutomation.UaServer.IAdvancedNodeManager.GetNodeAttributes ( RequestContext  context,
BrowseHandle  browseHandle,
NodeClass  expectedNodeClass 
)

Gets the node attributes.

Parameters
contextThe request context.
browseHandleThe browse handle.
expectedNodeClassThe expected node class.
Returns
The subtype of Node depending on the NodeClass. null if the node is not the expected node class.

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

NodeMetadata UnifiedAutomation.UaServer.IAdvancedNodeManager.GetNodeMetadata ( RequestContext  context,
BrowseHandle  browseHandle,
NodeMetadataMask  fieldsToReturn,
NodeClass  nodeClassFilter 
)

Gets the node metadata.

Parameters
contextThe request context.
browseHandleThe browse handle.
fieldsToReturnThe fields to return.
nodeClassFilterThe node class filter.
Returns
The metadata with only the requested fields. null if the node does not have the requested node class.

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

DataValue UnifiedAutomation.UaServer.IAdvancedNodeManager.ReadAttribute ( RequestContext  context,
NodeAttributeHandle  nodeHandle 
)

Reads the attribute.

Parameters
contextThe request context.
nodeHandleThe node handle.
Returns
The value of the requested attribute. Returns null if the attribute cannot be read with this method (meaning the I/O manager needs to be used).

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

T UnifiedAutomation.UaServer.IAdvancedNodeManager.ReadValue< T > ( RequestContext  context,
NodeAttributeHandle  nodeHandle,
QualifiedName  componentName,
defaultValue 
)

Reads the attribute value for a child node.

Template Parameters
TThe data type of the attribute to read.
Parameters
contextThe request context.
nodeHandleThe node handle.
componentNameName of the component.
defaultValueThe default value.
Returns
The value of the variable identified by the component name. The defaultValue if any error occurs.

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

T UnifiedAutomation.UaServer.IAdvancedNodeManager.ReadValue< T > ( RequestContext  context,
NodeAttributeHandle  nodeHandle,
QualifiedName[]  browsePath,
defaultValue 
)

Reads the attribute value for a child node.

Template Parameters
TThe data type of the value to read.
Parameters
contextThe request context.
nodeHandleThe node handle.
browsePathThe browse path.
defaultValueThe default value.
Returns
The value of the variable identified by the browse path. The defaultValue if any error occurs.

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IAdvancedNodeManager.WriteAttribute ( RequestContext  context,
NodeAttributeHandle  nodeHandle,
Variant  valueToWrite 
)

Writes the attribute.

Parameters
contextThe request context.
nodeHandleThe node handle.
valueToWriteThe value to write.
Returns
Writes the attribute. Returns null if the attribute cannot be written with this method (meaning the I/O manager needs to be used).

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IAdvancedNodeManager.WriteValue ( RequestContext  context,
NodeAttributeHandle  nodeHandle,
QualifiedName  componentName,
Variant  valueToWrite 
)

Writes the attribute value for a child node.

Parameters
contextThe request context.
nodeHandleThe node handle.
componentNameName of the component.
valueToWriteThe value to write.
Returns
The result of the operation.

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

StatusCode UnifiedAutomation.UaServer.IAdvancedNodeManager.WriteValue ( RequestContext  context,
NodeAttributeHandle  nodeHandle,
QualifiedName[]  browsePath,
Variant  valueToWrite 
)

Writes the attribute value for a child node.

Parameters
contextThe request context.
nodeHandleThe node handle.
browsePathThe browse path.
valueToWriteThe value to write.
Returns
The result of the operation.

Implemented in UnifiedAutomation.UaServer.BaseNodeManager.

Property Documentation

AdvancedNodeManagerMethods UnifiedAutomation.UaServer.IAdvancedNodeManager.SupportedMethods
get

Gets the supported methods.


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