Inherits OpcUaDi::LockingServicesTypeBase.
|
| LockingServicesType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Construction of the class LockingServicesType. More...
|
|
| LockingServicesType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Construction of the class LockingServicesType. More...
|
|
| LockingServicesType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Constructs an instance of the class LockingServicesType with all components. More...
|
|
virtual UaStatus | BreakLock (const ServiceContext &serviceContext, OpcUa_Int32 &BreakLockStatus) |
| LockingServicesType method BreakLock. More...
|
|
virtual UaStatus | ExitLock (const ServiceContext &serviceContext, OpcUa_Int32 &ExitLockStatus) |
| LockingServicesType method ExitLock. More...
|
|
virtual UaStatus | InitLock (const ServiceContext &serviceContext, const UaString &CurrentContext, OpcUa_Int32 &InitLockStatus) |
| LockingServicesType method InitLock. More...
|
|
virtual UaStatus | RenewLock (const ServiceContext &serviceContext, OpcUa_Int32 &RenewLockStatus) |
| LockingServicesType method RenewLock. More...
|
|
void | setLockingServices (LockingServicesCallback *pCallback) |
| Sets the callback for the LockingServices interface implementation.
|
|
| LockingServicesTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Constructs an LockingServicesType object using an instance declaration node as base.
|
|
| LockingServicesTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Constructs an LockingServicesType object.
|
|
| LockingServicesTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Constructs an instance of the class LockingServicesTypeBase with all components. More...
|
|
virtual UaNodeId | typeDefinitionId () const |
| Returns the type definition NodeId for the LockingServicesType.
|
|
virtual UaStatus | beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments) |
| Call method of an UA object. More...
|
|
virtual UaStatus | call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag) |
| Synchronous version of the MethodManager method call executed in a worker thread.
|
|
virtual void | setLocked (OpcUa_Boolean Locked) |
| Sets the Locked value.
|
|
virtual OpcUa_Boolean | getLocked () const |
| Returns the value of Locked.
|
|
virtual void | setLockingClient (const UaString &LockingClient) |
| Sets the LockingClient value.
|
|
virtual UaString | getLockingClient () const |
| Returns the value of LockingClient.
|
|
virtual void | setLockingUser (OpcUa_Boolean LockingUser) |
| Sets the LockingUser value.
|
|
virtual OpcUa_Boolean | getLockingUser () const |
| Returns the value of LockingUser.
|
|
virtual void | setRemainingLockTime (OpcUa_Double RemainingLockTime) |
| Sets the RemainingLockTime value.
|
|
virtual OpcUa_Double | getRemainingLockTime () const |
| Returns the value of RemainingLockTime.
|
|
virtual OpcUa::PropertyType * | getLockedNode () |
| Returns the Locked node.
|
|
virtual OpcUa::PropertyType * | getLockingClientNode () |
| Returns the LockingClient node.
|
|
virtual OpcUa::PropertyType * | getLockingUserNode () |
| Returns the LockingUser node.
|
|
virtual OpcUa::PropertyType * | getRemainingLockTimeNode () |
| Returns the RemainingLockTime node.
|
|
virtual OpcUa::BaseMethod * | getBreakLock () |
| Returns the BreakLock node.
|
|
virtual OpcUa::BaseMethod * | getExitLock () |
| Returns the ExitLock node.
|
|
virtual OpcUa::BaseMethod * | getInitLock () |
| Returns the InitLock node.
|
|
virtual OpcUa::BaseMethod * | getRenewLock () |
| Returns the RenewLock node.
|
|
| BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Construction of the class BaseObjectType. More...
|
|
| BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) |
| Construction of the class BaseObjectType. More...
|
|
UaReferenceLists * | getUaReferenceLists () const |
| Get the UaReferenceLists interface for the node. 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...
|
|
UaNode * | getUaNode () const |
| Get the UaNode interface pointer of this node. More...
|
|
virtual UaNodeId | typeDefinitionId () const |
| Returns the type definition NodeId for the BaseObjectType.
|
|
virtual OpcUa_Byte | eventNotifier () const |
| Returns the EventNotifier for the BaseObjectType. More...
|
|
virtual MethodManager * | getMethodManager (UaMethod *pMethod) const |
| Returns the method manager interface for the BaseObjectType instance. More...
|
|
virtual void | setUserData (UserDataBase *pUserData) |
| Method to set user data stored in this class. More...
|
|
virtual UserDataBase * | getUserData () const |
| Method to get the user data stored in this class. More...
|
|
virtual void | setBrowseName (const UaQualifiedName &browseName) |
| Sets the browse name attribute value. More...
|
|
virtual void | setDisplayName (const UaLocalizedText &displayName) |
| Sets the display name attribute value. More...
|
|
virtual void | setDescription (const UaLocalizedText &description) |
| Sets the description attribute value. More...
|
|
virtual void | setWriteMask (OpcUa_UInt32 writeMask) |
| Sets the write mask attribute value. More...
|
|
virtual void | setEventNotifier (OpcUa_Byte eventNotifier) |
| Sets the eventNotifier attribute value. More...
|
|
virtual void | setModellingRuleId (const UaNodeId &modellingRuleId) |
| Set NodeId of the modeling rule for this node. More...
|
|
virtual UaNodeId | modellingRuleId () const |
| Get NodeId of the modeling rule for this node. More...
|
|
void | setMethodManager (MethodManager *pMethodManager) |
| Allows a class aggregating the object to implement the MethodManager for this object. 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 UaStatus | beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments) |
| Implementation of the MethodManager interface method beginCall.
|
|
virtual UaStatus | call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag) |
| Synchronous version of the MethodManager method call executed in a worker thread.
|
|
| MethodManager () |
| construction
|
|
virtual | ~MethodManager () |
| destruction
|
|
| UaObject () |
| Construction of the UaObject. 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...
|
|
| UaNode () |
| Construction of the UaNode. More...
|
|
virtual UaNodeId | getKey () const |
| Get the key of the node used for the hash table. More...
|
|
| 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...
|
|
| ReferenceCounter () |
| construction
|
|
virtual | ~ReferenceCounter () |
| destruction
|
|
| 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 UaReference * | pTargetNodes () const |
| Returns the list of references to target nodes. More...
|
|
virtual const UaReference * | pSourceNodes () const |
| Returns the list of references to source nodes. More...
|
|
virtual UaNode * | getTargetNodeByBrowseName (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...
|
|
Class implementing the UaObject interface for the LockingServicesType.
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.
Locking is the means to avoid concurrent modifications to a Device or Network and their components. Clients shall use the locking services if they need to make a set of changes (for example, several write operations and Method invocations) and where a consistent state is available only after all of these changes have been performed. The main purpose of locking a Device is avoiding concurrent modifications. The main purpose of locking a Network is avoiding concurrent topology changes.
A Lock from one Client usually allows other Clients to view (navigate / read) the locked element. Servers may choose to implement an exclusive locking where other Clients have no access at all (e.g. in cases where even read operations require certain settings in a Device).
When locking a Device, the lock applies to the complete device (including all components like blocks or modules).
When locking a Modular Device, the lock applies to the complete Device (including all modules). Equally, when locking a block-oriented Device (see 9.2), the lock applies to the complete Device (including all Blocks). Servers may allow independent locking of Sub-Devices or Blocks, respectively, if no lock is applied to the top-level Device (for Modular Device or for Block Device).
If the Online / Offline model is supported, the lock always applies to both the online and the offline version.
When locking a Network, the lock applies to the Network and all connected Devices. If any of the connected Devices provides access to a sub-ordinate Network (like a gateway), the sub-ordinate Network and its connected Devices are locked as well.