C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

Derived from UaMethod and UaReferenceLists. More...

#include <uagenericnodes.h>

Inherits UaMethod, and UaReferenceLists.

Public Member Functions

 UaGenericMethod (const UaNodeId &nodeId, const UaQualifiedName &browseName, const UaLocalizedText &displayName, const UaLocalizedText &description, OpcUa_Boolean executable, OpcUa_Boolean userExecutable, UaMutexRefCounted *pSharedMutex=NULL)
 construction
 
UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName as QualifiedName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *) const
 Get the displayName as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isDescriptionSupported () const
 Check if Node is DescriptionSupported. More...
 
virtual UaLocalizedText description (Session *) const
 Get the description as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isWriteMaskSupported () const
 Check if Node is WriteMaskSupported. More...
 
virtual OpcUa_UInt32 writeMask () const
 Get the writeMask of the current Node. More...
 
virtual OpcUa_Boolean isUserWriteMaskSupported () const
 Check if Node is UserWriteMaskSupported. More...
 
virtual OpcUa_UInt32 userWriteMask (Session *) const
 Get the WriteMask of the User. More...
 
virtual OpcUa_Boolean executable () const
 Indicates if Method is executable. More...
 
virtual OpcUa_Boolean userExecutable (Session *) const
 Indicates if method is executable by the user. More...
 
OpcUa_NodeClass nodeClass () const
 Get the NodeClass of the current Node. More...
 
UaNodeId typeDefinitionId () const
 Get the object type NodeId for the server object. More...
 
UaNodegetUaNode () const
 Get the Node. More...
 
UaReferenceListsgetUaReferenceLists () const
 Get a ReferenceList where all the Nodes are in. More...
 
virtual void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the write mask attribute.
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaMethod
 UaMethod (UaMutexRefCounted *pSharedMutex=NULL)
 construction
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Defines the method to set user data handled by a derived class. More...
 
virtual UserDataBasegetUserData () const
 Returns user data provided by a derived class. More...
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
virtual bool hasAccessInfo () const
 Check if this UaNode has a NodeAccessInfo assigned. More...
 
virtual void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
virtual void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
virtual void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (const UaNodeId &key, ChainEntry **ppPrevious)
 finds the right entry in the chain. More...
 
void add (ChainEntry *pNewEntry)
 adds a new entry to the list. More...
 
void prepend (ChainEntry *pNewEntry)
 prepends a new entry to the list. More...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. More...
 
virtual void setInvalid ()
 Set the entry to invalid. More...
 
void clearChain ()
 Clear the chain when the hashtable is cleared.
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 
- Public Member Functions inherited from UaReferenceLists
 UaReferenceLists ()
 Constructs the reference lists object.
 
virtual ~UaReferenceLists ()
 Destroys the reference lists object.
 
virtual UaStatus browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaStatus translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
 Find a node based on an element of an relative path. More...
 
virtual const UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (const UaQualifiedName &browseName) const
 Searches a target node with the passed browse name and returns the UaNode interface if found. More...
 
virtual void addTargetNode (UaReference *pReference)
 Add a reference to a target node where this node is the source node. More...
 
virtual void addSourceNode (UaReference *pReference)
 Adds a reference to a source node where this node is the target node. More...
 
virtual UaStatus removeSourceNode (UaReference *pReferenceToRemove)
 Remove a reference to a source node where this node is the target node. More...
 
virtual bool removeSourceReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a source node. More...
 
virtual UaStatus removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual UaStatus removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual bool removeTargetReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a target node. More...
 
virtual UaStatus removeCrossNodeManagerRef (NodeManager *pNodeManager)
 Remove references to another NodeManager. More...
 
virtual UaStatus invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
 Set all references from SourceNodes to this Node invalid. More...
 
virtual UaStatus invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
 Set all references to TargetNode of this node invalid. More...
 
virtual UaStatus deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
 Deletes all child nodes. More...
 

Protected Member Functions

virtual ~UaGenericMethod ()
 destruction
 
- Protected Member Functions inherited from UaMethod
virtual ~UaMethod ()
 destruction
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 
- Protected Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
 Collect a list of all child nodes. More...
 

Additional Inherited Members

- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

Derived from UaMethod and UaReferenceLists.

Member Function Documentation

UaStatus UaGenericMethod::browse ( const ServiceContext serviceContext,
BrowseContext browseContext,
UaReferenceDescriptions References 
)
virtual

Discover the references of a specified node of a view.

This method is used to return a list of references and target nodes for the passed node to browse for the services Browse and BrowseNext.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
browseContextBrowse context for the first browse or the following browse with continuation point.
ReferencesArray of ReferenceDescription results for the browsed node.
Returns
Error code

Implements UaNode.

virtual UaQualifiedName UaGenericMethod::browseName ( ) const
inlinevirtual

Get the browseName as QualifiedName of the current Node.

Returns
the BrowseName for the DataVariable as QualifiedName.

Implements UaNode.

virtual UaLocalizedText UaGenericMethod::description ( Session ) const
inlinevirtual

Get the description as LocalizedText of the current Node.

Returns
the LocalizedText of the current Node.

Implements UaNode.

virtual UaLocalizedText UaGenericMethod::displayName ( Session ) const
inlinevirtual

Get the displayName as LocalizedText of the current Node.

Returns
the LocalizedText of the current Node.

Implements UaNode.

virtual OpcUa_Boolean UaGenericMethod::executable ( ) const
inlinevirtual

Indicates if Method is executable.

Returns
TRUE if executable FALSE if not.

Implements UaMethod.

UaNode* UaGenericMethod::getUaNode ( ) const
inlinevirtual

Get the Node.

Returns
the current searched Node.

Implements UaReferenceLists.

UaReferenceLists* UaGenericMethod::getUaReferenceLists ( ) const
inlinevirtual

Get a ReferenceList where all the Nodes are in.

Returns
a ReferenceList where all the Nodes are in.

Reimplemented from UaNode.

virtual OpcUa_Boolean UaGenericMethod::isDescriptionSupported ( ) const
inlinevirtual

Check if Node is DescriptionSupported.

Returns
FALSE if not supported.

Implements UaNode.

virtual OpcUa_Boolean UaGenericMethod::isUserWriteMaskSupported ( ) const
inlinevirtual

Check if Node is UserWriteMaskSupported.

Returns
TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

virtual OpcUa_Boolean UaGenericMethod::isWriteMaskSupported ( ) const
inlinevirtual

Check if Node is WriteMaskSupported.

Returns
TRUE if Node is WriteMaskSupported.

Implements UaNode.

OpcUa_NodeClass UaGenericMethod::nodeClass ( ) const
inlinevirtual

Get the NodeClass of the current Node.

Returns
the NodeClass of the current Node.

Reimplemented from UaMethod.

virtual UaNodeId UaGenericMethod::nodeId ( ) const
inlinevirtual

Get the NodeId of the current Node.

Returns
the NodeId of the current Node.

Implements UaNode.

UaStatus UaGenericMethod::setAttributeValue ( Session pSession,
OpcUa_Int32  attributeId,
const UaDataValue dataValue,
NodeAccessInfo pDefaultPermissions,
OpcUa_Boolean  checkWriteMask 
)
virtual

Sets the value of an attribute of the Node.

Returns
Status code
Parameters
[in]pSessionInterface to the Session context for the method call
[in]attributeIdAttribute id indicating the attribute to set
[in]dataValueNew value for the attribute
[in]pDefaultPermissionsAccess Permissions for Nodes without explicit permissions configured
[out]checkWriteMaskFlag indicating if the write mask of the node should be checked before setting the new value

Reimplemented from UaNode.

UaNodeId UaGenericMethod::typeDefinitionId ( ) const
inlinevirtual

Get the object type NodeId for the server object.

Returns
the object type NodeId for the server object.

Reimplemented from UaNode.

virtual OpcUa_Boolean UaGenericMethod::userExecutable ( Session ) const
inlinevirtual

Indicates if method is executable by the user.

Returns
TRUE if UserExecutable FALSE if not.

Implements UaMethod.

virtual OpcUa_UInt32 UaGenericMethod::userWriteMask ( Session ) const
inlinevirtual

Get the WriteMask of the User.

Returns
the WriteMask of the User.

Implements UaNode.

virtual OpcUa_UInt32 UaGenericMethod::writeMask ( ) const
inlinevirtual

Get the writeMask of the current Node.

Returns
the writeMask.

Implements UaNode.


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