.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaClient.CacheManager Class Reference

Maintains a local cache of nodes and their attribute values. More...

Inherits UnifiedAutomation.UaBase.ITypeTable.

Public Member Functions

 CacheManager (Session session)
 Initializes a new instance of the CacheManager class. More...
 
string GetDisplayText (ExpandedNodeId nodeId)
 Gets the display text. More...
 
string GetDisplayText (NodeId nodeId)
 Gets the display text. More...
 
NodeId GetDisplayText (NodeId rootId, string browsePath)
 Gets the node id which is the target of the browse path. More...
 
NodeId GetNodeId (NodeId rootId, params QualifiedName[] browsePath)
 Gets the node id which is the target of the browse path (follows hierarchical references). More...
 
string GetEnumerationText (NodeId nodeId, DataValue value)
 Gets the display text for the enumerated value. More...
 
string GetEnumerationText (NodeId nodeId, Variant value)
 Gets the display text for the enumerated value. More...
 
string GetEnumerationText (NodeId nodeId, int enumValue, string defaultText)
 Gets the display text for the enumerated value. More...
 
List< NodeIdGetAvailableDataEncodings (NodeId nodeId)
 Gets the available data encodings. More...
 
GetAttribute< T > (NodeId nodeId, uint attributeId, T defaultValue)
 Gets the attribute. More...
 
void Clear ()
 Clears the cache. More...
 
void Clear (NodeId nodeId)
 Clears the cached information for the specified node. More...
 
bool IsKnown (ExpandedNodeId typeId)
 Determines whether a node id is a known type id. More...
 
bool IsKnown (NodeId typeId)
 Determines whether a node id is a known type id. More...
 
NodeId FindSuperType (ExpandedNodeId typeId)
 Returns the immediate supertype for the type. More...
 
NodeId FindSuperType (NodeId typeId)
 Returns the immediate supertype for the type. More...
 
bool IsTypeOf (ExpandedNodeId subTypeId, ExpandedNodeId superTypeId)
 Determines whether a type is a subtype of another type. More...
 
bool IsTypeOf (NodeId subTypeId, NodeId superTypeId)
 Determines whether a type is a subtype of another type. More...
 
QualifiedName FindReferenceTypeName (NodeId referenceTypeId)
 Returns the node identifier for the reference type with the specified browse name. More...
 
NodeId FindReferenceType (QualifiedName referenceTypeName)
 Returns the qualified name for the reference type id. More...
 
NodeId FindDataTypeId (ExpandedNodeId encodingId)
 Returns the data type for the specified encoding. More...
 
NodeId FindDataTypeId (NodeId encodingId)
 Returns the data type for the specified encoding. More...
 

Properties

RequestSettings DefaultRequestSettings [get, set]
 Gets or sets the default request settings. More...
 

Detailed Description

Maintains a local cache of nodes and their attribute values.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.CacheManager.CacheManager ( Session  session)

Initializes a new instance of the CacheManager class.

Parameters
sessionThe session.

Member Function Documentation

void UnifiedAutomation.UaClient.CacheManager.Clear ( )

Clears the cache.

void UnifiedAutomation.UaClient.CacheManager.Clear ( NodeId  nodeId)

Clears the cached information for the specified node.

Parameters
nodeIdThe node id.
NodeId UnifiedAutomation.UaClient.CacheManager.FindDataTypeId ( ExpandedNodeId  encodingId)

Returns the data type for the specified encoding.

Parameters
encodingIdThe encoding id.
Returns

Implements UnifiedAutomation.UaBase.ITypeTable.

NodeId UnifiedAutomation.UaClient.CacheManager.FindDataTypeId ( NodeId  encodingId)

Returns the data type for the specified encoding.

Parameters
encodingIdThe encoding id.
Returns
The data type for the encodingId

Implements UnifiedAutomation.UaBase.ITypeTable.

NodeId UnifiedAutomation.UaClient.CacheManager.FindReferenceType ( QualifiedName  referenceTypeName)

Returns the qualified name for the reference type id.

Parameters
referenceTypeNameName of the reference type.
Returns
The identifier for the referenceTypeName

Implements UnifiedAutomation.UaBase.ITypeTable.

QualifiedName UnifiedAutomation.UaClient.CacheManager.FindReferenceTypeName ( NodeId  referenceTypeId)

Returns the node identifier for the reference type with the specified browse name.

Parameters
referenceTypeIdThe reference type id.
Returns
A name qualified with a namespace for the reference referenceTypeId .

Implements UnifiedAutomation.UaBase.ITypeTable.

NodeId UnifiedAutomation.UaClient.CacheManager.FindSuperType ( ExpandedNodeId  typeId)

Returns the immediate supertype for the type.

Parameters
typeIdThe extended type identifier.
Returns
A type identifier of the typeId

Implements UnifiedAutomation.UaBase.ITypeTable.

NodeId UnifiedAutomation.UaClient.CacheManager.FindSuperType ( NodeId  typeId)

Returns the immediate supertype for the type.

Parameters
typeIdThe type identifier.
Returns
The immediate supertype identifier for typeId

Implements UnifiedAutomation.UaBase.ITypeTable.

T UnifiedAutomation.UaClient.CacheManager.GetAttribute< T > ( NodeId  nodeId,
uint  attributeId,
defaultValue 
)

Gets the attribute.

Template Parameters
T
Parameters
nodeIdThe node id.
attributeIdThe attribute id.
defaultValueThe default value.
Returns
The attribute value, the defaultValue if the attribute is not found.
List<NodeId> UnifiedAutomation.UaClient.CacheManager.GetAvailableDataEncodings ( NodeId  nodeId)

Gets the available data encodings.

Parameters
nodeIdThe variable or data type node id.
Returns
The available encodings. Null if none are available.
string UnifiedAutomation.UaClient.CacheManager.GetDisplayText ( ExpandedNodeId  nodeId)

Gets the display text.

Parameters
nodeIdThe node id.
Returns
string UnifiedAutomation.UaClient.CacheManager.GetDisplayText ( NodeId  nodeId)

Gets the display text.

Parameters
nodeIdThe node id.
Returns
NodeId UnifiedAutomation.UaClient.CacheManager.GetDisplayText ( NodeId  rootId,
string  browsePath 
)

Gets the node id which is the target of the browse path.

Parameters
rootIdThe root id.
browsePathThe browse path.
Returns
string UnifiedAutomation.UaClient.CacheManager.GetEnumerationText ( NodeId  nodeId,
DataValue  value 
)

Gets the display text for the enumerated value.

Parameters
nodeIdThe variable or data type node id.
valueThe value.
Returns
The text for the enumerated value.
string UnifiedAutomation.UaClient.CacheManager.GetEnumerationText ( NodeId  nodeId,
Variant  value 
)

Gets the display text for the enumerated value.

Parameters
nodeIdThe variable or data type node id.
valueThe value.
Returns
The text for the enumerated value.
string UnifiedAutomation.UaClient.CacheManager.GetEnumerationText ( NodeId  nodeId,
int  enumValue,
string  defaultText 
)

Gets the display text for the enumerated value.

Parameters
nodeIdThe variable or data type node id.
enumValueThe enum value.
defaultTextThe default text.
Returns
The text for the enumerated value.
NodeId UnifiedAutomation.UaClient.CacheManager.GetNodeId ( NodeId  rootId,
params QualifiedName[]  browsePath 
)

Gets the node id which is the target of the browse path (follows hierarchical references).

Parameters
rootIdThe root id.
browsePathThe browse path.
Returns
bool UnifiedAutomation.UaClient.CacheManager.IsKnown ( ExpandedNodeId  typeId)

Determines whether a node id is a known type id.

Parameters
typeIdThe type extended identifier.
Returns
true if the specified type id is known; otherwise, false.

Implements UnifiedAutomation.UaBase.ITypeTable.

bool UnifiedAutomation.UaClient.CacheManager.IsKnown ( NodeId  typeId)

Determines whether a node id is a known type id.

Parameters
typeIdThe type identifier.
Returns
true if the specified type id is known; otherwise, false.

Implements UnifiedAutomation.UaBase.ITypeTable.

bool UnifiedAutomation.UaClient.CacheManager.IsTypeOf ( ExpandedNodeId  subTypeId,
ExpandedNodeId  superTypeId 
)

Determines whether a type is a subtype of another type.

Parameters
subTypeIdThe subtype identifier.
superTypeIdThe supertype identifier.
Returns
true if superTypeId is supertype of subTypeId ; otherwise, false.

Implements UnifiedAutomation.UaBase.ITypeTable.

bool UnifiedAutomation.UaClient.CacheManager.IsTypeOf ( NodeId  subTypeId,
NodeId  superTypeId 
)

Determines whether a type is a subtype of another type.

Parameters
subTypeIdThe subtype identifier.
superTypeIdThe supertype identifier.
Returns
true if superTypeId is supertype of subTypeId ; otherwise, false.

Implements UnifiedAutomation.UaBase.ITypeTable.

Property Documentation

RequestSettings UnifiedAutomation.UaClient.CacheManager.DefaultRequestSettings
getset

Gets or sets the default request settings.

The default request settings.


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