C++ Based OPC UA Client/Server SDK  1.5.5.355

Provides a base class to implement an Object The object is able to register it's own components at his node manager Derived from UaObject and UaReferenceLists It is not possible to create shallow copies of this Class. More...

#include <uaobjecttypes.h>

Inherits UaObject, and UaReferenceLists.

Inherited by UaFolder, UaModelingRule, UaObjectServer, UaObjectServerCapabilities, UaObjectServerDiagnostic, and UaObjectVendorServerInfo.

Public Member Functions

 UaObjectBase (const UaString &name, const UaNodeId &newNodeId, const UaString &defaultLocaleId)
 construction
 
UaReferenceListsgetUaReferenceLists () const
 Get a ReferenceList where all the Nodes are in. More...
 
virtual UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *pSession) 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 *pSession) 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 *pSession) const
 Check if Node has a userWriteMask. More...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
- Public Member Functions inherited from UaObject
 UaObject ()
 Construction of the UaObject. More...
 
virtual OpcUa_Byte eventNotifier () const =0
 Returns the value of the EventNotifier attribute. More...
 
virtual MethodManagergetMethodManager (UaMethod *pMethod) const
 Get the MethodManager interface for a method of this object. More...
 
OpcUa_NodeClass nodeClass () const
 Get the node class of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode ()
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual UaNodeId typeDefinitionId () const
 Get NodeId of the type definition node for this node. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the 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...
 
const NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
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 ~UaObjectBase ()
 destruction
 
- Protected Member Functions inherited from UaObject
virtual ~UaObject ()
 Destruction of the UaObject. More...
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 

Protected Attributes

UaString m_defaultLocaleId
 Default localeId for the object. More...
 
- 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

Provides a base class to implement an Object The object is able to register it's own components at his node manager Derived from UaObject and UaReferenceLists It is not possible to create shallow copies of this Class.

Member Function Documentation

UaStatus UaObjectBase::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.

UaQualifiedName UaObjectBase::browseName ( ) const
virtual

Get the browseName of the current Node.

Returns
the browseName of the current Node.

Implements UaNode.

UaLocalizedText UaObjectBase::description ( Session pSession) const
virtual

Get the description as LocalizedText of the current Node.

Parameters
pSessionInterface to the Session context for the method call
Returns
the LocalizedText of the current Node.

Implements UaNode.

UaLocalizedText UaObjectBase::displayName ( Session pSession) const
virtual

Get the displayName as LocalizedText of the current Node.

Parameters
pSessionInterface to the Session context for the method call
Returns
the LocalizedText of the current Node.

Implements UaNode.

UaNode* UaObjectBase::getUaNode ( ) const
inlinevirtual

Get the UaNode interface pointer of this node.

Implements UaReferenceLists.

UaReferenceLists* UaObjectBase::getUaReferenceLists ( ) const
inlinevirtual

Get a ReferenceList where all the Nodes are in.

Returns
a ReferenceList where all the Nodes are in.

Reimplemented from UaNode.

OpcUa_Boolean UaObjectBase::isDescriptionSupported ( ) const
virtual

Check if Node is DescriptionSupported.

Returns
FALSE if not supported.

Implements UaNode.

OpcUa_Boolean UaObjectBase::isUserWriteMaskSupported ( ) const
virtual

Check if Node is UserWriteMaskSupported.

Returns
TRUE if Node is UserWriteMaskSupported.

Implements UaNode.

OpcUa_Boolean UaObjectBase::isWriteMaskSupported ( ) const
virtual

Check if Node is WriteMaskSupported.

Returns
TRUE if Node is WriteMaskSupported.

Implements UaNode.

UaNodeId UaObjectBase::nodeId ( ) const
virtual

Get the NodeId of the current Node.

Returns
the NodeId of the current Node.

Implements UaNode.

OpcUa_UInt32 UaObjectBase::userWriteMask ( Session pSession) const
virtual

Check if Node has a userWriteMask.

Parameters
pSessionInterface to the Session context for the method call
Returns
the userWriteMask.

Implements UaNode.

OpcUa_UInt32 UaObjectBase::writeMask ( ) const
virtual

Get the writeMask of the current Node.

Returns
the writeMask.

Implements UaNode.

Member Data Documentation

UaString UaObjectBase::m_defaultLocaleId
protected

Default localeId for the object.

MemberVar.


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