C++ Based OPC UA Client/Server/PubSub SDK  1.7.4.520
OpcUaDi::LockingServicesTypeBase Class Referenceabstract

Generated base class for a LockingServicesType. More...

#include <opcuadi_lockingservicestypebase.h>

Inherits OpcUa::BaseObjectType.

Inherited by OpcUaDi::LockingServicesType.

Public Member Functions

 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 UaStatus BreakLock (const ServiceContext &serviceContext, OpcUa_Int32 &BreakLockStatus)=0
 
virtual UaStatus ExitLock (const ServiceContext &serviceContext, OpcUa_Int32 &ExitLockStatus)=0
 
virtual UaStatus InitLock (const ServiceContext &serviceContext, const UaString &CurrentContext, OpcUa_Int32 &InitLockStatus)=0
 
virtual UaStatus RenewLock (const ServiceContext &serviceContext, OpcUa_Int32 &RenewLockStatus)=0
 
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 (const UaString &LockingUser)
 Sets the LockingUser value.
 
virtual UaString 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::PropertyTypegetLockedNode ()
 Returns the Locked node.
 
virtual const OpcUa::PropertyTypegetLockedNode () const
 Returns the Locked node.
 
virtual OpcUa::PropertyTypegetLockingClientNode ()
 Returns the LockingClient node.
 
virtual const OpcUa::PropertyTypegetLockingClientNode () const
 Returns the LockingClient node.
 
virtual OpcUa::PropertyTypegetLockingUserNode ()
 Returns the LockingUser node.
 
virtual const OpcUa::PropertyTypegetLockingUserNode () const
 Returns the LockingUser node.
 
virtual OpcUa::PropertyTypegetRemainingLockTimeNode ()
 Returns the RemainingLockTime node.
 
virtual const OpcUa::PropertyTypegetRemainingLockTimeNode () const
 Returns the RemainingLockTime node.
 
virtual OpcUa::BaseMethodgetBreakLock ()
 Returns the BreakLock node.
 
virtual const OpcUa::BaseMethodgetBreakLock () const
 Returns the BreakLock node.
 
virtual OpcUa::BaseMethodgetExitLock ()
 Returns the ExitLock node.
 
virtual const OpcUa::BaseMethodgetExitLock () const
 Returns the ExitLock node.
 
virtual OpcUa::BaseMethodgetInitLock ()
 Returns the InitLock node.
 
virtual const OpcUa::BaseMethodgetInitLock () const
 Returns the InitLock node.
 
virtual OpcUa::BaseMethodgetRenewLock ()
 Returns the RenewLock node.
 
virtual const OpcUa::BaseMethodgetRenewLock () const
 Returns the RenewLock node.
 
virtual void useAccessInfoFromType ()
 Applies the NodeAccessInfo set at the LockingServicesTypeBase and its children. More...
 
void useAccessInfoFromInstance (LockingServicesTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUa::BaseObjectType
 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...
 
UaReferenceListsgetUaReferenceLists () 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...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
virtual OpcUa_Byte eventNotifier () const
 Returns the EventNotifier for the BaseObjectType. More...
 
virtual MethodManagergetMethodManager (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 UserDataBasegetUserData () 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, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from MethodManager
 MethodManager ()
 construction
 
virtual ~MethodManager ()
 destruction
 
- Public Member Functions inherited from UaObject
 UaObject (UaMutexRefCounted *pSharedMutex=NULL)
 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, 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 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...
 

Static Public Member Functions

static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::BaseObjectType
static void clearStaticMembers ()
 Clear the static members of the class.
 

Protected Member Functions

virtual ~LockingServicesTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::BaseObjectType
virtual ~BaseObjectType ()
 Destruction of the BaseObjectType. More...
 
- 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 Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection)
 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

Generated base class for a LockingServicesType.

This class contains the generated base code for the object type LockingServicesType representing an OPC UA ObjectType. This class is used to create the object type and to create and represent instances of the object type in the server address space.

Variable members of the LockingServicesType:

Browse Name DataType TypeDefinition Modelling Rule See Also
DefaultInstanceBrowseName String PropertyType None  
Locked Boolean PropertyType Mandatory getLocked, setLocked
LockingClient String PropertyType Mandatory getLockingClient, setLockingClient
LockingUser String PropertyType Mandatory getLockingUser, setLockingUser
RemainingLockTime Duration PropertyType Mandatory getRemainingLockTime, setRemainingLockTime

Constructor & Destructor Documentation

OpcUaDi::LockingServicesTypeBase::LockingServicesTypeBase ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Constructs an instance of the class LockingServicesTypeBase with all components.

Parameters
[in]pBaseNodeThe "tree" of nodes that specifies the attributes of the instance and its children
[in]pFactoryThe factory to create the children
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

UaStatus OpcUaDi::LockingServicesTypeBase::beginCall ( MethodManagerCallback pCallback,
const ServiceContext serviceContext,
OpcUa_UInt32  callbackHandle,
MethodHandle pMethodHandle,
const UaVariantArray inputArguments 
)
virtual

Call method of an UA object.

Implementation of the MethodManager interface method beginCall.

Reimplemented from OpcUa::BaseObjectType.

virtual UaStatus OpcUaDi::LockingServicesTypeBase::BreakLock ( const ServiceContext serviceContext,
OpcUa_Int32 &  BreakLockStatus 
)
pure virtual
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[out]BreakLockStatusThe DI specific result of the call. 0 - OK, -1 - E_NotLocked - the object is not locked

Implemented in OpcUaDi::LockingServicesType.

virtual UaStatus OpcUaDi::LockingServicesTypeBase::ExitLock ( const ServiceContext serviceContext,
OpcUa_Int32 &  ExitLockStatus 
)
pure virtual
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[out]ExitLockStatusThe DI specific result of the call. 0 - OK, -1 - E_NotLocked - the object is not locked

Implemented in OpcUaDi::LockingServicesType.

virtual UaStatus OpcUaDi::LockingServicesTypeBase::InitLock ( const ServiceContext serviceContext,
const UaString CurrentContext,
OpcUa_Int32 &  InitLockStatus 
)
pure virtual
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]CurrentContextA string used to provide context information about the current activity going on in the Client.
[out]InitLockStatusThe DI specific result of the call. 0 - OK, -1 - E_AlreadyLocked the element is already locked, -2 E_Invalid the element cannot be locked

Implemented in OpcUaDi::LockingServicesType.

virtual UaStatus OpcUaDi::LockingServicesTypeBase::RenewLock ( const ServiceContext serviceContext,
OpcUa_Int32 &  RenewLockStatus 
)
pure virtual
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[out]RenewLockStatusThe DI specific result of the call. 0 - OK, -1 - E_NotLocked - the object is not locked

Implemented in OpcUaDi::LockingServicesType.

void OpcUaDi::LockingServicesTypeBase::useAccessInfoFromInstance ( LockingServicesTypeBase pOther)

Uses the NodeAccessInfo of pOther and its children.

void OpcUaDi::LockingServicesTypeBase::useAccessInfoFromType ( )
virtual

Applies the NodeAccessInfo set at the LockingServicesTypeBase and its children.

Reimplemented from OpcUa::BaseObjectType.


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