C++ Based OPC UA Client/Server/PubSub SDK
1.7.0.449
|
Interface for OPC UA Object nodes created and managed with the SDK. More...
#include <uabasenodes.h>
Inherits UaNode.
Inherited by OpcUa::BaseObjectType, UaGenericObject, and UaObjectBase.
Public Member Functions | |
UaObject () | |
Construction of the UaObject. More... | |
virtual OpcUa_Byte | eventNotifier () const =0 |
Returns the value of the EventNotifier attribute. More... | |
virtual MethodManager * | getMethodManager (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, NodeAccessInfo *pDefaultPermissions, 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 UaReferenceLists * | getUaReferenceLists () const |
Get the UaReferenceLists interface for the node. More... | |
virtual UaStatus | browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)=0 |
Discover the references of a specified node of a view. More... | |
virtual UaNodeId | typeDefinitionId () const |
Get NodeId of the type definition node for this node. More... | |
virtual UaNodeId | nodeId () const =0 |
Get value of the NodeId attribute of this Node. More... | |
virtual UaQualifiedName | browseName () const =0 |
Get value of the BrowseName attribute of this Node. More... | |
virtual UaLocalizedText | displayName (Session *pSession) const =0 |
Get value of the DisplayName attribute of this Node. More... | |
virtual OpcUa_Boolean | isDescriptionSupported () const =0 |
Flag indicating if the optional attribute Description is supported. More... | |
virtual UaLocalizedText | description (Session *pSession) const =0 |
Get value of the Description attribute of this Node. More... | |
virtual OpcUa_Boolean | isWriteMaskSupported () const =0 |
Flag indicating if the optional attribute WriteMask is supported. More... | |
virtual OpcUa_UInt32 | writeMask () const =0 |
Get value of the WriteMask attribute of this Node. More... | |
virtual OpcUa_Boolean | isUserWriteMaskSupported () const =0 |
Flag indicating if the optional attribute UserWriteMask is supported. More... | |
virtual OpcUa_UInt32 | userWriteMask (Session *pSession) const =0 |
Get value of the UserWriteMask attribute of 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, NodeAccessInfo *pDefaultPermissions, 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 UserDataBase * | getUserData () const |
Returns user data provided by a derived class. More... | |
virtual const NodeAccessInfo * | getAccessInfo () const |
Returns the access info for this node. 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 | |
ChainEntry * | find (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... | |
ChainEntry * | remove (const UaNodeId &key, ChainEntry **ppNext) |
removes an entry from the list. More... | |
ChainEntry * | getNext () 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 | |
Protected Member Functions | |
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 | |
Interface for OPC UA Object nodes created and managed with the SDK.
The class is derived from the interface UaNode. Classes implementing the interface UaObject must also implement the interface UaNode. OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.
For the use of the toolkit level of the SDK where the nodes are managed by the SDK, all Object nodes must implement this interface.
|
protectedvirtual |
Destruction of the UaObject.
The object is reference counted and can not be deleted directly. The methods addReference and releaseReference are used to manage the reference to this object.
UaObject::UaObject | ( | ) |
Construction of the UaObject.
The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.
|
pure virtual |
Returns the value of the EventNotifier attribute.
The EventNotifier Attribute is used to indicate if the Node can be used to subscribe to Events or the read/write historic Events.
The EventNotifier is an 8-bit unsigned integer used as bit field with the following bit fields:
Define | Value | Bit | Description |
---|---|---|---|
OpcUa_EventNotifiers_None | 0x0 | The Object does not produce events and has no event history. | |
OpcUa_EventNotifiers_SubscribeToEvents | 0x1 | 0 | The Object produces event notifications. |
1 | Reserved for future use. Must always be zero. | ||
OpcUa_EventNotifiers_HistoryRead | 0x4 | 2 | The Object has an event history which may be read. |
OpcUa_EventNotifiers_HistoryWrite | 0x8 | 3 | The Object has an event history which may be updated. |
The second two bits also indicate if the history of the Events is available via the OPC UA server.
Implemented in UaObjectVendorServerInfo, UaObjectSessionsDiagnosticsSummary, UaObjectServerDiagnostic, UaModelingRule, UaObjectServerCapabilities, UaGenericObject, UaAreaFolder, OpcUa::BaseObjectType, UaObjectServer, and UaFolder.
|
virtual |
Gets the value of an attribute of the Node.
[in] | pSession | Interface to the Session context for the method call |
[in] | attributeId | Attribute id indicating the attribute to return |
[in] | pDefaultPermissions | Access Permissions for Nodes without explicit permissions configured |
[out] | uaDataValue | The value of the attribute or the status code for the attribute |
Reimplemented from UaNode.
|
virtual |
Get the MethodManager interface for a method of this object.
pMethod | The method object the manager is requested for. |
Reimplemented in UaObjectVendorServerInfo, UaObjectSessionsDiagnosticsSummary, UaObjectServerDiagnostic, UaModelingRule, UaObjectServerCapabilities, UaGenericObject, and OpcUa::BaseObjectType.
|
inlinevirtual |
Get the node class of the Node.
Implements UaNode.
Reimplemented in UaGenericObject.