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 OpcUa_Boolean	getActiveStateBool ()

virtual UaLocalizedText	getActiveState ()

virtual void	getActiveStateValue (Session *pSession, UaVariant &value)

virtual void	getActiveState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value)

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

virtual UaNodeId	getInputNode () const
	Gets the InputNode.

virtual void	getInputNodeValue (Session *pSession, UaVariant &value)

virtual void	setMaxTimeShelved (OpcUa_Double MaxTimeShelved)
	Sets the MaxTimeShelved.

virtual OpcUa_Double	getMaxTimeShelved () const
	Gets the MaxTimeShelved.

virtual void	getMaxTimeShelvedValue (Session *pSession, UaVariant &value)

virtual void	setSuppressedOrShelved (OpcUa_Boolean SuppressedOrShelved)
	Sets the SuppressedOrShelved.

virtual OpcUa_Boolean	getSuppressedOrShelved () const
	Gets the SuppressedOrShelved.

virtual void	getSuppressedOrShelvedValue (Session *pSession, UaVariant &value)

virtual void	setSuppressedState (OpcUa_Boolean suppressedState)

virtual OpcUa_Boolean	getSuppressedStateBool ()

virtual UaLocalizedText	getSuppressedState ()

virtual void	getSuppressedStateValue (Session *pSession, UaVariant &value)

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 OpcUa_Boolean	getAckedStateBool ()

virtual UaLocalizedText	getAckedState ()

virtual void	getAckedStateValue (Session *pSession, UaVariant &value)

virtual OpcUa_Boolean	getConfirmedStateBool ()

virtual UaLocalizedText	getConfirmedState ()

virtual void	getConfirmedStateValue (Session *pSession, UaVariant &value)

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)

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 After setting the changed states of the condition branch this method is used to trigger the event notification that contains the snapshot of the new state of the condition branch. 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.

virtual UaNodeId	getBranchId () const
	Gets the BranchId.

virtual void	getBranchIdValue (Session *pSession, UaVariant &value)

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

virtual UaString	getClientUserId () const
	Gets the ClientUserId.

virtual void	getClientUserIdValue (Session *pSession, UaVariant &value)

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

virtual UaLocalizedText	getComment (Session *pSession) const
	Gets the Comment.

virtual void	getCommentValue (Session *pSession, UaVariant &value)

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

virtual UaNodeId	getConditionClassId () const
	Gets the ConditionClassId.

virtual void	getConditionClassIdValue (Session *pSession, UaVariant &value)

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

virtual UaLocalizedText	getConditionClassName (Session *pSession) const
	Gets the ConditionClassName.

virtual void	getConditionClassNameValue (Session *pSession, UaVariant &value)

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

virtual UaString	getConditionName () const
	Gets the ConditionName.

virtual void	getConditionNameValue (Session *pSession, UaVariant &value)

virtual void	setEnabledState (OpcUa_Boolean enabledState)

virtual OpcUa_Boolean	getEnabledStateBool ()

virtual UaLocalizedText	getEnabledState ()

virtual void	getEnabledStateValue (Session *pSession, UaVariant &value)

virtual void	getEnabledState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value)

virtual void	setLastSeverity (OpcUa_UInt16 LastSeverity)
	Sets the LastSeverity.

virtual OpcUa_UInt16	getLastSeverity () const
	Gets the LastSeverity.

virtual void	getLastSeverityValue (Session *pSession, UaVariant &value)

virtual void	setQuality (OpcUa_StatusCode Quality)
	Sets the Quality.

virtual OpcUa_StatusCode	getQuality () const
	Gets the Quality.

virtual void	getQualityValue (Session *pSession, UaVariant &value)

virtual void	setRetain (OpcUa_Boolean Retain)
	Sets the Retain.

virtual OpcUa_Boolean	getRetain () const
	Gets the Retain.

virtual void	getRetainValue (Session *pSession, UaVariant &value)

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...

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

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

	BaseEventType (UaBase::Object pObject, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex)

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

virtual UaStatus	setLocalTime (const UaVariant &localTime)
	Set value for optional event property LocalTime. More...

virtual void	setSourceNode (const UaNodeId &sourceNode)
	Set the value of the SourceNode field.

virtual UaNodeId	getSourceNode () const
	Get the value of the SourceName field.

virtual void	setSourceName (const UaString &sourceName)
	Set the value of the SourceName field.

virtual UaString	getSourceName () const
	Get the value of the SourceName field.

virtual void	setMessage (const UaLocalizedText &message)
	Set the value of the Message field.

virtual UaLocalizedText	getMessage () const
	Get the value of the Message field.

virtual void	setSeverity (OpcUa_UInt16 severity)
	Set the value of the Severity field.

virtual OpcUa_UInt16	getSeverity () const
	Get the value of the Severity field.

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.

void	lock ()
	Lock the access to the object.

void	unlock ()
	Unlock the access to the object.

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

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

	BaseObjectType (UaBase::Object pObject, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)

UaReferenceLists *	getUaReferenceLists () const
	Get the UaReferenceLists interface for the node. More...

virtual UaStatus	browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
	Discover the references of a specified node of a view. More...

UaNodeId	nodeId () const
	Get the NodeId of the current Node. More...

virtual UaQualifiedName	browseName () const
	Get the browseName of the current Node. More...

virtual UaLocalizedText	displayName (Session *pSession) const
	Get the displayName as LocalizedText of the current Node. More...

virtual OpcUa_Boolean	isDescriptionSupported () const
	Check if Node is DescriptionSupported. More...

virtual UaLocalizedText	description (Session *pSession) const
	Get the description as LocalizedText of the current Node. More...

virtual OpcUa_Boolean	isWriteMaskSupported () const
	Check if Node is WriteMaskSupported. More...

virtual OpcUa_UInt32	writeMask () const
	Get the writeMask of the current Node. More...

virtual OpcUa_Boolean	isUserWriteMaskSupported () const
	Check if Node is UserWriteMaskSupported. More...

virtual OpcUa_UInt32	userWriteMask (Session *pSession) const
	Check if Node has a userWriteMask. More...

UaNode *	getUaNode () const
	Get the UaNode interface pointer of this node. More...

virtual OpcUa_Byte	eventNotifier () const
	Returns the EventNotifier for the BaseObjectType. More...

virtual MethodManager *	getMethodManager (UaMethod *pMethod) const
	Returns the method manager interface for the BaseObjectType instance. More...

virtual void	setUserData (UserDataBase *pUserData)
	Method to set user data stored in this class. More...

virtual UserDataBase *	getUserData () const
	Method to get the user data stored in this class. More...

virtual void	setBrowseName (const UaQualifiedName &browseName)
	Sets the browse name attribute value. More...

virtual void	setDisplayName (const UaLocalizedText &displayName)
	Sets the display name attribute value. More...

virtual void	setDescription (const UaLocalizedText &description)
	Sets the description attribute value. More...

virtual void	setWriteMask (OpcUa_UInt32 writeMask)
	Sets the write mask attribute value. More...

virtual void	setEventNotifier (OpcUa_Byte eventNotifier)
	Sets the eventNotifier attribute value. More...

virtual void	setModellingRuleId (const UaNodeId &modellingRuleId)
	Set NodeId of the modeling rule for this node. More...

virtual UaNodeId	modellingRuleId () const
	Get NodeId of the modeling rule for this node. More...

void	setMethodManager (MethodManager *pMethodManager)
	Allows a class aggregating the object to implement the MethodManager for this object. More...

virtual UaStatus	setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, OpcUa_Boolean checkWriteMask)
	Sets the value of an attribute of the Node. More...

NodeManagerConfig *	getNodeManagerConfig () const

UaMutexRefCounted *	getSharedMutex () const

Public Member Functions inherited from MethodManager
	MethodManager ()
	construction

virtual	~MethodManager ()
	destruction

Public Member Functions inherited from UaObject
	UaObject ()
	Construction of the UaObject. More...

OpcUa_NodeClass	nodeClass () const
	Get the node class of the Node. More...

virtual void	getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, UaDataValue &uaDataValue)
	Gets the value of an attribute of the Node. More...

Public Member Functions inherited from UaNode
	UaNode ()
	Construction of the UaNode. More...

virtual UaNodeId	getKey () const
	Get the key of the node used for the hash table. More...

Public Member Functions inherited from ChainEntry
	ChainEntry ()
	construction

ChainEntry *	find (const UaNodeId &key, ChainEntry **ppPrevious)
	finds the right entry in the chain. More...

void	add (ChainEntry *pNewEntry)
	adds a new entry to the list. More...

void	prepend (ChainEntry *pNewEntry)
	prepends a new entry to the list. More...

ChainEntry *	remove (const UaNodeId &key, ChainEntry **ppNext)
	removes an entry from the list. More...

ChainEntry *	getNext () const
	Check if there is a chain. More...

virtual void	setInvalid ()
	Set the entry to invalid. More...

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter ()
	construction

virtual	~ReferenceCounter ()
	destruction

int	addReference ()

int	releaseReference ()

int	referenceCount () const

Public Member Functions inherited from UaReferenceLists
	UaReferenceLists ()
	Constructs the reference lists object.

virtual	~UaReferenceLists ()
	Destroys the reference lists object.

virtual UaStatus	browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
	Discover the references of a specified node of a view. More...

virtual UaStatus	translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
	Find a node based on an element of an relative path. More...

virtual const UaReference *	pTargetNodes () const
	Returns the list of references to target nodes. More...

virtual const UaReference *	pSourceNodes () const
	Returns the list of references to source nodes. More...

virtual UaNode *	getTargetNodeByBrowseName (const UaQualifiedName &browseName) const
	Searches a target node with the passed browse name and returns the UaNode interface if found. More...

virtual void	addTargetNode (UaReference *pReference)
	Add a reference to a target node where this node is the source node. More...

virtual void	addSourceNode (UaReference *pReference)
	Adds a reference to a source node where this node is the target node. More...

virtual UaStatus	removeSourceNode (UaReference *pReferenceToRemove)
	Remove a reference to a source node where this node is the target node. More...

virtual bool	removeSourceReference (UaReference *pReferenceToRemove)
	Remove the passed reference to a source node. More...

virtual UaStatus	removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
	Remove a reference to a target node where this node is the source node. More...

virtual UaStatus	removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
	Remove a reference to a target node where this node is the source node. More...

virtual bool	removeTargetReference (UaReference *pReferenceToRemove)
	Remove the passed reference to a target node. More...

virtual UaStatus	removeCrossNodeManagerRef (NodeManager *pNodeManager)
	Remove references to another NodeManager. More...

virtual UaStatus	invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
	Set all references from SourceNodes to this Node invalid. More...

virtual UaStatus	invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
	Set all references to TargetNode of this node invalid. More...

virtual UaStatus	deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
	Deletes all child nodes. More...

Public Member Functions inherited from BaseEventTypeData
	BaseEventTypeData ()
	Constructs a BaseEventTypeData object.

virtual	~BaseEventTypeData ()
	Destroys the BaseEventTypeData object.

virtual void	initializeFromEventData (BaseEventTypeData *pEventData)

virtual void	prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId)
	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	setSource (const UaNode *pNode)
	Set the SourceNode and SoruceName by passing in a node pointer for the source node.

virtual void	setSourceNode (const UaNodeId &sourceNode)
	Set the SourceNode event field.

virtual UaNodeId	getSourceNode () const
	Get the SourceNode event field.

virtual void	setSourceName (const UaString &sourceName)
	Set the SourceName event field.

virtual UaString	getSourceName () const
	Get the SourceName event field.

virtual void	setTime (const UaDateTime &time)
	Set the Time event field.

virtual UaDateTime	getTime () const
	Get the Time event field.

virtual void	setReceiveTime (const UaDateTime &receiveTime)
	Set the ReceiveTime event field.

virtual UaDateTime	getReceiveTime () const
	Get the ReceiveTime event field.

virtual void	setMessage (const UaLocalizedText &message)
	Set the Message event field.

virtual UaLocalizedText	getMessage () const
	Get the Message event field.

virtual void	getMessageValue (Session *pSession, UaVariant &data)
	Get the message field value. More...

virtual void	setSeverity (OpcUa_UInt16 severity)
	Set the Severity event field.

virtual OpcUa_UInt16	getSeverity () const
	Get the Severity event field.

Public Member Functions inherited from UaEventData
	UaEventData ()
	construction

virtual	~UaEventData ()
	destruction

void	setEventUserData (OpcUa_Handle pEventUserData)
	Sets the user specific event data to the EventData object. More...

OpcUa_Handle	getEventUserData () const
	Returns the user specific event data.

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.

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

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

Static Public Member Functions inherited from OpcUa::BaseObjectType
static void	clearStaticMembers ()
	Clear the static members of the class.

static void	setDefaultLocalId (const UaString &defaultLocaleId)

Static Public Member Functions inherited from BaseEventTypeData
static void	registerEventFields ()
	Registers all event type fields with the EventManagerBase.

Static Public Member Functions inherited from UaEventData
static void	registerEventFields ()
	Registers all event type 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.

void	addBranch (ConditionTypeData *pConditionTypeData, const UaNodeId &branchNodeId)

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

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

virtual OpcUa_StatusCode	sendEvent (UaEventData *pEventData)
	Adds the event field values of this type and fires the event.

Protected Member Functions inherited from OpcUa::BaseObjectType
virtual	~BaseObjectType ()
	Destruction of the BaseObjectType. More...

Protected Member Functions inherited from UaObject
virtual	~UaObject ()
	Destruction of the UaObject. More...

Protected Member Functions inherited from UaNode
virtual	~UaNode ()
	Destruction of the UaNode. More...

Protected Member Functions inherited from ChainEntry
virtual	~ChainEntry ()
	destruction

Protected Attributes
OpcUa::ShelvedStateMachineType *	m_pShelvingState

OpcUa::TwoStateVariableType *	m_pActiveState

OpcUa::PropertyType *	m_pInputNode

OpcUa::PropertyType *	m_pMaxTimeShelved

OpcUa::PropertyType *	m_pSuppressedOrShelved

OpcUa::TwoStateVariableType *	m_pSuppressedState

Static Protected Attributes
static OpcUa::ShelvedStateMachineType *	s_pShelvingState = NULL

static OpcUa::TwoStateVariableType *	s_pActiveState = NULL

static OpcUa::TwoStateVariableType *	s_pEnabledState = NULL

static OpcUa::PropertyType *	s_pInputNode = NULL

static OpcUa::PropertyType *	s_pMaxTimeShelved = NULL

static OpcUa::PropertyType *	s_pSuppressedOrShelved = NULL

static OpcUa::TwoStateVariableType *	s_pSuppressedState = NULL

Additional Inherited Members
Public Attributes inherited from BaseEventTypeData
UaVariant	m_EventId
	Field 01 - EventId.

UaNodeId	m_EventTypeId
	Field 02 - EventType.

UaVariant	m_SourceNode
	Field 03 - SourceNode.

UaVariant	m_SourceName
	Field 04 - SourceName.

UaVariant	m_Time
	Field 05 - Time.

UaVariant	m_ReceiveTime
	Field 06 - ReceiveTime.

UaVariant	m_LocalTime
	Field 07 - LocalTime.

UaVariant	m_Message
	Field 08 - Message.

UaVariant	m_Severity
	Field 09 - Severity.

Static Public Attributes inherited from UaObject
static int	s_instanceCount = 0

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	(	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.

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::PropertyType * OpcUa::AlarmConditionTypeBase::getMaxTimeShelvedNode ( )

virtual

Returns the MaxTimeShelved node.

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

OpcUa::ShelvedStateMachineType * OpcUa::AlarmConditionTypeBase::getShelvingState ( )

virtual

Returns the ShelvingState node.

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

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

virtual

Returns the SuppressedState node.

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

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::ExclusiveDeviationAlarmType, OpcUa::NonExclusiveDeviationAlarmType, OpcUa::OffNormalAlarmTypeBase, 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:

D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_alarmconditiontypebase.h
D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/opcua_alarmconditiontypebase.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation