#include <opcua_alarmconditiontypebase.h>

Inheritance diagram for OpcUa::AlarmConditionTypeData:

Collaboration diagram for OpcUa::AlarmConditionTypeData:

Public Member Functions
	AlarmConditionTypeData ()
virtual	~AlarmConditionTypeData ()
void	initializeAsBranch (AlarmConditionTypeBase *pCondition)
virtual void	getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
virtual void	getActiveStateValue (Session *pSession, OpcUa_Variant &value)
void	setActiveState (OpcUa_Boolean activeState)
OpcUa_Boolean	getActiveState ()
virtual void	getActiveStateIdValue (Session *pSession, OpcUa_Variant &value)
void	setInputNode (const UaNodeId &inputNode)
UaNodeId	getInputNode ()
virtual void	getInputNodeValue (Session *pSession, OpcUa_Variant &value)
void	setMaxTimeShelved (OpcUa_Double maxTimeShelved)
OpcUa_Double	getMaxTimeShelved ()
virtual void	getMaxTimeShelvedValue (Session *pSession, OpcUa_Variant &value)
void	setSuppressedOrShelved (OpcUa_Boolean suppressedOrShelved)
OpcUa_Boolean	getSuppressedOrShelved ()
virtual void	getSuppressedOrShelvedValue (Session *pSession, OpcUa_Variant &value)
virtual void	getSuppressedStateValue (Session *pSession, OpcUa_Variant &value)
void	setSuppressedState (OpcUa_Boolean suppressedState)
OpcUa_Boolean	getSuppressedState ()
virtual void	getSuppressedStateIdValue (Session *pSession, OpcUa_Variant &value)

Detailed Description

Generated event data class for a AlarmConditionType.

This class contains the auto generated code for the object type AlarmConditionType providing UaEventData interface for the access to event data containing the current state of the condition for events sent to the client. The class is used for condition events if the condition has no nodes in the address space or for condition branches created as snapshot of the main branch.

Constructor & Destructor Documentation

OpcUa::AlarmConditionTypeData::AlarmConditionTypeData ( )

Constructs an AlarmConditionTypeData object

OpcUa::AlarmConditionTypeData::~AlarmConditionTypeData ( ) [virtual]

Destroys the AlarmConditionTypeData object

Member Function Documentation

OpcUa_Boolean OpcUa::AlarmConditionTypeData::getActiveState ( )

Get the event field state bool value for ActiveState

void OpcUa::AlarmConditionTypeData::getActiveStateIdValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value ActiveState/Id for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

void OpcUa::AlarmConditionTypeData::getActiveStateValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value ActiveState for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

void OpcUa::AlarmConditionTypeData::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::AcknowledgeableConditionTypeData.

Reimplemented in OpcUa::DiscreteAlarmTypeData, OpcUa::ExclusiveDeviationAlarmTypeData, OpcUa::ExclusiveLevelAlarmTypeData, OpcUa::ExclusiveLimitAlarmTypeData, OpcUa::ExclusiveRateOfChangeAlarmTypeData, OpcUa::LimitAlarmTypeData, OpcUa::NonExclusiveDeviationAlarmTypeData, OpcUa::NonExclusiveLevelAlarmTypeData, OpcUa::NonExclusiveLimitAlarmTypeData, OpcUa::NonExclusiveRateOfChangeAlarmTypeData, OpcUa::OffNormalAlarmTypeData, and OpcUa::TripAlarmTypeData.

UaNodeId OpcUa::AlarmConditionTypeData::getInputNode ( )

Get the event field value InputNode

void OpcUa::AlarmConditionTypeData::getInputNodeValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value InputNode for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

OpcUa_Double OpcUa::AlarmConditionTypeData::getMaxTimeShelved ( )

Get the event field value MaxTimeShelved

void OpcUa::AlarmConditionTypeData::getMaxTimeShelvedValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value MaxTimeShelved for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

OpcUa_Boolean OpcUa::AlarmConditionTypeData::getSuppressedOrShelved ( )

Get the event field value SuppressedOrShelved

void OpcUa::AlarmConditionTypeData::getSuppressedOrShelvedValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value SuppressedOrShelved for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

OpcUa_Boolean OpcUa::AlarmConditionTypeData::getSuppressedState ( )

Get the event field state bool value for SuppressedState

void OpcUa::AlarmConditionTypeData::getSuppressedStateIdValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value SuppressedState/Id for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

void OpcUa::AlarmConditionTypeData::getSuppressedStateValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value SuppressedState for delivering the event data.

This method can be overwritten in a derived class to return a client session specific value like a localized text matching the LocaleId requested by the client

void OpcUa::AlarmConditionTypeData::initializeAsBranch ( AlarmConditionTypeBase * pCondition )

This method is used to initializes the AlarmConditionTypeData object with event data from a condition object to create a branch of this condition object. The method creates a unique BranchId. EventManagerBase::fireEvent() is used send the intial branch state and status updates for the branch to the client(s). It is necessary to update the time stamps and the EventId for every update sent to the client(s).

Parameters:

pCondition The condition object .

void OpcUa::AlarmConditionTypeData::setActiveState ( OpcUa_Boolean activeState )

Set the event field state bool value for ActiveState

void OpcUa::AlarmConditionTypeData::setInputNode ( const UaNodeId & inputNode )

Set the event field value InputNode

void OpcUa::AlarmConditionTypeData::setMaxTimeShelved ( OpcUa_Double maxTimeShelved )

Set the event field value MaxTimeShelved

void OpcUa::AlarmConditionTypeData::setSuppressedOrShelved ( OpcUa_Boolean suppressedOrShelved )

Set the event field value SuppressedOrShelved

void OpcUa::AlarmConditionTypeData::setSuppressedState ( OpcUa_Boolean suppressedState )

Set the event field state bool value for SuppressedState

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::AlarmConditionTypeData Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation