Generated base class for a AlarmConditionType. More...

#include <opcua_alarmconditiontypebase.h>

Inherits OpcUa::AcknowledgeableConditionType.

Public Member Functions
	AlarmConditionTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the AlarmConditionType condition type using an instance declaration node as base.

	AlarmConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the AlarmConditionType condition type.

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

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

virtual void	getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
	Get the field value for the passed index. More...

void	clearFieldData ()
	Clears the event field data after event processing.

UaNodeId	createBranch ()
	Creates a new branch from the current state and adds the branch to a list managed by the condition object. More...

virtual void	setActiveState (OpcUa_Boolean activeState)

virtual UaLocalizedText	getActiveState ()

virtual void	setActiveStateStatus (OpcUa_StatusCode status)
	Set a status code for the event field ActiveState. More...

virtual void	setInputNode (const UaNodeId &InputNode)
	Sets the InputNode value. More...

virtual UaNodeId	getInputNode () const
	Returns the value of InputNode. More...

virtual void	setInputNodeStatus (OpcUa_StatusCode status)
	Set a status code for the event field InputNode. More...

virtual void	setMaxTimeShelved (OpcUa_Double MaxTimeShelved)
	Sets the MaxTimeShelved value. More...

virtual OpcUa_Double	getMaxTimeShelved () const
	Returns the value of MaxTimeShelved. More...

virtual void	setMaxTimeShelvedStatus (OpcUa_StatusCode status)
	Set a status code for the event field MaxTimeShelved. More...

virtual void	setSuppressedOrShelved (OpcUa_Boolean SuppressedOrShelved)
	Sets the SuppressedOrShelved value. More...

virtual OpcUa_Boolean	getSuppressedOrShelved () const
	Returns the value of SuppressedOrShelved. More...

virtual void	setSuppressedOrShelvedStatus (OpcUa_StatusCode status)
	Set a status code for the event field SuppressedOrShelved. More...

virtual void	setSuppressedState (OpcUa_Boolean suppressedState)

virtual UaLocalizedText	getSuppressedState ()

virtual void	setSuppressedStateStatus (OpcUa_StatusCode status)
	Set a status code for the event field SuppressedState. More...

virtual OpcUa::TwoStateVariableType *	getActiveStateNode ()
	Returns the ActiveState node.

virtual OpcUa::PropertyType *	getInputNodeNode ()
	Returns the InputNode node.

virtual OpcUa::PropertyType *	getMaxTimeShelvedNode ()
	Returns the MaxTimeShelved node. More...

virtual OpcUa::ShelvedStateMachineType *	getShelvingState ()
	Returns the ShelvingState node. More...

virtual OpcUa::PropertyType *	getSuppressedOrShelvedNode ()
	Returns the SuppressedOrShelved node.

virtual OpcUa::TwoStateVariableType *	getSuppressedStateNode ()
	Returns the SuppressedState node. More...

virtual UaStatus	triggerEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
	Send event with current event field data to the subscribed clients After setting the changed states of the event this method is used to trigger the event notification that contains the snapshot of the new state of the condition. More...

virtual void	getAlarmConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
	Get the field value for the passed index for optional fields of the AlarmConditionType. More...

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

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

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

virtual UaStatus	Acknowledge (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment)

virtual UaStatus	Confirm (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment)

void	addAckedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
	Add Acked state strings for additional locale.

void	addConfirmedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
	Add Confirmed state strings for additional locale.

virtual void	setConfirmedState (OpcUa_Boolean confirmedState)

virtual void	setAckedState (OpcUa_Boolean ackedState)

Public Member Functions inherited from OpcUa::AcknowledgeableConditionTypeBase
	AcknowledgeableConditionTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the AcknowledgeableConditionType condition type using an instance declaration node as base.

	AcknowledgeableConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the AcknowledgeableConditionType condition type.

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

void	clearFieldData ()
	Clears the event field data after event processing.

UaNodeId	createBranch ()
	Creates a new branch from the current state and adds the branch to a list managed by the condition object. More...

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 UaLocalizedText	getAckedState ()

virtual void	setAckedStateStatus (OpcUa_StatusCode status)
	Set a status code for the event field AckedState. More...

virtual UaLocalizedText	getConfirmedState ()

virtual void	setConfirmedStateStatus (OpcUa_StatusCode status)
	Set a status code for the event field ConfirmedState. More...

virtual OpcUa::TwoStateVariableType *	getAckedStateNode ()
	Returns the AckedState node.

virtual OpcUa::TwoStateVariableType *	getConfirmedStateNode ()
	Returns the ConfirmedState node. More...

virtual void	getAcknowledgeableConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
	Get the field value for the passed index for optional fields of the AcknowledgeableConditionType. More...

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

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

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

ReferenceCounter *	getConditionDataReferenceCounter ()
	Get the ReferenceCounter interface necessary for condition event data classes.

virtual UaStatus	AddComment (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment)
	AddComment is used to apply a comment to a specific state of a Condition instance. More...

virtual UaStatus	Enable (const ServiceContext &serviceContext)

virtual UaStatus	Disable (const ServiceContext &serviceContext)

void	addEnabledStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
	Add Enabled state strings for additional locale.

virtual UaNodeId	getConditionNodeId ()
	Returns the condition NodeId for the condition object. More...

virtual UaNodeId	getConditionBranchNodeId ()
	Returns the condition branch NodeId for the condition object. More...

virtual OpcUa_Boolean	getConditionRetain ()
	Returns the Retain flag for the condition object. More...

OpcUa_UInt32	getBranchCount ()
	Returns the number of active branches. More...

ConditionTypeData *	getBranch (const UaNodeId &branchNodeId)
	Returns a pointer to the branch event data based on the passed branch NodeId. More...

ConditionTypeData *	getBranchByEventId (const UaByteString &eventId, UaByteString &userEventId)
	Returns a pointer to the branch event data based on the passed EventId. More...

void	getAllBranches (UaPointerArray< ConditionTypeData > &branchArray)
	Returns an array of the available branches. More...

OpcUa_StatusCode	deleteBranch (const UaNodeId &branchNodeId)
	Deletes the branch identified by the branch NodeId. More...

UaStatus	triggerBranchEvent (ConditionTypeData *pConditionTypeData, const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
	Send event with event field data of the passed condition branch to the subscribed clients. More...

Public Member Functions inherited from OpcUa::ConditionTypeBase
	ConditionTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an instance of the ConditionType condition type using an instance declaration node as base.

	ConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the ConditionType condition type.

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

void	clearFieldData ()
	Clears the event field data after event processing.

virtual void	lockEventData ()
	Lock the event data for data update and event handling. More...

virtual void	unlockEventData ()
	Unlock the event data after data update or event handling. More...

virtual void	setBranchId (const UaNodeId &BranchId)
	Sets the BranchId value. More...

virtual UaNodeId	getBranchId () const
	Returns the value of BranchId. More...

virtual void	setBranchIdStatus (OpcUa_StatusCode status)
	Set a status code for the event field BranchId. More...

virtual void	setClientUserId (const UaString &ClientUserId)
	Sets the ClientUserId value. More...

virtual UaString	getClientUserId () const
	Returns the value of ClientUserId. More...

virtual void	setClientUserIdStatus (OpcUa_StatusCode status)
	Set a status code for the event field ClientUserId. More...

virtual void	setComment (const UaLocalizedText &Comment)
	Sets the Comment value. More...

virtual UaLocalizedText	getComment (Session *pSession) const
	Returns the value of Comment. More...

virtual void	setCommentStatus (OpcUa_StatusCode status)
	Set a status code for the event field Comment. More...

virtual void	setConditionClassId (const UaNodeId &ConditionClassId)
	Sets the ConditionClassId value. More...

virtual UaNodeId	getConditionClassId () const
	Returns the value of ConditionClassId. More...

virtual void	setConditionClassIdStatus (OpcUa_StatusCode status)
	Set a status code for the event field ConditionClassId. More...

virtual void	setConditionClassName (const UaLocalizedText &ConditionClassName)
	Sets the ConditionClassName value. More...

virtual UaLocalizedText	getConditionClassName (Session *pSession) const
	Returns the value of ConditionClassName. More...

virtual void	setConditionClassNameStatus (OpcUa_StatusCode status)
	Set a status code for the event field ConditionClassName. More...

virtual void	setConditionName (const UaString &ConditionName)
	Sets the ConditionName value. More...

virtual UaString	getConditionName () const
	Returns the value of ConditionName. More...

virtual void	setConditionNameStatus (OpcUa_StatusCode status)
	Set a status code for the event field ConditionName. More...

virtual void	setEnabledState (OpcUa_Boolean enabledState)

virtual UaLocalizedText	getEnabledState ()

virtual void	setEnabledStateStatus (OpcUa_StatusCode status)
	Set a status code for the event field EnabledState. More...

virtual void	setLastSeverity (OpcUa_UInt16 LastSeverity)
	Sets the LastSeverity value. More...

virtual OpcUa_UInt16	getLastSeverity () const
	Returns the value of LastSeverity. More...

virtual void	setLastSeverityStatus (OpcUa_StatusCode status)
	Set a status code for the event field LastSeverity. More...

virtual void	setQuality (OpcUa_StatusCode Quality)
	Sets the Quality value. More...

virtual OpcUa_StatusCode	getQuality () const
	Returns the value of Quality. More...

virtual void	setQualityStatus (OpcUa_StatusCode status)
	Set a status code for the event field Quality. More...

virtual void	setRetain (OpcUa_Boolean Retain)
	Sets the Retain value. More...

virtual OpcUa_Boolean	getRetain () const
	Returns the value of Retain. More...

virtual void	setRetainStatus (OpcUa_StatusCode status)
	Set a status code for the event field Retain. More...

virtual OpcUa::PropertyType *	getBranchIdNode ()
	Returns the BranchId node.

virtual OpcUa::PropertyType *	getClientUserIdNode ()
	Returns the ClientUserId node.

virtual OpcUa::ConditionVariableType *	getCommentNode ()
	Returns the Comment node.

virtual OpcUa::PropertyType *	getConditionClassIdNode ()
	Returns the ConditionClassId node.

virtual OpcUa::PropertyType *	getConditionClassNameNode ()
	Returns the ConditionClassName node.

virtual OpcUa::PropertyType *	getConditionNameNode ()
	Returns the ConditionName node.

virtual OpcUa::TwoStateVariableType *	getEnabledStateNode ()
	Returns the EnabledState node.

virtual OpcUa::ConditionVariableType *	getLastSeverityNode ()
	Returns the LastSeverity node.

virtual OpcUa::ConditionVariableType *	getQualityNode ()
	Returns the Quality node.

virtual OpcUa::PropertyType *	getRetainNode ()
	Returns the Retain node.

virtual void	getConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
	Get the field value for the passed index for optional fields of the ConditionType. More...

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

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

static void	registerEventFields ()
	Registers all event type fields with the EventManagerBase.

static OpcUa_UInt32	registerOptionalEventFields (const UaString &fieldName)
	Registers optional event fields with the EventManagerBase.

Static Public Member Functions inherited from OpcUa::AcknowledgeableConditionType
static void	createTypes ()
	Create the type related static members of the class.

static void	clearStaticMembers ()
	Internal SDK method used to clear the static members of this class.

Static Public Member Functions inherited from OpcUa::AcknowledgeableConditionTypeBase
static void	createTypes ()
	Create the related type nodes.

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

static void	registerEventFields ()
	Registers all event type fields with the EventManagerBase.

static OpcUa_UInt32	registerOptionalEventFields (const UaString &fieldName)
	Registers optional event fields with the EventManagerBase.

Static Public Member Functions inherited from OpcUa::ConditionType
static void	createTypes ()
	Create the related type nodes for condition classes.

static void	clearStaticMembers ()
	Internal SDK method used to clear the static members of this class.

Static Public Member Functions inherited from OpcUa::ConditionTypeBase
static void	createTypes ()
	Create the related type nodes.

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

static void	registerEventFields ()
	Registers all event type fields with the EventManagerBase.

static OpcUa_UInt32	registerOptionalEventFields (const UaString &fieldName)
	Registers optional event fields with the EventManagerBase.

Protected Member Functions
virtual	~AlarmConditionTypeBase ()
	Destroys the AlarmConditionType object.

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

Protected Member Functions inherited from OpcUa::AcknowledgeableConditionTypeBase
virtual	~AcknowledgeableConditionTypeBase ()
	Destroys the AcknowledgeableConditionType object.

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

Protected Member Functions inherited from OpcUa::ConditionTypeBase
virtual	~ConditionTypeBase ()
	Destroys the ConditionType object.

Detailed Description

Generated base class for a AlarmConditionType.

This class contains the auto generated code for the object type AlarmConditionType representing an OPC UA condition type. This class is used to create the condition type and to create and represent the condition object in the server address space. It provides also the UaEventData interface for the access to event data containing the current state of the condition for events sent to the client.

The AlarmConditionType is an abstract type that extends the AcknowledgeableConditionType by introducing an ActiveState, SuppressedState and ShelvingState.

The AlarmConditionType inherits all Properties of the AcknowledgeableConditionType. The following states are sub-states of the TRUE EnabledState.

ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists. When a Condition instance is in the inactive state (ActiveState when set to FALSE) it is representing a situation that has returned to a normal state. See getActiveState or setActiveState for more details.

The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. See getInputNode or setInputNode for more details.

SuppressedState is used internally by a Server to automatically suppress Alarms due to system specific reasons. See getSuppressedState or setSuppressedState for more details.

ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. It is quite often used to block nuisance Alarms (see also OpcUa::ShelvedStateMachineType).

The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. See getSuppressedState or setSuppressedState for more details.

The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved. See getMaxTimeShelved or setMaxTimeShelved for more details.

Constructor & Destructor Documentation

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

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

UaNodeId OpcUa::AlarmConditionTypeBase::createBranch ( )

Creates a new branch from the current state and adds the branch to a list managed by the condition object.

ConditionType::getBranch() and ConditionType::deleteBranch() can be used to access or to delete the branch.

OpcUa::AlarmConditionTypeBase::getActiveState ( )

virtual

ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists. When a Condition instance is in the inactive state (ActiveState when set to FALSE) it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Sub-Types of the AlarmConditionType will have sub-state models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Inactive	Active
de	Inaktiv	Aktiv
fr	Inactive	Active

void OpcUa::AlarmConditionTypeBase::getAlarmConditionTypeOptionalFieldData	(	OpcUa_UInt32	index,
		Session *	pSession,
		OpcUa_Variant &	data
	)

virtual

Get the field value for the passed index for optional fields of the AlarmConditionType.

This function must be overwritten by derived classes to provide the optional fields registred with AlarmConditionTypeData::registerOptionalEventFields

Parameters

index	The index of the selected field.
pSession	The session context for the method call.
data	The data for the selected field.

void OpcUa::AlarmConditionTypeBase::getFieldData	(	OpcUa_UInt32	index,
		Session *	pSession,
		OpcUa_Variant &	data
	)

virtual

Get the field value for the passed index.

Parameters

index	The index of the selected field.
pSession	The session context for the method call.
data	The data for the selected field.

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmType, OpcUa::NonExclusiveDeviationAlarmType, OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveLevelAlarmType, OpcUa::ExclusiveRateOfChangeAlarmType, OpcUa::NonExclusiveLevelAlarmType, OpcUa::NonExclusiveRateOfChangeAlarmType, OpcUa::SystemOffNormalAlarmType, and OpcUa::TripAlarmType.

OpcUa::AlarmConditionTypeBase::getInputNode ( ) const

virtual

Returns the value of InputNode.

The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.

OpcUa::AlarmConditionTypeBase::getMaxTimeShelved ( ) const

virtual

Returns the value of MaxTimeShelved.

If the optional MaxTimeShelved node has not been created, the value of the InstanceDeclaration node is returned.

The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved. The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve Method call. If a value that exceeds the value of this property is passed to the TimedShelve Method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.

See also: OpcUa::ShelvedStateMachineType; OpcUa::ShelvedStateMachineType::TimedShelve; OpcUa::ShelvedStateMachineType::OneShotShelve

OpcUa::PropertyType * OpcUa::AlarmConditionTypeBase::getMaxTimeShelvedNode ( )

virtual

Returns the MaxTimeShelved node.

If the Variable has not been created yet, this method returns NULL.

OpcUa::AlarmConditionTypeBase::getShelvingState ( )

virtual

Returns the ShelvingState node.

If the Object has not been created yet, this method creates the node and returns it.

ShelvingState suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user. It is quite often used to block nuisance Alarms.

See also: OpcUa::ShelvedStateMachineType

OpcUa::AlarmConditionTypeBase::getSuppressedOrShelved ( ) const

virtual

Returns the value of SuppressedOrShelved.

The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.

See also: OpcUa::ShelvedStateMachineType

OpcUa::AlarmConditionTypeBase::getSuppressedState ( )

virtual

SuppressState is used internally by a Server to automatically suppress Alarms due to system specific reasons. For example a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Unsuppressed	Suppressed
de	Nicht unterdrückt	Unterdrückt
fr	Présent	Supprimé

OpcUa::TwoStateVariableType * OpcUa::AlarmConditionTypeBase::getSuppressedStateNode ( )

virtual

Returns the SuppressedState node.

If the Variable has not been created yet, this method returns NULL.

OpcUa::AlarmConditionTypeBase::setActiveState ( OpcUa_Boolean activeState )

virtual

ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists. When a Condition instance is in the inactive state (ActiveState when set to FALSE) it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Sub-Types of the AlarmConditionType will have sub-state models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Inactive	Active
de	Inaktiv	Aktiv
fr	Inactive	Active

Reimplemented in OpcUa::AlarmConditionType.

void OpcUa::AlarmConditionTypeBase::setActiveStateStatus ( OpcUa_StatusCode status )

virtual

Set a status code for the event field ActiveState.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

OpcUa::AlarmConditionTypeBase::setInputNode ( const UaNodeId & InputNode )

virtual

Sets the InputNode value.

The InputNode Property provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state. If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.

void OpcUa::AlarmConditionTypeBase::setInputNodeStatus ( OpcUa_StatusCode status )

virtual

Set a status code for the event field InputNode.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

void OpcUa::AlarmConditionTypeBase::setMaxTimeShelved ( OpcUa_Double MaxTimeShelved )

virtual

Sets the MaxTimeShelved value.

If the optional MaxTimeShelved node has not been created, this method adds it to the address space.

void OpcUa::AlarmConditionTypeBase::setMaxTimeShelvedStatus ( OpcUa_StatusCode status )

virtual

Set a status code for the event field MaxTimeShelved.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

OpcUa::AlarmConditionTypeBase::setSuppressedOrShelved ( OpcUa_Boolean SuppressedOrShelved )

virtual

Sets the SuppressedOrShelved value.

The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.

See also: OpcUa::ShelvedStateMachineType

void OpcUa::AlarmConditionTypeBase::setSuppressedOrShelvedStatus ( OpcUa_StatusCode status )

virtual

Set a status code for the event field SuppressedOrShelved.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

OpcUa::AlarmConditionTypeBase::setSuppressedState ( OpcUa_Boolean suppressedState )

virtual

SuppressState is used internally by a Server to automatically suppress Alarms due to system specific reasons. For example a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.

LocaleId	FALSE State Name	TRUE State Name
en	Unsuppressed	Suppressed
de	Nicht unterdrückt	Unterdrückt
fr	Présent	Supprimé

Reimplemented in OpcUa::AlarmConditionType.

void OpcUa::AlarmConditionTypeBase::setSuppressedStateStatus ( OpcUa_StatusCode status )

virtual

Set a status code for the event field SuppressedState.

If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.

UaStatus OpcUa::AlarmConditionTypeBase::triggerEvent	(	const UaDateTime &	time,
		const UaDateTime &	receiveTime,
		const UaByteString &	userEventId
	)

virtual

Send event with current event field data to the subscribed clients After setting the changed states of the event this method is used to trigger the event notification that contains the snapshot of the new state of the condition.

Parameters

[in]	time	Time provides the time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device.
[in]	receiveTime	ReceiveTime provides the time the OPC UA Server received the Event from the underlying device or another Server.
[in]	userEventId	The server is responsible for generating a unique EventId for every event sent to the client. The SDK uses this parameter userEventId as part of the EventId but adds a unique part. The EventId is provided by the client in calls back to the server like in an alarm acknowledgement. The user specific part can be extracted from the EventId provided by the client by using EventManagerBase::getUserEventId()

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmType, OpcUa::NonExclusiveDeviationAlarmType, OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveLevelAlarmType, OpcUa::ExclusiveRateOfChangeAlarmType, OpcUa::NonExclusiveLevelAlarmType, OpcUa::NonExclusiveRateOfChangeAlarmType, OpcUa::SystemOffNormalAlarmType, and OpcUa::TripAlarmType.

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

/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_alarmconditiontypebase.h
/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_alarmconditiontypebase.cpp
/home/buildbot/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/z_doc/opcuaconditiontypes.dox

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation