C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
Class implementing the UaObject interface for the AcknowledgeableConditionType. More...
#include <opcua_acknowledgeableconditiontype.h>
Inherits OpcUa::AcknowledgeableConditionTypeBase.
Inherited by OpcUa::AlarmConditionTypeBase.
Public Member Functions | |
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) |
Acknowledges an Event Notification for a Condition instance state where AckedState is FALSE. More... | |
virtual UaStatus | Confirm (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment) |
Confirms an Event Notification for a Condition instance state where ConfirmedState was set to FALSE. More... | |
virtual void | setConfirmedState (OpcUa_Boolean confirmedState) |
Sets the ConfirmedState. More... | |
virtual void | setConfirmedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field ConfirmedState. More... | |
virtual void | setAckedState (OpcUa_Boolean ackedState) |
Sets the AckedState. More... | |
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... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the AcknowledgeableConditionType. | |
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 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 () |
Returns the boolean value of the AckedState. More... | |
virtual UaLocalizedText | getAckedState () |
Returns the LocalizedText representation of the AckedState. More... | |
virtual void | setAckedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field AckedState. More... | |
virtual void | getAckedStateValue (Session *pSession, UaVariant &value) |
Sets the value of AckedState to argument value. More... | |
virtual OpcUa_Boolean | getConfirmedStateBool () |
Returns the boolean value of the ConfirmedState. More... | |
virtual UaLocalizedText | getConfirmedState () |
Returns the LocalizedText representation of the ConfirmedState. More... | |
virtual void | getConfirmedStateValue (Session *pSession, UaVariant &value) |
Sets the value of ConfirmedState to argument value. More... | |
virtual OpcUa::TwoStateVariableType * | getAckedStateNode () |
Returns the AckedState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getAckedStateNode () const |
Returns the AckedState node. More... | |
virtual OpcUa::TwoStateVariableType * | getConfirmedStateNode () |
Returns the ConfirmedState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getConfirmedStateNode () const |
Returns the ConfirmedState node. More... | |
virtual void | useAccessInfoFromType () |
Applies the NodeAccessInfo set at the AcknowledgeableConditionTypeBase and its children. More... | |
void | useAccessInfoFromInstance (AcknowledgeableConditionTypeBase *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 | 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) |
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... | |
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. 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... | |
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 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::PropertyType * | getBranchIdNode () |
Returns the BranchId node. More... | |
virtual const OpcUa::PropertyType * | getBranchIdNode () const |
Returns the BranchId node. More... | |
virtual OpcUa::PropertyType * | getClientUserIdNode () |
Returns the ClientUserId node. More... | |
virtual const OpcUa::PropertyType * | getClientUserIdNode () 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::PropertyType * | getConditionClassIdNode () |
Returns the ConditionClassId node. More... | |
virtual const OpcUa::PropertyType * | getConditionClassIdNode () const |
Returns the ConditionClassId node. More... | |
virtual OpcUa::PropertyType * | getConditionClassNameNode () |
Returns the ConditionClassName node. More... | |
virtual const OpcUa::PropertyType * | getConditionClassNameNode () const |
Returns the ConditionClassName node. More... | |
virtual OpcUa::PropertyType * | getConditionNameNode () |
Returns the ConditionName node. More... | |
virtual const OpcUa::PropertyType * | getConditionNameNode () const |
Returns the ConditionName node. More... | |
virtual OpcUa::PropertyType * | getConditionSubClassIdNode () |
Returns the ConditionSubClassId node. More... | |
virtual const OpcUa::PropertyType * | getConditionSubClassIdNode () const |
Returns the ConditionSubClassId node. More... | |
virtual OpcUa::PropertyType * | getConditionSubClassNameNode () |
Returns the ConditionSubClassName node. More... | |
virtual const OpcUa::PropertyType * | getConditionSubClassNameNode () 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::PropertyType * | getRetainNode () |
Returns the Retain node. More... | |
virtual const OpcUa::PropertyType * | getRetainNode () const |
Returns the Retain node. More... | |
void | useAccessInfoFromInstance (ConditionTypeBase *pInstance) |
Uses the NodeAccessInfo of pOther and its children. 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 type related static members of the class. | |
static void | clearStaticMembers () |
Clear the static members of the class. | |
static void | addAckedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Acked state strings for additional locale. | |
static void | addConfirmedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Confirmed state strings for additional locale. | |
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 | 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 | ~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. | |
Protected Member Functions inherited from OpcUa::ConditionTypeBase | |
virtual | ~ConditionTypeBase () |
Destroys the ConditionType object. | |
Class implementing the UaObject interface for the AcknowledgeableConditionType.
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 AcknowledgeableConditionType:
Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|---|
AckedState | LocalizedText | TwoStateVariableType | Mandatory | getAckedState, setAckedState |
ConfirmedState | LocalizedText | TwoStateVariableType | Optional | getConfirmedState, setConfirmedState |
EnabledState | LocalizedText | TwoStateVariableType | Mandatory | getEnabledState, setEnabledState |
Method members of the AcknowledgeableConditionType:
Browse Name | Modelling Rule |
---|---|
Acknowledge | Mandatory |
Confirm | Optional |
Extends the ConditionType by defining acknowledgement characteristics. It is an abstract type.
The AcknowledgeableConditionType inherits all Properties of the ConditionType.
AcknowledgeableConditions expose states to indicate whether a Condition has to be acknowledged or confirmed.
The Confirmed Acknowledge model is typically used to differentiate between acknowledging the presence of a Condition and having done something to address the Condition. For example an Operator receiving a motor high temperature Notification calls the Acknowledge method to inform the Server that the high temperature has been observed. The Operator then takes some action such as lowering the load on the motor in order to reduce the temperature. The Operator then calls the Confirm method to inform the Server that a corrective action has been taken.
AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state. When the Condition instance is acknowledged the AckedState is set to TRUE. ConfirmedState indicates whether it requires confirmation. The two states are substates of the TRUE EnabledState. The EventId used in the Event Notification is considered the identifier of this state and has to be used when calling the methods for acknowledgement or confirmation.
A Server may require that previous states be acknowledged. If the acknowledgement of a previous state is still open and a new state also requires acknowledgement, the Server shall create a branch of the Condition instance. In situations where state changes occur in short succession there can be multiple unacknowledged states and the Server has to maintain ConditionBranches for all previous unacknowledged states. These branches will be deleted after they have been acknowledged or if they reached their final state. Clients are expected to keep track of all ConditionBranches where AckedState is FALSE to allow acknowledgement of those. See also ConditionTypeData for more information about ConditionBranches and the examples in Annex B.1 of Part 9 of the OPC UA Specification. The handling of the AckedState and branches also applies to the ConfirmState.
See also AcknowledgeableConditionType for a documentation of the complete Information Model.
OpcUa::AcknowledgeableConditionType::AcknowledgeableConditionType | ( | const UaNodeId & | nodeId, |
UaObject * | pInstanceDeclarationObject, | ||
NodeManagerConfig * | pNodeConfig, | ||
const UaNodeId & | sourceNode, | ||
const UaString & | sourceName, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Construction of the class AcknowledgeableConditionType.
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.
[in] | nodeId | NodeId of the new object |
[in] | pInstanceDeclarationObject | UaObject interface of the instance declaration node used to provide attribute values other than NodeId |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space |
[in] | sourceNode | NodeId of the source node used for this condition object. Can be null if the source is not a node in the address space |
[in] | sourceName | Name of the source used for this condition object |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided |
OpcUa::AcknowledgeableConditionType::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.
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.
[in] | nodeId | NodeId of the new object |
[in] | name | Name of the new object. Used as browse name and also as display name if no additional language specific names are set. |
[in] | browseNameNameSpaceIndex | Namespace index used for the browse name |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space |
[in] | sourceNode | NodeId of the source node used for this condition object. Can be null if the source is not a node in the address space |
[in] | sourceName | Name of the source used for this condition object |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided |
OpcUa::AcknowledgeableConditionType::AcknowledgeableConditionType | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class AcknowledgeableConditionType with all components.
[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 |
|
virtual |
Acknowledges an Event Notification for a Condition instance state where AckedState is FALSE.
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 Acknowledge method by specifying ConditionId. The method cannot be called with an ObjectId of the AcknowledgeableConditionType Node.
ResultCode | Description |
---|---|
Bad_ConditionBranchAlreadyAcked | The EventId does not refer to a state that needs acknowledgement. |
Bad_MethodInvalid | The method id does not refer to a method for the specified object or ConditionId. |
Bad_EventIdUnknown | The specified EventId is not known to the Server. |
Bad_NodeIdInvalid | The node id refers to a node that does not exist in the server address space. Used to indicate that the specified ObjectId is not valid or that the method was called on the ConditionType Node. |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. | |
[in] | EventId | The identifier for the event to comment.. EventId identifying a particular Event Notification. Only Event Notifications where AckedState/Id was FALSE can be acknowledged. |
[in] | Comment | The comment to add to the condition.. A localized text to be applied to the Condition. |
Implements OpcUa::AcknowledgeableConditionTypeBase.
|
virtual |
Confirms an Event Notification for a Condition instance state where ConfirmedState was set to FALSE.
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 Confirm method by specifying ConditionId as the ObjectId. The method cannot be called with an ObjectIf of the AcknowledgeableConditionType Node.
Method Result Codes
ResultCode | Description |
---|---|
Bad_ConditionBranchAlreadyConfirmed | The EventId does not refer to a state that needs confirmation. |
Bad_MethodInvalid | The method id does not refer to a method for the specified object or ConditionId. |
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 ObjectId is not valid or that the method was called on the ConditionType Node. |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. | |
[in] | EventId | The identifier for the event to comment.. EventId identifying a particular Event Notification. Only Event Notifications where ConfirmedState/Id was TRUE can be confirmed. |
[in] | Comment | The comment to add to the condition.. A localized text to be applied to the Conditions. |
Implements OpcUa::AcknowledgeableConditionTypeBase.
|
virtual |
Sets the AckedState.
AckedState when FALSE indicates that the Condition instance requires acknowledgement for the reported Condition state.
When the Condition instance is acknowledged the AckedState is set to TRUE. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unacknowledged | Acknowledged |
de | Unquittiert | Quittiert |
fr | Non-acquitté | Acquitté |
Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.
|
virtual |
Sets the ConfirmedState.
Indicates whether the Condition requires confirmation.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unconfirmed | Confirmed |
de | Unbestätigt | Bestätigt |
fr | Non-Confirmé | Confirmé |
Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.
|
virtual |
Set a status code for the event field ConfirmedState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See AcknowledgeableConditionTypeBase::setConfirmedState for a detailed description of ConfirmedState.
Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.