C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa::ConditionType Class Reference

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

#include <opcua_conditiontype.h>

Inherits OpcUa::ConditionTypeBase.

Inherited by OpcUa::AcknowledgeableConditionTypeBase, and OpcUa::DialogConditionTypeBase.

Public Member Functions

 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...
 
ReferenceCountergetConditionDataReferenceCounter ()
 Get the ReferenceCounter interface necessary for condition event data classes.
 
virtual UaStatus AddComment (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment)
 Applies a comment to a specific state of a Condition instance. More...
 
virtual UaStatus Disable (const ServiceContext &serviceContext)
 Changes a Condition instance to the Disabled state. More...
 
virtual UaStatus Enable (const ServiceContext &serviceContext)
 Changes a Condition instance to the enabled state. More...
 
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...
 
ConditionTypeDatagetBranch (const UaNodeId &branchNodeId)
 Returns a pointer to the branch event data based on the passed branch NodeId. More...
 
ConditionTypeDatagetBranchByEventId (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. More...
 
virtual void setInvalid ()
 Set the entry to invalid. 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...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the ConditionType.
 
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.
 
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 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 void setBranchId (const UaNodeId &BranchId)
 Sets the BranchId value. More...
 
virtual UaNodeId getBranchId () const
 Returns the value of BranchId. More...
 
virtual void setBranchIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field BranchId. More...
 
virtual void getBranchIdValue (Session *pSession, UaVariant &value)
 Sets the value of BranchId to argument value. More...
 
virtual void setClientUserId (const UaString &ClientUserId)
 Sets the ClientUserId value. More...
 
virtual UaString getClientUserId () const
 Returns the value of ClientUserId. More...
 
virtual void setClientUserIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field ClientUserId. More...
 
virtual void getClientUserIdValue (Session *pSession, UaVariant &value)
 Sets the value of ClientUserId to argument value. More...
 
virtual void setComment (const UaLocalizedText &Comment)
 Sets the Comment value. More...
 
virtual UaLocalizedText getComment (Session *pSession) const
 Returns the value of Comment. More...
 
virtual void setCommentStatus (OpcUa_StatusCode status)
 Set a status code for the event field Comment. More...
 
virtual void getCommentValue (Session *pSession, UaVariant &value)
 Sets the value of Comment to argument value. More...
 
virtual void setConditionClassId (const UaNodeId &ConditionClassId)
 Sets the ConditionClassId value. More...
 
virtual UaNodeId getConditionClassId () const
 Returns the value of ConditionClassId. More...
 
virtual void setConditionClassIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field ConditionClassId. More...
 
virtual void getConditionClassIdValue (Session *pSession, UaVariant &value)
 Sets the value of ConditionClassId to argument value. More...
 
virtual void setConditionClassName (const UaLocalizedText &ConditionClassName)
 Sets the ConditionClassName value. More...
 
virtual UaLocalizedText getConditionClassName (Session *pSession) const
 Returns the value of ConditionClassName. More...
 
virtual void setConditionClassNameStatus (OpcUa_StatusCode status)
 Set a status code for the event field ConditionClassName. More...
 
virtual void getConditionClassNameValue (Session *pSession, UaVariant &value)
 Sets the value of ConditionClassName to argument value. More...
 
virtual void setConditionName (const UaString &ConditionName)
 Sets the ConditionName value. More...
 
virtual UaString getConditionName () const
 Returns the value of ConditionName. More...
 
virtual void setConditionNameStatus (OpcUa_StatusCode status)
 Set a status code for the event field ConditionName. More...
 
virtual void getConditionNameValue (Session *pSession, UaVariant &value)
 Sets the value of ConditionName to argument value. More...
 
virtual void setConditionSubClassId (const UaNodeIdArray &ConditionSubClassId)
 Sets the ConditionSubClassId.
 
virtual void getConditionSubClassId (UaNodeIdArray &ConditionSubClassId) const
 Gets the ConditionSubClassId.
 
virtual void setConditionSubClassIdStatus (OpcUa_StatusCode status)
 Set a status code for the event field ConditionSubClassId. More...
 
virtual void getConditionSubClassIdValue (Session *pSession, UaVariant &value)
 Sets the value of ConditionSubClassId to argument value.
 
virtual void setConditionSubClassName (const UaLocalizedTextArray &ConditionSubClassName)
 Sets the ConditionSubClassName.
 
virtual void getConditionSubClassName (UaLocalizedTextArray &ConditionSubClassName) const
 Gets the ConditionSubClassName.
 
virtual void setConditionSubClassNameStatus (OpcUa_StatusCode status)
 Set a status code for the event field ConditionSubClassName. More...
 
virtual void getConditionSubClassNameValue (Session *pSession, UaVariant &value)
 Sets the value of ConditionSubClassName to argument value.
 
virtual void setEnabledState (OpcUa_Boolean enabledState)
 Sets the EnabledState. More...
 
virtual OpcUa_Boolean getEnabledStateBool ()
 Returns the boolean value of the EnabledState. More...
 
virtual UaLocalizedText getEnabledState ()
 Returns the LocalizedText representation of the EnabledState. More...
 
virtual void setEnabledStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field EnabledState. More...
 
virtual void getEnabledStateValue (Session *pSession, UaVariant &value)
 Sets the value of EnabledState to argument value. More...
 
virtual void getEnabledState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value)
 Sets the value of the EffectiveDisplayName property to value. More...
 
virtual void setLastSeverity (OpcUa_UInt16 LastSeverity)
 Sets the LastSeverity value. More...
 
virtual OpcUa_UInt16 getLastSeverity () const
 Returns the value of LastSeverity. More...
 
virtual void setLastSeverityStatus (OpcUa_StatusCode status)
 Set a status code for the event field LastSeverity. More...
 
virtual void getLastSeverityValue (Session *pSession, UaVariant &value)
 Sets the value of LastSeverity to argument value. More...
 
virtual void setQuality (OpcUa_StatusCode Quality)
 Sets the Quality value. More...
 
virtual OpcUa_StatusCode getQuality () const
 Returns the value of Quality. More...
 
virtual void setQualityStatus (OpcUa_StatusCode status)
 Set a status code for the event field Quality. More...
 
virtual void getQualityValue (Session *pSession, UaVariant &value)
 Sets the value of Quality to argument value. More...
 
virtual void setRetain (OpcUa_Boolean Retain)
 Sets the Retain value. More...
 
virtual OpcUa_Boolean getRetain () const
 Returns the value of Retain. More...
 
virtual void setRetainStatus (OpcUa_StatusCode status)
 Set a status code for the event field Retain. More...
 
virtual void getRetainValue (Session *pSession, UaVariant &value)
 Sets the value of Retain to argument value. More...
 
virtual OpcUa::PropertyTypegetBranchIdNode ()
 Returns the BranchId node. More...
 
virtual const OpcUa::PropertyTypegetBranchIdNode () const
 Returns the BranchId node. More...
 
virtual OpcUa::PropertyTypegetClientUserIdNode ()
 Returns the ClientUserId node. More...
 
virtual const OpcUa::PropertyTypegetClientUserIdNode () const
 Returns the ClientUserId node. More...
 
virtual
OpcUa::ConditionVariableType
getCommentNode ()
 Returns the Comment node. More...
 
virtual const
OpcUa::ConditionVariableType
getCommentNode () const
 Returns the Comment node. More...
 
virtual OpcUa::PropertyTypegetConditionClassIdNode ()
 Returns the ConditionClassId node. More...
 
virtual const OpcUa::PropertyTypegetConditionClassIdNode () const
 Returns the ConditionClassId node. More...
 
virtual OpcUa::PropertyTypegetConditionClassNameNode ()
 Returns the ConditionClassName node. More...
 
virtual const OpcUa::PropertyTypegetConditionClassNameNode () const
 Returns the ConditionClassName node. More...
 
virtual OpcUa::PropertyTypegetConditionNameNode ()
 Returns the ConditionName node. More...
 
virtual const OpcUa::PropertyTypegetConditionNameNode () const
 Returns the ConditionName node. More...
 
virtual OpcUa::PropertyTypegetConditionSubClassIdNode ()
 Returns the ConditionSubClassId node. More...
 
virtual const OpcUa::PropertyTypegetConditionSubClassIdNode () const
 Returns the ConditionSubClassId node. More...
 
virtual OpcUa::PropertyTypegetConditionSubClassNameNode ()
 Returns the ConditionSubClassName node. More...
 
virtual const OpcUa::PropertyTypegetConditionSubClassNameNode () const
 Returns the ConditionSubClassName node. More...
 
virtual
OpcUa::TwoStateVariableType
getEnabledStateNode ()
 Returns the EnabledState node. More...
 
virtual const
OpcUa::TwoStateVariableType
getEnabledStateNode () const
 Returns the EnabledState node. More...
 
virtual
OpcUa::ConditionVariableType
getLastSeverityNode ()
 Returns the LastSeverity node. More...
 
virtual const
OpcUa::ConditionVariableType
getLastSeverityNode () const
 Returns the LastSeverity node. More...
 
virtual
OpcUa::ConditionVariableType
getQualityNode ()
 Returns the Quality node. More...
 
virtual const
OpcUa::ConditionVariableType
getQualityNode () const
 Returns the Quality node. More...
 
virtual OpcUa::PropertyTypegetRetainNode ()
 Returns the Retain node. More...
 
virtual const OpcUa::PropertyTypegetRetainNode () const
 Returns the Retain node. More...
 
virtual void useAccessInfoFromType ()
 Applies the NodeAccessInfo set at the ConditionTypeBase and its children. More...
 
void useAccessInfoFromInstance (ConditionTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
virtual UaStatus triggerEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
 Send event with current event field data to the subscribed clients. More...
 
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...
 

Static Public Member Functions

static void createTypes ()
 Create the related type nodes for condition classes.
 
static void addEnabledStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Enabled state strings for additional locale.
 
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.
 

Protected Member Functions

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

Detailed Description

Class implementing the UaObject interface for the ConditionType.

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.

Variable members of the ConditionType:

Browse Name DataType TypeDefinition Modelling Rule See Also
BranchId NodeId PropertyType Mandatory getBranchId, setBranchId
ClientUserId String PropertyType Mandatory getClientUserId, setClientUserId
Comment LocalizedText ConditionVariableType Mandatory getComment, setComment
ConditionClassId NodeId PropertyType Mandatory getConditionClassId, setConditionClassId
ConditionClassName LocalizedText PropertyType Mandatory getConditionClassName, setConditionClassName
ConditionName String PropertyType Mandatory getConditionName, setConditionName
ConditionSubClassId NodeId PropertyType Optional getConditionSubClassId, setConditionSubClassId
ConditionSubClassName LocalizedText PropertyType Optional getConditionSubClassName, setConditionSubClassName
EnabledState LocalizedText TwoStateVariableType Mandatory getEnabledState, setEnabledState
LastSeverity UInt16 ConditionVariableType Mandatory getLastSeverity, setLastSeverity
Quality StatusCode ConditionVariableType Mandatory getQuality, setQuality
Retain Boolean PropertyType Mandatory getRetain, setRetain

Method members of the ConditionType:

Browse Name Modelling Rule
AddComment Mandatory
ConditionRefresh None
ConditionRefresh2 None
Disable Mandatory
Enable Mandatory

The ConditionType defines all general characteristics of a Condition. All other ConditionTypes derive from it.

The FALSE state of the EnabledState shall not be extended with a substate machine. The ConditionType inherits all Properties of the BaseEventType.

SourceNode identifies the ConditionSource. If the ConditionSource is not a Node in the AddressSpace, the NodeId is set to null. The SourceNode is the Node which the condition is associated with, it may be the same as the InputNode for an alarm, but it may be a separate node. For example, a motor which is a variable with a value that is an RPM may be the ConditionSource for Conditions that are related to the motor, as well as a temperature sensor associated with the motor. In the former, the InputNode for the High RPM alarm is the value of the Motor RPM, while in the later the InputNode of the High Alarm would be the value of the temperature sensor that is associated with the motor.

Events are only generated for Conditions that have their Retain field set to true.

The NodeId of the Condition instance is used as ConditionId. It is not explicitly modelled as a component of the ConditionType. However, it can be requested with the following SimpleAttributeOperand in the SelectClause of the EventFilter:

Name Type Description
typeId NodeId NodeId of the ConditionType Node
browsePath[] QualifiedName empty
attributeId IntegerId Id of the NodeId Attribute

See also ConditionType for a documentation of the complete Information Model.

Constructor & Destructor Documentation

OpcUa::ConditionType::ConditionType ( const UaNodeId nodeId,
UaObject pInstanceDeclarationObject,
NodeManagerConfig pNodeConfig,
const UaNodeId sourceNode,
const UaString sourceName,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class ConditionType.

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 availability 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]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]sourceNodeNodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]sourceNameName of the source used for this condition object
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::ConditionType::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.

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 availability 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]nodeIdNodeId of the new object
[in]nameName of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]browseNameNameSpaceIndexNamespace index used for the browse name
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]sourceNodeNodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]sourceNameName of the source used for this condition object
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::ConditionType::ConditionType ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Constructs an instance of the class ConditionType with all components.

Parameters
[in]pBaseNodeThe "tree" of nodes that specifies the attributes of the instance and its children
[in]pFactoryThe factory to create the children
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

UaStatus OpcUa::ConditionType::AddComment ( const ServiceContext serviceContext,
UaByteString EventId,
const UaLocalizedText Comment 
)
virtual

Applies a comment to a specific state of a Condition instance.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall also allow Clients to call the AddComment Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the ConditionType Node.

Method Result Codes

ResultCode Description
Bad_MethodInvalid The method id does not refer to a method for the specified object. The MethodId provided does not correspond to the ObjectId provided.
Bad_EventIdUnknown The specified EventId is not known to the Server.
Bad_NodeIdUnknown The node id refers to a node that does not exist in the server address space. Used to indicate that the specified Object is not valid or that the Method was called on the ConditionType Node.
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
[in]EventIdThe identifier for the event to comment.
[in]CommentThe comment to add to the condition.

Implements OpcUa::ConditionTypeBase.

OpcUa_StatusCode OpcUa::ConditionType::deleteBranch ( const UaNodeId branchNodeId)

Deletes the branch identified by the branch NodeId.

Returns
Result code for the call.
Parameters
[in]branchNodeIdNodeId of the branch to delete.
UaStatus OpcUa::ConditionType::Disable ( const ServiceContext serviceContext)
virtual

Changes a Condition instance to the Disabled state.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall allow Clients to call the Disable method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the ConditionType node.

Method Result Codes

ResultCode Description
Bad_ConditionAlreadyDisabled The addressed Condition is already disabled.
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implements OpcUa::ConditionTypeBase.

UaStatus OpcUa::ConditionType::Enable ( const ServiceContext serviceContext)
virtual

Changes a Condition instance to the enabled state.

Normally, the NodeId of the object instance as the ObjectId is passed to the Call Service. However, some Servers do not expose Condition instances in the AddressSpace. Therefore all Servers shall allow Clients to call the Enable Method by specifying ConditionId as the ObjectId. The Method cannot be called with an ObjectId of the ConditionType Node. If the condition instance is not exposed, it may be difficult for a Client to determine the ConditionId for a disabled condition.

Method Result Codes

ResultCode Description
Bad_ConditionAlreadyEnabled The addressed Condition is already enabled.
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implements OpcUa::ConditionTypeBase.

void OpcUa::ConditionType::getAllBranches ( UaPointerArray< ConditionTypeData > &  branchArray)

Returns an array of the available branches.

Parameters
[out]branchArrayArray of branches represented by an array of event data pointers.
ConditionTypeData * OpcUa::ConditionType::getBranch ( const UaNodeId branchNodeId)

Returns a pointer to the branch event data based on the passed branch NodeId.

Returns
The event data object pointer for the branch. NULL if the branch can not be found.
Parameters
[in]branchNodeIdNodeId of the branch to return.
ConditionTypeData * OpcUa::ConditionType::getBranchByEventId ( const UaByteString eventId,
UaByteString userEventId 
)

Returns a pointer to the branch event data based on the passed EventId.

The function extracts also the user eventId provided in ConditionType::triggerBranchEvent().

Returns
The event data object pointer for the branch. NULL if the branch can not be found.
Parameters
[in]eventIdEventId provided by the client in an Acknowledge, AddComment or Confirm call.
[out]userEventIdExtracted user event data provided in ConditionType::triggerBranchEvent().
OpcUa_UInt32 OpcUa::ConditionType::getBranchCount ( )

Returns the number of active branches.

Returns
The count of condition branches.
UaNodeId OpcUa::ConditionType::getConditionBranchNodeId ( )
virtual

Returns the condition branch NodeId for the condition object.

This is used by the SDK to detect if the condition event data is from a branch.

Reimplemented from UaEventData.

UaNodeId OpcUa::ConditionType::getConditionNodeId ( )
virtual

Returns the condition NodeId for the condition object.

This is used by the SDK to detect if the event data is from a condition event.

Reimplemented from UaEventData.

OpcUa_Boolean OpcUa::ConditionType::getConditionRetain ( )
virtual

Returns the Retain flag for the condition object.

This is used by the SDK to detect if the condition event data indicates an interesting state.

Reimplemented from UaEventData.

void OpcUa::ConditionType::setInvalid ( )
virtual

Set the entry to invalid.

This method can be overwritten by a derived class to set the internal state to invalid until the object gets deleted when the reference count goes to zero. This method is used if the object should be invalidated but can not be deleted since the lifetime is controlled by the reference count.

Reimplemented from ChainEntry.

UaStatus OpcUa::ConditionType::triggerBranchEvent ( ConditionTypeData pConditionTypeData,
const UaDateTime time,
const UaDateTime receiveTime,
const UaByteString userEventId 
)

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.

Returns
Result code for the call.
Parameters
[in]pConditionTypeDataEvent data of the condition branch to send a snapshot of the branch to the client(s).
[in]timeTime 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]receiveTimeReceiveTime provides the time the OPC UA Server received the Event from the underlying device or another Server.
[in]userEventIdThe 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 and the BranchId. The EventId is provided by the client in calls back to the server like in an alarm acknowledgment. The user specific part can be extracted from the EventId provided by the client by using ConditionType::getBranchByEventId()

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