#include <opcua_conditiontypebase.h>

Inheritance diagram for OpcUa::ConditionTypeData:

Collaboration diagram for OpcUa::ConditionTypeData:

Public Member Functions
	ConditionTypeData ()
virtual	~ConditionTypeData ()
void	initializeAsBranch (ConditionTypeBase *pCondition)
void	setConditionNodeId (const UaNodeId &conditionNodeId)
virtual UaNodeId	getConditionNodeId ()
virtual UaNodeId	getConditionBranchNodeId ()
virtual OpcUa_Boolean	getConditionRetain ()
virtual void	getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
void	setBranchId (const UaNodeId &branchId)
UaNodeId	getBranchId ()
virtual void	getBranchIdValue (Session *pSession, OpcUa_Variant &value)
void	setClientUserId (const UaString &clientUserId)
UaString	getClientUserId ()
virtual void	getClientUserIdValue (Session *pSession, OpcUa_Variant &value)
void	setComment (const UaLocalizedText &comment)
UaLocalizedText	getComment ()
virtual void	getCommentValue (Session *pSession, OpcUa_Variant &value)
void	setConditionClassId (const UaNodeId &conditionClassId)
UaNodeId	getConditionClassId ()
virtual void	getConditionClassIdValue (Session *pSession, OpcUa_Variant &value)
void	setConditionClassName (const UaLocalizedText &conditionClassName)
UaLocalizedText	getConditionClassName ()
virtual void	getConditionClassNameValue (Session *pSession, OpcUa_Variant &value)
void	setConditionName (const UaString &conditionName)
UaString	getConditionName ()
virtual void	getConditionNameValue (Session *pSession, OpcUa_Variant &value)
virtual void	getEnabledStateValue (Session *pSession, OpcUa_Variant &value)
void	setEnabledState (OpcUa_Boolean enabledState)
OpcUa_Boolean	getEnabledState ()
virtual void	getEnabledStateIdValue (Session *pSession, OpcUa_Variant &value)
void	setLastSeverity (OpcUa_UInt16 lastSeverity)
OpcUa_UInt16	getLastSeverity ()
virtual void	getLastSeverityValue (Session *pSession, OpcUa_Variant &value)
void	setQuality (OpcUa_StatusCode quality)
OpcUa_StatusCode	getQuality ()
virtual void	getQualityValue (Session *pSession, OpcUa_Variant &value)
void	setRetain (OpcUa_Boolean retain)
OpcUa_Boolean	getRetain ()
virtual void	getRetainValue (Session *pSession, OpcUa_Variant &value)

Detailed Description

Generated event data class for a ConditionType.

This class contains the auto generated code for the object type ConditionType 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::ConditionTypeData::ConditionTypeData ( )

Constructs an ConditionTypeData object

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

Destroys the ConditionTypeData object

Member Function Documentation

UaNodeId OpcUa::ConditionTypeData::getBranchId ( )

Get the event field value BranchId

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

Get the event field value BranchId 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

UaString OpcUa::ConditionTypeData::getClientUserId ( )

Get the event field value ClientUserId

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

Get the event field value ClientUserId 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

UaLocalizedText OpcUa::ConditionTypeData::getComment ( )

Get the event field value Comment

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

Get the event field value Comment 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

UaNodeId OpcUa::ConditionTypeData::getConditionBranchNodeId ( ) [virtual]

Returns the condition branch NodeId since the event data is related to a condition object.

Reimplemented from UaEventData.

UaNodeId OpcUa::ConditionTypeData::getConditionClassId ( )

Get the event field value ConditionClassId

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

Get the event field value ConditionClassId 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

UaLocalizedText OpcUa::ConditionTypeData::getConditionClassName ( )

Get the event field value ConditionClassName

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

Get the event field value ConditionClassName 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

UaString OpcUa::ConditionTypeData::getConditionName ( )

Get the event field value ConditionName

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

Get the event field value ConditionName 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

UaNodeId OpcUa::ConditionTypeData::getConditionNodeId ( ) [virtual]

Returns the condition NodeId since the event data is related to a condition object.

Reimplemented from UaEventData.

OpcUa_Boolean OpcUa::ConditionTypeData::getConditionRetain ( ) [virtual]

Returns the Retain flag since the event data is related to a condition object.

Reimplemented from UaEventData.

OpcUa_Boolean OpcUa::ConditionTypeData::getEnabledState ( )

Get the event field state bool value for EnabledState

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

Get the event field value EnabledState/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::ConditionTypeData::getEnabledStateValue	(	Session *	pSession,
		OpcUa_Variant &	value
	)		`[virtual]`

Get the event field value EnabledState 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::ConditionTypeData::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 BaseEventTypeData.

OpcUa_UInt16 OpcUa::ConditionTypeData::getLastSeverity ( )

Get the event field value LastSeverity

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

Get the event field value LastSeverity 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_StatusCode OpcUa::ConditionTypeData::getQuality ( )

Get the event field value Quality

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

Get the event field value Quality 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::ConditionTypeData::getRetain ( )

Get the event field value Retain

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

Get the event field value Retain 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::ConditionTypeData::initializeAsBranch ( ConditionTypeBase * pCondition )

This method is used to initializes the ConditionTypeData 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::ConditionTypeData::setBranchId ( const UaNodeId & branchId )

Set the event field value BranchId

void OpcUa::ConditionTypeData::setClientUserId ( const UaString & clientUserId )

Set the event field value ClientUserId

void OpcUa::ConditionTypeData::setComment ( const UaLocalizedText & comment )

Set the event field value Comment

void OpcUa::ConditionTypeData::setConditionClassId ( const UaNodeId & conditionClassId )

Set the event field value ConditionClassId

void OpcUa::ConditionTypeData::setConditionClassName ( const UaLocalizedText & conditionClassName )

Set the event field value ConditionClassName

void OpcUa::ConditionTypeData::setConditionName ( const UaString & conditionName )

Set the event field value ConditionName

void OpcUa::ConditionTypeData::setConditionNodeId ( const UaNodeId & conditionNodeId )

Sets the condition NodeId for the event data related to a condition object.

void OpcUa::ConditionTypeData::setEnabledState ( OpcUa_Boolean enabledState )

Set the event field state bool value for EnabledState

void OpcUa::ConditionTypeData::setLastSeverity ( OpcUa_UInt16 lastSeverity )

Set the event field value LastSeverity

void OpcUa::ConditionTypeData::setQuality ( OpcUa_StatusCode quality )

Set the event field value Quality

void OpcUa::ConditionTypeData::setRetain ( OpcUa_Boolean retain )

Set the event field value Retain

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

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

OpcUa::ConditionTypeData Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation