#include <opcua_alarmconditiontypebase.h>

Inheritance diagram for OpcUa::AlarmConditionTypeBase:

Collaboration diagram for OpcUa::AlarmConditionTypeBase:

Public Member Functions
	AlarmConditionTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
	AlarmConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted pSharedMutex=NULL)
virtual UaNodeId	typeDefinitionId () const
virtual void	getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
void	clearFieldData ()
UaNodeId	createBranch ()
virtual UaStatus	beginCall (MethodManagerCallback pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle pMethodHandle, const UaVariantArray &inputArguments)
virtual UaStatus	triggerEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
virtual void	getAlarmConditionTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
Static Public Member Functions
static void	createTypes ()
static void	clearStaticMembers ()
static void	registerEventFields ()
static OpcUa_UInt32	registerOptionalEventFields (const UaString &fieldName)
Protected Member Functions
virtual	~AlarmConditionTypeBase ()

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.

Constructor & Destructor Documentation

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

Destroys the AlarmConditionType object

OpcUa::AlarmConditionTypeBase::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

OpcUa::AlarmConditionTypeBase::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

Member Function Documentation

UaStatus OpcUa::AlarmConditionTypeBase::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::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

void OpcUa::AlarmConditionTypeBase::clearFieldData ( )

Clears the event field data after event processing

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

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

Clear the static members of the class

Reimplemented from OpcUa::AcknowledgeableConditionType.

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.

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

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

Create the related type nodes

Reimplemented from OpcUa::AcknowledgeableConditionType.

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.

Reimplemented in OpcUa::AlarmConditionType, OpcUa::ExclusiveLimitAlarmType, and OpcUa::NonExclusiveLimitAlarmType.

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::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

void OpcUa::AlarmConditionTypeBase::registerEventFields ( ) [static]

Registers all event type fields with the EventManagerUaNode.

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

OpcUa_UInt32 OpcUa::AlarmConditionTypeBase::registerOptionalEventFields ( const UaString & fieldName ) [static]

Registers optional event fields with the EventManagerUaNode.

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

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::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

UaNodeId OpcUa::AlarmConditionTypeBase::typeDefinitionId ( ) const [virtual]

Returns the type definition NodeId for the AlarmConditionType

Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.

Reimplemented in OpcUa::DiscreteAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmTypeBase, OpcUa::ExclusiveLevelAlarmTypeBase, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmTypeBase, OpcUa::NonExclusiveLevelAlarmTypeBase, OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, and OpcUa::TripAlarmTypeBase.

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

OpcUa::AlarmConditionTypeBase Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation