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

#include <opcua_shelvedstatemachinetype.h>

Inherits OpcUa::ShelvedStateMachineTypeBase.

Public Types
enum	ShelvedState { Unshelved, OneShotShelved, TimedShelved }
	This enumaration indicates the state of the shelved state machine. More...

Public Member Functions
	ShelvedStateMachineType (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class ShelvedStateMachineType. More...

	ShelvedStateMachineType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Construction of the class ShelvedStateMachineType. More...

	ShelvedStateMachineType (UaBase::Object pBaseNode, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the class ShelvedStateMachineType with all components. More...

virtual UaStatus	OneShotShelve (const ServiceContext &serviceContext)
	ShelvedStateMachineType method OneShotShelve. More...

virtual UaStatus	TimedShelve (const ServiceContext &serviceContext, OpcUa_Double ShelvingTime)
	ShelvedStateMachineType method TimedShelve. More...

virtual UaStatus	Unshelve (const ServiceContext &serviceContext)
	ShelvedStateMachineType method Unshelve. More...

void	setShelvedState (ShelvedState state)
	Sets the state of the exclusice limit state machine.

ShelvedState	getShelvedState ()
	Returns the state of the exclusice limit state machine.

Public Member Functions inherited from OpcUa::ShelvedStateMachineTypeBase
	ShelvedStateMachineTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an ShelvedStateMachineType object using an instance declaration node as base.

	ShelvedStateMachineTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an ShelvedStateMachineType object.

	ShelvedStateMachineTypeBase (UaBase::Object pBaseNode, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the class ShelvedStateMachineTypeBase with all components. More...

virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the ShelvedStateMachineType.

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	setUnshelveTime (OpcUa_Double UnshelveTime)
	Sets the UnshelveTime.

virtual OpcUa_Double	getUnshelveTime () const
	Gets the UnshelveTime.

virtual OpcUa::PropertyType *	getUnshelveTimeNode ()
	Returns the UnshelveTime node.

Public Member Functions inherited from OpcUa::FiniteStateMachineType
	FiniteStateMachineType (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Construction of the class FiniteStateMachineType. More...

	FiniteStateMachineType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Construction of the class FiniteStateMachineType. More...

	FiniteStateMachineType (UaBase::Object pBaseNode, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the class FiniteStateMachineType with all components. More...

virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the FiniteStateMachineType.

virtual void	setCurrentState (const UaLocalizedText &currentState)
	Sets the CurrentState.

virtual UaLocalizedText	getCurrentState (Session *pSession)
	Gets the CurrentState.

virtual void	setLastTransition (const UaLocalizedText &lastTransition)
	Sets the LastTransition.

virtual UaLocalizedText	getLastTransition (Session *pSession)
	Gets the LastTransition.

virtual OpcUa::FiniteStateVariableType *	getCurrentStateNode ()
	Returns the CurrentState node.

virtual OpcUa::FiniteTransitionVariableType *	getLastTransitionNode ()
	Returns the LastTransition node. 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...

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.

Public Member Functions inherited from MethodManager
	MethodManager ()
	construction

virtual	~MethodManager ()
	destruction

Public Member Functions inherited from UaObject
	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...

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...

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...

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 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...

Static Public Member Functions
static void	createTypes ()
	Create the type related static members of the class.

static void	clearStaticMembers ()
	Clear the static members of the class.

Static Public Member Functions inherited from OpcUa::ShelvedStateMachineTypeBase
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::FiniteStateMachineType
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	~ShelvedStateMachineType ()
	Destruction.

Protected Member Functions inherited from OpcUa::ShelvedStateMachineTypeBase
virtual	~ShelvedStateMachineTypeBase ()
	Destruction.

Protected Member Functions inherited from OpcUa::FiniteStateMachineType
virtual	~FiniteStateMachineType ()
	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

Additional Inherited Members
Protected Attributes inherited from UaReferenceLists
UaReference *	m_pTargetNodes
	List of references to target nodes where this node is the source node. More...

UaReference *	m_pLastTargetNode
	Last references in the list of references to the target nodes. More...

UaReference *	m_pSourceNodes
	List of references to source nodes where this node is the target node. More...

Detailed Description

Class implementing the UaObject interface for the ShelvedStateMachineType.

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 ShelvedStateMachineType defines a sub-state machine that represents an advanced Alarm filtering model.

The state model supports two types of Shelving: OneShotShelving and TimedShelving.Shelving is an Operator initiated activity.

In OneShotShelving, a user requests that an Alarm be Shelved for its current Active state. This type of Shelving is typically used when an Alarm is continually occurring on a boundary (i.e. a Condition is jumping between High Alarm and HighHigh Alarm, always in the Active state). The One Shot Shelving will automatically clear when an Alarm returns to an inactive state. Another use for this type of Shelving is for a plant area that is shut down i.e. a long running Alarm such as a low level Alarm for a tank that is not in use. When the tank starts operation again the Shelving state will automatically clear.

In TimedShelving, a user specifies that an Alarm be shelved for a fixed time period. This type of Shelving is quite often used to block nuisance Alarms. For example, an Alarm that occurs more than ten times in a minute may get shelved for a few minutes.

In all states, the Unshelve can be called to cause a transition to the Unshelve state; this includes Un-shelving an Alarm that is in the TimedShelve state before the time has expired and the OneShotShelve state without a transition to an inactive state.

All but two transitions are caused by Method calls. The “Time Expired” transition is simply a system generated transition that occurs when the time value defined as part of the “Timed Shelved Call” has expired. The “Any Transition Occurs” transition is also a system generated transition; this transition is generated when the Condition goes to an inactive state.

The ShelvedStateMachine includes a hierarchy of sub-states. It supports all transitions between Unshelved, OneShotShelved and TimedShelved.

UnshelveTime specifies the remaining time in milliseconds until the Alarm automatically transitions into the Un-shelved state. For the TimedShelved state this time is initialised with the ShelvingTime argument of the TimedShelve Method call. For the OneShotShelved state the UnshelveTime will be a constant set to the maximum Duration except if a MaxTimeShelved Property is provided.

This FiniteStateMachine supports three Active states; Unshelved, TimedShelved and OneShotShelved. It also supports six transitions.This FiniteStateMachine also supports three Methods; TimedShelve, OneShotShelve and Unshelve.

Member Enumeration Documentation

enum OpcUa::ShelvedStateMachineType::ShelvedState

This enumaration indicates the state of the shelved state machine.

Enumerator
Unshelved	Unshelved state
OneShotShelved	OneShotShelved state
TimedShelved	TimedShelved state

Constructor & Destructor Documentation

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

Construction of the class ShelvedStateMachineType.

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::ShelvedStateMachineType::ShelvedStateMachineType	(	const UaNodeId &	nodeId,
		const UaString &	name,
		OpcUa_UInt16	browseNameNameSpaceIndex,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = `NULL`
	)

Construction of the class ShelvedStateMachineType.

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::ShelvedStateMachineType::ShelvedStateMachineType	(	UaBase::Object *	pBaseNode,
		XmlUaNodeFactoryManager *	pFactory,
		NodeManagerConfig *	pNodeConfig,
		UaMutexRefCounted *	pSharedMutex = `NULL`
	)

Constructs an instance of the class ShelvedStateMachineType 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

Member Function Documentation

OpcUa::ShelvedStateMachineType::OneShotShelve ( const ServiceContext & serviceContext )

virtual

ShelvedStateMachineType method OneShotShelve.

OneShotShelve sets the AlarmCondition to the OneShotShelved state.

OpcUa::ShelvedStateMachineType::TimedShelve	(	const ServiceContext &	serviceContext,
		OpcUa_Double	ShelvingTime
	)

virtual

ShelvedStateMachineType method TimedShelve.

TimedShelve sets the AlarmCondition to the TimedShelved state.

OpcUa::ShelvedStateMachineType::Unshelve ( const ServiceContext & serviceContext )

virtual

ShelvedStateMachineType method Unshelve.

Unshelve sets the AlarmCondition to the Unshelved state.

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

D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_shelvedstatemachinetype.h
D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_shelvedstatemachinetype.cpp
D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/z_doc/opcuaconditiontypes.dox

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation