C++ UA Server SDK  1.5.0.318
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages

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 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 UaReferenceListsgetUaReferenceLists () 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, 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 access info from another node to this node. More...
 
void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Defines the method to set access info on this node. More...
 
void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Defines the method to set access info on 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...
 
- 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
 

Detailed Description

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.

Constructor & Destructor Documentation

UaObject::~UaObject ( )
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.

Member Function Documentation

virtual OpcUa_Byte UaObject::eventNotifier ( ) const
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:

DefineValueBitDescription
OpcUa_EventNotifiers_None0x0The Object does not produce events and has no event history.
OpcUa_EventNotifiers_SubscribeToEvents0x10The Object produces event notifications.
1Reserved for future use. Must always be zero.
OpcUa_EventNotifiers_HistoryRead0x42The Object has an event history which may be read.
OpcUa_EventNotifiers_HistoryWrite0x83The 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.

Returns
The value of the EventNotifier attribute.

Implemented in UaObjectVendorServerInfo, UaObjectServerDiagnostic, UaModelingRule, UaObjectServerCapabilities, UaGenericObject, UaAreaFolder, OpcUa::BaseObjectType, UaObjectServer, and UaFolder.

void UaObject::getAttributeValue ( Session pSession,
OpcUa_Int32  attributeId,
UaDataValue uaDataValue 
)
virtual

Gets the value of an attribute of the Node.

Parameters
[in]pSessionInterface to the Session context for the method call
[in]attributeIdAttribute id indicating the attribute to return
[out]uaDataValueThe value of the attribute or the status code for the attribute

Reimplemented from UaNode.

MethodManager * UaObject::getMethodManager ( UaMethod pMethod) const
virtual

Get the MethodManager interface for a method of this object.

Parameters
pMethodThe method object the manager is requested for.
Returns
The MethodManager interface responsible for the method.

Reimplemented in UaObjectVendorServerInfo, UaObjectServerDiagnostic, UaModelingRule, UaObjectServerCapabilities, UaGenericObject, and OpcUa::BaseObjectType.

OpcUa_NodeClass UaObject::nodeClass ( ) const
inlinevirtual

Get the node class of the Node.

Returns
The node class Object for the object node.

Implements UaNode.

Reimplemented in UaGenericObject.


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