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

#include <opcua_exclusivelimitalarmtype.h>

Inheritance diagram for OpcUa::ExclusiveLimitAlarmType:

Collaboration diagram for OpcUa::ExclusiveLimitAlarmType:

Public Member Functions
	ExclusiveLimitAlarmType (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
	ExclusiveLimitAlarmType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted pSharedMutex=NULL)
virtual void	getAlarmConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
void	setExclusiveState (ExclusiveLimitStateMachineType::ExclusiveState state)
ExclusiveLimitStateMachineType::ExclusiveState	getExclusiveState ()
virtual void	getExclusiveLimitAlarmTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
Static Public Member Functions
static void	createTypes ()
static void	clearStaticMembers ()
static void	addStatesLocale (const UaLocalizedText &LowLowName, const UaLocalizedText &LowName, const UaLocalizedText &HighName, const UaLocalizedText &HighHighName)
Protected Member Functions
virtual	~ExclusiveLimitAlarmType ()
Static Protected Member Functions
static UaLocalizedText	getLowLowName (Session *pSession)
static UaLocalizedText	getLowName (Session *pSession)
static UaLocalizedText	getHighName (Session *pSession)
static UaLocalizedText	getHighHighName (Session *pSession)

Detailed Description

Class implementing the UaObject interface for the ExclusiveLimitAlarmType.

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.

Constructor & Destructor Documentation

OpcUa::ExclusiveLimitAlarmType::~ExclusiveLimitAlarmType ( ) [protected, virtual]

Destruction

OpcUa::ExclusiveLimitAlarmType::ExclusiveLimitAlarmType	(	const UaNodeId &	nodeId,
		UaObject *	pInstanceDeclarationObject,
		NodeManagerConfig *	pNodeConfig,
		const UaNodeId &	sourceNode,
		const UaString &	sourceName,
		UaMutexRefCounted *	pSharedMutex = `NULL`
	)

Construction of the class ExclusiveLimitAlarmType. 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 availablity 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]	sourceNode	NodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]	sourceName	Name of the source used for this condition object
[in]	pSharedMutex	Shared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided

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

Construction of the class ExclusiveLimitAlarmType. 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 availablity 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]	sourceNode	NodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]	sourceName	Name of the source used for this condition object
[in]	pSharedMutex	Shared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided

Member Function Documentation

void OpcUa::ExclusiveLimitAlarmType::addStatesLocale	(	const UaLocalizedText &	LowLowName,
		const UaLocalizedText &	LowName,
		const UaLocalizedText &	HighName,
		const UaLocalizedText &	HighHighName
	)		`[static]`

Add state display strings for additional locale

void OpcUa::ExclusiveLimitAlarmType::clearStaticMembers ( ) [static]

Internal SDK method used to clear the static members of this class.

Reimplemented from OpcUa::ExclusiveLimitAlarmTypeBase.

Reimplemented in OpcUa::ExclusiveDeviationAlarmType, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmType, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmType, and OpcUa::ExclusiveRateOfChangeAlarmTypeBase.

void OpcUa::ExclusiveLimitAlarmType::createTypes ( ) [static]

Creates the related static information needed for instances of this class and the related alarm handling

Reimplemented from OpcUa::ExclusiveLimitAlarmTypeBase.

Reimplemented in OpcUa::ExclusiveDeviationAlarmType, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmType, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmType, and OpcUa::ExclusiveRateOfChangeAlarmTypeBase.

void OpcUa::ExclusiveLimitAlarmType::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 ConditionTypeData::registerOptionalEventFields

Parameters:

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

Reimplemented from OpcUa::AlarmConditionType.

void OpcUa::ExclusiveLimitAlarmType::getExclusiveLimitAlarmTypeOptionalFieldData	(	OpcUa_UInt32	index,
		Session *	pSession,
		OpcUa_Variant &	data
	)		`[virtual]`

Get the field value for the passed index for optional fields of the ConditionType. This function must be overwritten by derived classes to provide the optional fields registred with ConditionTypeData::registerOptionalEventFields

Parameters:

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

Reimplemented from OpcUa::ExclusiveLimitAlarmTypeBase.

ExclusiveLimitStateMachineType::ExclusiveState OpcUa::ExclusiveLimitAlarmType::getExclusiveState ( )

Returns the state of the exclusice limit state machine

UaLocalizedText OpcUa::ExclusiveLimitAlarmType::getHighHighName ( Session * pSession ) [static, protected]

Get the HighHigh state display name depending on the session locale

Parameters:

[in] pSession Session context for the call

UaLocalizedText OpcUa::ExclusiveLimitAlarmType::getHighName ( Session * pSession ) [static, protected]

Get the High state display name depending on the session locale

Parameters:

[in] pSession Session context for the call

UaLocalizedText OpcUa::ExclusiveLimitAlarmType::getLowLowName ( Session * pSession ) [static, protected]

Get the LowLow state display name depending on the session locale

Parameters:

[in] pSession Session context for the call

UaLocalizedText OpcUa::ExclusiveLimitAlarmType::getLowName ( Session * pSession ) [static, protected]

Get the Low state display name depending on the session locale

Parameters:

[in] pSession Session context for the call

void OpcUa::ExclusiveLimitAlarmType::setExclusiveState ( ExclusiveLimitStateMachineType::ExclusiveState state )

Sets the state of the exclusice limit state machine

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

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

OpcUa::ExclusiveLimitAlarmType Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation