OpcUa::ExclusiveLimitStateMachineType Class Reference

Class implementing the UaObject interface for the ExclusiveLimitStateMachineType. More...

#include <opcua_exclusivelimitstatemachinetype.h>

Inherits OpcUa::FiniteStateMachineType.

Public Types
enum	ExclusiveState {   Disabled, HighHigh, High, Low,   LowLow }
	This enumaration indicates the state of the exclusice limit state machine. More...

Public Member Functions
	ExclusiveLimitStateMachineType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class ExclusiveLimitStateMachineType. More...
	ExclusiveLimitStateMachineType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class ExclusiveLimitStateMachineType. More...
	ExclusiveLimitStateMachineType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the class ExclusiveLimitStateMachineType with all components. More...
virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the ExclusiveLimitStateMachineType.
void	setExclusiveState (ExclusiveState state)
	Sets the state of the exclusice limit state machine.
ExclusiveState	getExclusiveState ()
	Returns the state of the exclusice limit state machine.

Static Public Member Functions
static void	createTypes ()
	Create the related type nodes.

Protected Member Functions
virtual	~ExclusiveLimitStateMachineType ()
	Destruction.

Detailed Description

Class implementing the UaObject interface for the ExclusiveLimitStateMachineType.

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.

The ExclusiveLimitStateMachineType defines the state machine used by AlarmTypes that handle multiple mutually exclusive limits. It is created by extending the FiniteStateMachineType.

The ExclusiveLimitStateMachine defines the sub state machine that represents the actual level of a multilevel Alarm when it is in the Active state. The sub state machine defined here includes High, Low, HighHigh and LowLow states. This model also includes in its transition state a series of transitions to and from a parent state, the inactive state. This state machine as it is defined shall be used as a sub state machine for a state machine which has an Active state. This Active state could be part of a “level” Alarm or “deviation” Alarm or any other Alarm state machine.

The LowLow, Low, High, HighHigh are typical for many industries. Vendors can introduce sub-state models that include additional limits; they may also omit limits in an instance.

Member Enumeration Documentation

enum OpcUa::ExclusiveLimitStateMachineType::ExclusiveState

This enumaration indicates the state of the exclusice limit state machine.

Enumerator
Disabled	The sub state machine is not enabled
HighHigh	HighHigh state
High	High state
Low	Low state
LowLow	LowLow state

Constructor & Destructor Documentation

OpcUa::ExclusiveLimitStateMachineType::ExclusiveLimitStateMachineType	(	const UaNodeId &	nodeId,
		UaObject *	pInstanceDeclarationObject,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = NULL
	)

Construction of the class ExclusiveLimitStateMachineType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.
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.

Parameters

[in]	nodeId	NodeId of the new object
[in]	pInstanceDeclarationObject	UaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]	pNodeConfig	Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]	pSharedMutex	Shared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided

OpcUa::ExclusiveLimitStateMachineType::ExclusiveLimitStateMachineType	(	const UaNodeId &	nodeId,
		const UaString &	name,
		OpcUa_UInt16	browseNameNameSpaceIndex,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = NULL
	)

Construction of the class ExclusiveLimitStateMachineType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class. 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.

Parameters

[in]	nodeId	NodeId of the new object
[in]	name	Name of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]	browseNameNameSpaceIndex	Namespace index used for the browse name
[in]	pNodeConfig	Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]	pSharedMutex	Shared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided

OpcUa::ExclusiveLimitStateMachineType::ExclusiveLimitStateMachineType	(	UaBase::Object *	pBaseNode,
		XmlUaNodeFactoryManager *	pFactory,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = NULL
	)

Constructs an instance of the class ExclusiveLimitStateMachineType with all components.

Parameters

[in]	pBaseNode	The "tree" of nodes that specifies the attributes of the instance and its children
[in]	pFactory	The factory to create the children
[in]	pNodeConfig	Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]	pSharedMutex	Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

---

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

• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_exclusivelimitstatemachinetype.h
• /home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_exclusivelimitstatemachinetype.cpp