C++ Based OPC UA Client/Server SDK
1.6.1.391
|
Class implementing the UaObject interface for the AlarmConditionType. More...
#include <opcua_alarmconditiontype.h>
Inherits OpcUa::AlarmConditionTypeBase.
Inherited by OpcUa::DiscrepancyAlarmType, OpcUa::DiscreteAlarmTypeBase, and OpcUa::LimitAlarmTypeBase.
Public Member Functions | |
AlarmConditionType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class AlarmConditionType. More... | |
AlarmConditionType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class AlarmConditionType. More... | |
AlarmConditionType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class AlarmConditionType with all components. More... | |
void | setShelvedState (ShelvedStateMachineType::ShelvedState state) |
Method used to change the state of the ShelvingState. More... | |
ShelvedStateMachineType::ShelvedState | getShelvedState () |
Get the state of the ShelvingState. | |
virtual void | getEnabledState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value) |
Get the EffectiveDisplayName value for the EnabledState of the ConditionType. More... | |
virtual void | setSuppressedState (OpcUa_Boolean suppressedState) |
Sets the SuppressedState. More... | |
virtual void | setActiveState (OpcUa_Boolean activeState) |
Sets the ActiveState. More... | |
virtual void | setSilenceState (OpcUa_Boolean silenceState) |
Sets the SilenceState. | |
virtual void | setOutOfServiceState (OpcUa_Boolean outOfServiceState) |
Sets the OutOfServiceState. | |
virtual void | setLatchedState (OpcUa_Boolean latchedState) |
Sets the LatchedState. | |
virtual UaStatus | PlaceInService (const ServiceContext &serviceContext) |
The PlaceInService Method is used to set the OutOfServiceState to False of a specific Alarm instance. More... | |
virtual UaStatus | RemoveFromService (const ServiceContext &serviceContext) |
virtual UaStatus | Reset (const ServiceContext &serviceContext) |
virtual UaStatus | Silence (const ServiceContext &serviceContext) |
virtual UaStatus | Suppress (const ServiceContext &serviceContext) |
virtual UaStatus | Unsuppress (const ServiceContext &serviceContext) |
Public Member Functions inherited from OpcUa::AlarmConditionTypeBase | |
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 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 | getActiveStateBool () |
Returns the boolean value of the ActiveState. More... | |
virtual UaLocalizedText | getActiveState () |
Returns the LocalizedText representation of the ActiveState. More... | |
virtual void | setActiveStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field ActiveState. More... | |
virtual void | getActiveStateValue (Session *pSession, UaVariant &value) |
Sets the value of ActiveState to argument value. More... | |
virtual void | getActiveState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value) |
Sets the value of the EffectiveDisplayName property to value. More... | |
virtual void | setAudibleEnabled (OpcUa_Boolean AudibleEnabled) |
Sets the AudibleEnabled value. More... | |
virtual OpcUa_Boolean | getAudibleEnabled () const |
Returns the value of AudibleEnabled. More... | |
virtual void | setAudibleEnabledStatus (OpcUa_StatusCode status) |
Set a status code for the event field AudibleEnabled. More... | |
virtual void | getAudibleEnabledValue (Session *pSession, UaVariant &value) |
Sets the value of AudibleEnabled to argument value. | |
virtual void | setAudibleSound (UaByteString &AudibleSound) |
Sets the AudibleSound value. More... | |
virtual UaByteString | getAudibleSound () const |
Returns the value of AudibleSound. More... | |
virtual void | setAudibleSoundStatus (OpcUa_StatusCode status) |
Set a status code for the event field AudibleSound. More... | |
virtual void | getAudibleSoundValue (Session *pSession, UaVariant &value) |
Sets the value of AudibleSound to argument value. | |
virtual void | setFirstInGroupFlag (OpcUa_Boolean FirstInGroupFlag) |
Sets the FirstInGroupFlag value. More... | |
virtual OpcUa_Boolean | getFirstInGroupFlag () const |
Returns the value of FirstInGroupFlag. More... | |
virtual void | setFirstInGroupFlagStatus (OpcUa_StatusCode status) |
Set a status code for the event field FirstInGroupFlag. More... | |
virtual void | getFirstInGroupFlagValue (Session *pSession, UaVariant &value) |
Sets the value of FirstInGroupFlag to argument value. | |
virtual void | setInputNode (const UaNodeId &InputNode) |
Sets the InputNode value. More... | |
virtual UaNodeId | getInputNode () const |
Returns the value of InputNode. More... | |
virtual void | setInputNodeStatus (OpcUa_StatusCode status) |
Set a status code for the event field InputNode. More... | |
virtual void | getInputNodeValue (Session *pSession, UaVariant &value) |
Sets the value of InputNode to argument value. More... | |
virtual OpcUa_Boolean | getLatchedStateBool () |
Returns the boolean value of the LatchedState. More... | |
virtual UaLocalizedText | getLatchedState () |
Returns the LocalizedText representation of the LatchedState. | |
virtual void | setLatchedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field LatchedState. More... | |
virtual void | getLatchedStateValue (Session *pSession, UaVariant &value) |
Sets the value of LatchedState to argument value. | |
virtual void | setMaxTimeShelved (OpcUa_Double MaxTimeShelved) |
Sets the MaxTimeShelved value. More... | |
virtual OpcUa_Double | getMaxTimeShelved () const |
Returns the value of MaxTimeShelved. More... | |
virtual void | setMaxTimeShelvedStatus (OpcUa_StatusCode status) |
Set a status code for the event field MaxTimeShelved. More... | |
virtual void | getMaxTimeShelvedValue (Session *pSession, UaVariant &value) |
Sets the value of MaxTimeShelved to argument value. More... | |
virtual void | setOffDelay (OpcUa_Double OffDelay) |
Sets the OffDelay value. More... | |
virtual OpcUa_Double | getOffDelay () const |
Returns the value of OffDelay. More... | |
virtual void | setOffDelayStatus (OpcUa_StatusCode status) |
Set a status code for the event field OffDelay. More... | |
virtual void | getOffDelayValue (Session *pSession, UaVariant &value) |
Sets the value of OffDelay to argument value. | |
virtual void | setOnDelay (OpcUa_Double OnDelay) |
Sets the OnDelay value. More... | |
virtual OpcUa_Double | getOnDelay () const |
Returns the value of OnDelay. More... | |
virtual void | setOnDelayStatus (OpcUa_StatusCode status) |
Set a status code for the event field OnDelay. More... | |
virtual void | getOnDelayValue (Session *pSession, UaVariant &value) |
Sets the value of OnDelay to argument value. | |
virtual OpcUa_Boolean | getOutOfServiceStateBool () |
Returns the boolean value of the OutOfServiceState. More... | |
virtual UaLocalizedText | getOutOfServiceState () |
Returns the LocalizedText representation of the OutOfServiceState. | |
virtual void | setOutOfServiceStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field OutOfServiceState. More... | |
virtual void | getOutOfServiceStateValue (Session *pSession, UaVariant &value) |
Sets the value of OutOfServiceState to argument value. | |
virtual void | setReAlarmRepeatCount (OpcUa_Int16 ReAlarmRepeatCount) |
Sets the ReAlarmRepeatCount value. More... | |
virtual OpcUa_Int16 | getReAlarmRepeatCount () const |
Returns the value of ReAlarmRepeatCount. More... | |
virtual void | setReAlarmRepeatCountStatus (OpcUa_StatusCode status) |
Set a status code for the event field ReAlarmRepeatCount. More... | |
virtual void | getReAlarmRepeatCountValue (Session *pSession, UaVariant &value) |
Sets the value of ReAlarmRepeatCount to argument value. | |
virtual void | setReAlarmTime (OpcUa_Double ReAlarmTime) |
Sets the ReAlarmTime value. More... | |
virtual OpcUa_Double | getReAlarmTime () const |
Returns the value of ReAlarmTime. More... | |
virtual void | setReAlarmTimeStatus (OpcUa_StatusCode status) |
Set a status code for the event field ReAlarmTime. More... | |
virtual void | getReAlarmTimeValue (Session *pSession, UaVariant &value) |
Sets the value of ReAlarmTime to argument value. | |
virtual OpcUa_Boolean | getSilenceStateBool () |
Returns the boolean value of the SilenceState. More... | |
virtual UaLocalizedText | getSilenceState () |
Returns the LocalizedText representation of the SilenceState. | |
virtual void | setSilenceStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field SilenceState. More... | |
virtual void | getSilenceStateValue (Session *pSession, UaVariant &value) |
Sets the value of SilenceState to argument value. | |
virtual void | setSuppressedOrShelved (OpcUa_Boolean SuppressedOrShelved) |
Sets the SuppressedOrShelved value. More... | |
virtual OpcUa_Boolean | getSuppressedOrShelved () const |
Returns the value of SuppressedOrShelved. More... | |
virtual void | setSuppressedOrShelvedStatus (OpcUa_StatusCode status) |
Set a status code for the event field SuppressedOrShelved. More... | |
virtual void | getSuppressedOrShelvedValue (Session *pSession, UaVariant &value) |
Sets the value of SuppressedOrShelved to argument value. More... | |
virtual OpcUa_Boolean | getSuppressedStateBool () |
Returns the boolean value of the SuppressedState. More... | |
virtual UaLocalizedText | getSuppressedState () |
Returns the LocalizedText representation of the SuppressedState. More... | |
virtual void | setSuppressedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field SuppressedState. More... | |
virtual void | getSuppressedStateValue (Session *pSession, UaVariant &value) |
Sets the value of SuppressedState to argument value. More... | |
virtual OpcUa::TwoStateVariableType * | getActiveStateNode () |
Returns the ActiveState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getActiveStateNode () const |
Returns the ActiveState node. More... | |
virtual OpcUa::PropertyType * | getAudibleEnabledNode () |
Returns the AudibleEnabled node. More... | |
virtual const OpcUa::PropertyType * | getAudibleEnabledNode () const |
Returns the AudibleEnabled node. More... | |
virtual OpcUa::AudioVariableType * | getAudibleSoundNode () |
Returns the AudibleSound node. More... | |
virtual const OpcUa::AudioVariableType * | getAudibleSoundNode () const |
Returns the AudibleSound node. More... | |
virtual OpcUa::AlarmGroupType * | getFirstInGroup () |
Returns the FirstInGroup node. More... | |
virtual const OpcUa::AlarmGroupType * | getFirstInGroup () const |
Returns the FirstInGroup node. More... | |
virtual OpcUa::PropertyType * | getFirstInGroupFlagNode () |
Returns the FirstInGroupFlag node. More... | |
virtual const OpcUa::PropertyType * | getFirstInGroupFlagNode () const |
Returns the FirstInGroupFlag node. More... | |
virtual OpcUa::PropertyType * | getInputNodeNode () |
Returns the InputNode node. More... | |
virtual const OpcUa::PropertyType * | getInputNodeNode () const |
Returns the InputNode node. More... | |
virtual OpcUa::TwoStateVariableType * | getLatchedStateNode () |
Returns the LatchedState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getLatchedStateNode () const |
Returns the LatchedState node. More... | |
virtual OpcUa::PropertyType * | getMaxTimeShelvedNode () |
Returns the MaxTimeShelved node. More... | |
virtual const OpcUa::PropertyType * | getMaxTimeShelvedNode () const |
Returns the MaxTimeShelved node. More... | |
virtual OpcUa::PropertyType * | getOffDelayNode () |
Returns the OffDelay node. More... | |
virtual const OpcUa::PropertyType * | getOffDelayNode () const |
Returns the OffDelay node. More... | |
virtual OpcUa::PropertyType * | getOnDelayNode () |
Returns the OnDelay node. More... | |
virtual const OpcUa::PropertyType * | getOnDelayNode () const |
Returns the OnDelay node. More... | |
virtual OpcUa::TwoStateVariableType * | getOutOfServiceStateNode () |
Returns the OutOfServiceState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getOutOfServiceStateNode () const |
Returns the OutOfServiceState node. More... | |
virtual OpcUa::PropertyType * | getReAlarmRepeatCountNode () |
Returns the ReAlarmRepeatCount node. More... | |
virtual const OpcUa::PropertyType * | getReAlarmRepeatCountNode () const |
Returns the ReAlarmRepeatCount node. More... | |
virtual OpcUa::PropertyType * | getReAlarmTimeNode () |
Returns the ReAlarmTime node. More... | |
virtual const OpcUa::PropertyType * | getReAlarmTimeNode () const |
Returns the ReAlarmTime node. More... | |
virtual OpcUa::ShelvedStateMachineType * | getShelvingState () |
Returns the ShelvingState node. More... | |
virtual const OpcUa::ShelvedStateMachineType * | getShelvingState () const |
Returns the ShelvingState node. More... | |
virtual OpcUa::TwoStateVariableType * | getSilenceStateNode () |
Returns the SilenceState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getSilenceStateNode () const |
Returns the SilenceState node. More... | |
virtual OpcUa::PropertyType * | getSuppressedOrShelvedNode () |
Returns the SuppressedOrShelved node. More... | |
virtual const OpcUa::PropertyType * | getSuppressedOrShelvedNode () const |
Returns the SuppressedOrShelved node. More... | |
virtual OpcUa::TwoStateVariableType * | getSuppressedStateNode () |
Returns the SuppressedState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getSuppressedStateNode () const |
Returns the SuppressedState node. More... | |
virtual void | useAccessInfoFromType () |
Applies the NodeAccessInfo set at the AlarmConditionTypeBase and its children. More... | |
void | useAccessInfoFromInstance (AlarmConditionTypeBase *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 | 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) |
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 | 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... | |
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 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 | setConfirmedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field 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 OpcUa::TwoStateVariableType * | getConfirmedStateNode () |
Returns the ConfirmedState node. More... | |
void | useAccessInfoFromInstance (AcknowledgeableConditionTypeBase *pInstance) |
Uses the NodeAccessInfo of pOther and its children. 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 | 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 | addActiveStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Active state strings for additional locale. More... | |
static void | addSuppressedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Suppressed state strings for additional locale. More... | |
static void | addOutOfServiceStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add OutOfService state strings for additional locale. More... | |
static void | addSilenceStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Silence state strings for additional locale. More... | |
static void | addLatchedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName) |
Add Latched state strings for additional locale. More... | |
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::AlarmConditionTypeBase | |
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 | 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 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 | 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 | ~AlarmConditionType () |
Destruction. | |
Protected Member Functions inherited from OpcUa::AlarmConditionTypeBase | |
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. | |
Protected Member Functions inherited from OpcUa::ConditionTypeBase | |
virtual | ~ConditionTypeBase () |
Destroys the ConditionType object. | |
Class implementing the UaObject interface for the AlarmConditionType.
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.
Object members of the AlarmConditionType:
Browse Name | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|
<AlarmGroup> | AlarmGroupType | OptionalPlaceholder | |
FirstInGroup | AlarmGroupType | Optional | getFirstInGroup |
ShelvingState | ShelvedStateMachineType | Optional | getShelvingState |
Variable members of the AlarmConditionType:
Method members of the AlarmConditionType:
Browse Name | Modelling Rule |
---|---|
PlaceInService | Optional |
RemoveFromService | Optional |
Reset | Optional |
Silence | Optional |
Suppress | Optional |
Unsuppress | Optional |
An abstract type that extends the AcknowledgeableConditionType by introducing an ActiveState, SuppressedState and ShelvingState.
The AlarmConditionType inherits all Properties of the AcknowledgeableConditionType. The following states are substates of the TRUE EnabledState.
See also AlarmConditionType for a documentation of the complete Information Model.
OpcUa::AlarmConditionType::AlarmConditionType | ( | const UaNodeId & | nodeId, |
UaObject * | pInstanceDeclarationObject, | ||
NodeManagerConfig * | pNodeConfig, | ||
const UaNodeId & | sourceNode, | ||
const UaString & | sourceName, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Construction of the class AlarmConditionType.
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::AlarmConditionType::AlarmConditionType | ( | const UaNodeId & | nodeId, |
const UaString & | name, | ||
OpcUa_UInt16 | browseNameNameSpaceIndex, | ||
NodeManagerConfig * | pNodeConfig, | ||
const UaNodeId & | sourceNode, | ||
const UaString & | sourceName, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Construction of the class AlarmConditionType.
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::AlarmConditionType::AlarmConditionType | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class AlarmConditionType 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 |
|
static |
Add Active state strings for additional locale.
[in] | falseName | Active False state string for the locale to add |
[in] | trueName | Active True state string for the locale to add |
|
static |
Add Latched state strings for additional locale.
[in] | falseName | Suppressed False state string for the locale to add |
[in] | trueName | Suppressed True state string for the locale to add |
|
static |
Add OutOfService state strings for additional locale.
[in] | falseName | Suppressed False state string for the locale to add |
[in] | trueName | Suppressed True state string for the locale to add |
|
static |
Add Silence state strings for additional locale.
[in] | falseName | Suppressed False state string for the locale to add |
[in] | trueName | Suppressed True state string for the locale to add |
|
static |
Add Suppressed state strings for additional locale.
[in] | falseName | Suppressed False state string for the locale to add |
[in] | trueName | Suppressed True state string for the locale to add |
|
virtual |
Get the EffectiveDisplayName value for the EnabledState of the ConditionType.
This function must be overwritten by derived classes to provide the optional field.
[in] | pSession | Interface of the Session context for the attribute write. |
[out] | value | The data for the EffectiveDisplayName. |
Reimplemented from OpcUa::ConditionTypeBase.
|
virtual |
The PlaceInService Method is used to set the OutOfServiceState to False of a specific Alarm instance.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implements OpcUa::AlarmConditionTypeBase.
|
virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implements OpcUa::AlarmConditionTypeBase.
|
virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implements OpcUa::AlarmConditionTypeBase.
|
virtual |
Sets the ActiveState.
ActiveState when set to TRUE indicates that the situation the Condition is representing currently exists.
When a Condition instance is in the inactive state (ActiveState when set to FALSE), it is representing a situation that has returned to a normal state. The transitions of Conditions to the inactive and Active states are triggered by Server specific actions. Subtypes of the AlarmConditionType will have substate models that further define the Active state. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Inactive | Active |
de | Inaktiv | Aktiv |
fr | Inactive | Active |
Reimplemented from OpcUa::AlarmConditionTypeBase.
void OpcUa::AlarmConditionType::setShelvedState | ( | ShelvedStateMachineType::ShelvedState | state | ) |
Method used to change the state of the ShelvingState.
state | the new state of the ShelvingState state machine |
|
virtual |
Sets the SuppressedState.
Used internally by a Server to automatically suppress Alarms due to system specific reasons.
For example, a system may be configured to suppress Alarms that are associated with machinery that is shut down, such as a low level Alarm for a tank that is currently not in use. Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Unsuppressed | Suppressed |
de | Nicht unterdrückt | Unterdrückt |
fr | Présent | Supprimé |
Reimplemented from OpcUa::AlarmConditionTypeBase.
|
virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implements OpcUa::AlarmConditionTypeBase.
|
virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implements OpcUa::AlarmConditionTypeBase.
|
virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implements OpcUa::AlarmConditionTypeBase.