C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
Generated base class for a NonExclusiveLimitAlarmType. More...
#include <opcua_nonexclusivelimitalarmtypebase.h>
Inherits OpcUa::LimitAlarmType.
Inherited by OpcUa::NonExclusiveLimitAlarmType.
Public Member Functions | |
NonExclusiveLimitAlarmTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the NonExclusiveLimitAlarmType condition type using an instance declaration node as base. | |
NonExclusiveLimitAlarmTypeBase (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 NonExclusiveLimitAlarmType condition type. | |
NonExclusiveLimitAlarmTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class NonExclusiveLimitAlarmTypeBase with all components. More... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the NonExclusiveLimitAlarmType. | |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. More... | |
void | clearFieldData () |
Clears the event field data after event processing. | |
UaNodeId | createBranch () |
Creates a new branch from the current state and adds the branch to a list managed by the condition object. More... | |
virtual void | setHighHighState (OpcUa_Boolean highHighState) |
Sets the HighHighState. More... | |
virtual OpcUa_Boolean | getHighHighStateBool () |
Returns the boolean value of the HighHighState. More... | |
virtual UaLocalizedText | getHighHighState () |
Returns the LocalizedText representation of the HighHighState. More... | |
virtual void | setHighHighStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field HighHighState. More... | |
virtual void | getHighHighStateValue (Session *pSession, UaVariant &value) |
Sets the value of HighHighState to argument value. More... | |
virtual void | setHighState (OpcUa_Boolean highState) |
Sets the HighState. More... | |
virtual OpcUa_Boolean | getHighStateBool () |
Returns the boolean value of the HighState. More... | |
virtual UaLocalizedText | getHighState () |
Returns the LocalizedText representation of the HighState. More... | |
virtual void | setHighStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field HighState. More... | |
virtual void | getHighStateValue (Session *pSession, UaVariant &value) |
Sets the value of HighState to argument value. More... | |
virtual void | setLowLowState (OpcUa_Boolean lowLowState) |
Sets the LowLowState. More... | |
virtual OpcUa_Boolean | getLowLowStateBool () |
Returns the boolean value of the LowLowState. More... | |
virtual UaLocalizedText | getLowLowState () |
Returns the LocalizedText representation of the LowLowState. More... | |
virtual void | setLowLowStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field LowLowState. More... | |
virtual void | getLowLowStateValue (Session *pSession, UaVariant &value) |
Sets the value of LowLowState to argument value. More... | |
virtual void | setLowState (OpcUa_Boolean lowState) |
Sets the LowState. More... | |
virtual OpcUa_Boolean | getLowStateBool () |
Returns the boolean value of the LowState. More... | |
virtual UaLocalizedText | getLowState () |
Returns the LocalizedText representation of the LowState. More... | |
virtual void | setLowStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field LowState. More... | |
virtual void | getLowStateValue (Session *pSession, UaVariant &value) |
Sets the value of LowState to argument value. More... | |
virtual OpcUa::TwoStateVariableType * | getHighHighStateNode () |
Returns the HighHighState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getHighHighStateNode () const |
Returns the HighHighState node. More... | |
virtual OpcUa::TwoStateVariableType * | getHighStateNode () |
Returns the HighState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getHighStateNode () const |
Returns the HighState node. More... | |
virtual OpcUa::TwoStateVariableType * | getLowLowStateNode () |
Returns the LowLowState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getLowLowStateNode () const |
Returns the LowLowState node. More... | |
virtual OpcUa::TwoStateVariableType * | getLowStateNode () |
Returns the LowState node. More... | |
virtual const OpcUa::TwoStateVariableType * | getLowStateNode () const |
Returns the LowState node. More... | |
virtual void | useAccessInfoFromType () |
Applies the NodeAccessInfo set at the NonExclusiveLimitAlarmTypeBase and its children. More... | |
void | useAccessInfoFromInstance (NonExclusiveLimitAlarmTypeBase *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 | getNonExclusiveLimitAlarmTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index for optional fields of the NonExclusiveLimitAlarmType. More... | |
Public Member Functions inherited from OpcUa::LimitAlarmType | |
LimitAlarmType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class LimitAlarmType. More... | |
LimitAlarmType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class LimitAlarmType. More... | |
LimitAlarmType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class LimitAlarmType with all components. More... | |
Public Member Functions inherited from OpcUa::LimitAlarmTypeBase | |
LimitAlarmTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the LimitAlarmType condition type using an instance declaration node as base. | |
LimitAlarmTypeBase (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 LimitAlarmType condition type. | |
LimitAlarmTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class LimitAlarmTypeBase 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 void | setBaseHighHighLimit (OpcUa_Double BaseHighHighLimit) |
Sets the BaseHighHighLimit value. More... | |
virtual OpcUa_Double | getBaseHighHighLimit () const |
Returns the value of BaseHighHighLimit. More... | |
virtual void | setBaseHighHighLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field BaseHighHighLimit. More... | |
virtual void | getBaseHighHighLimitValue (Session *pSession, UaVariant &value) |
Sets the value of BaseHighHighLimit to argument value. | |
virtual void | setBaseHighLimit (OpcUa_Double BaseHighLimit) |
Sets the BaseHighLimit value. More... | |
virtual OpcUa_Double | getBaseHighLimit () const |
Returns the value of BaseHighLimit. More... | |
virtual void | setBaseHighLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field BaseHighLimit. More... | |
virtual void | getBaseHighLimitValue (Session *pSession, UaVariant &value) |
Sets the value of BaseHighLimit to argument value. | |
virtual void | setBaseLowLimit (OpcUa_Double BaseLowLimit) |
Sets the BaseLowLimit value. More... | |
virtual OpcUa_Double | getBaseLowLimit () const |
Returns the value of BaseLowLimit. More... | |
virtual void | setBaseLowLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field BaseLowLimit. More... | |
virtual void | getBaseLowLimitValue (Session *pSession, UaVariant &value) |
Sets the value of BaseLowLimit to argument value. | |
virtual void | setBaseLowLowLimit (OpcUa_Double BaseLowLowLimit) |
Sets the BaseLowLowLimit value. More... | |
virtual OpcUa_Double | getBaseLowLowLimit () const |
Returns the value of BaseLowLowLimit. More... | |
virtual void | setBaseLowLowLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field BaseLowLowLimit. More... | |
virtual void | getBaseLowLowLimitValue (Session *pSession, UaVariant &value) |
Sets the value of BaseLowLowLimit to argument value. | |
virtual void | setHighHighLimit (OpcUa_Double HighHighLimit) |
Sets the HighHighLimit value. More... | |
virtual OpcUa_Double | getHighHighLimit () const |
Returns the value of HighHighLimit. More... | |
virtual void | setHighHighLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field HighHighLimit. More... | |
virtual void | getHighHighLimitValue (Session *pSession, UaVariant &value) |
Sets the value of HighHighLimit to argument value. | |
virtual void | setHighLimit (OpcUa_Double HighLimit) |
Sets the HighLimit value. More... | |
virtual OpcUa_Double | getHighLimit () const |
Returns the value of HighLimit. More... | |
virtual void | setHighLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field HighLimit. More... | |
virtual void | getHighLimitValue (Session *pSession, UaVariant &value) |
Sets the value of HighLimit to argument value. | |
virtual void | setLowLimit (OpcUa_Double LowLimit) |
Sets the LowLimit value. More... | |
virtual OpcUa_Double | getLowLimit () const |
Returns the value of LowLimit. More... | |
virtual void | setLowLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field LowLimit. More... | |
virtual void | getLowLimitValue (Session *pSession, UaVariant &value) |
Sets the value of LowLimit to argument value. | |
virtual void | setLowLowLimit (OpcUa_Double LowLowLimit) |
Sets the LowLowLimit value. More... | |
virtual OpcUa_Double | getLowLowLimit () const |
Returns the value of LowLowLimit. More... | |
virtual void | setLowLowLimitStatus (OpcUa_StatusCode status) |
Set a status code for the event field LowLowLimit. More... | |
virtual void | getLowLowLimitValue (Session *pSession, UaVariant &value) |
Sets the value of LowLowLimit to argument value. | |
virtual OpcUa::PropertyType * | getBaseHighHighLimitNode () |
Returns the BaseHighHighLimit node. More... | |
virtual const OpcUa::PropertyType * | getBaseHighHighLimitNode () const |
Returns the BaseHighHighLimit node. More... | |
virtual OpcUa::PropertyType * | getBaseHighLimitNode () |
Returns the BaseHighLimit node. More... | |
virtual const OpcUa::PropertyType * | getBaseHighLimitNode () const |
Returns the BaseHighLimit node. More... | |
virtual OpcUa::PropertyType * | getBaseLowLimitNode () |
Returns the BaseLowLimit node. More... | |
virtual const OpcUa::PropertyType * | getBaseLowLimitNode () const |
Returns the BaseLowLimit node. More... | |
virtual OpcUa::PropertyType * | getBaseLowLowLimitNode () |
Returns the BaseLowLowLimit node. More... | |
virtual const OpcUa::PropertyType * | getBaseLowLowLimitNode () const |
Returns the BaseLowLowLimit node. More... | |
virtual OpcUa::PropertyType * | getHighHighLimitNode () |
Returns the HighHighLimit node. More... | |
virtual const OpcUa::PropertyType * | getHighHighLimitNode () const |
Returns the HighHighLimit node. More... | |
virtual OpcUa::PropertyType * | getHighLimitNode () |
Returns the HighLimit node. More... | |
virtual const OpcUa::PropertyType * | getHighLimitNode () const |
Returns the HighLimit node. More... | |
virtual OpcUa::PropertyType * | getLowLimitNode () |
Returns the LowLimit node. More... | |
virtual const OpcUa::PropertyType * | getLowLimitNode () const |
Returns the LowLimit node. More... | |
virtual OpcUa::PropertyType * | getLowLowLimitNode () |
Returns the LowLowLimit node. More... | |
virtual const OpcUa::PropertyType * | getLowLowLimitNode () const |
Returns the LowLowLimit node. More... | |
void | useAccessInfoFromInstance (LimitAlarmTypeBase *pInstance) |
Uses the NodeAccessInfo of pOther and its children. More... | |
virtual void | getLimitAlarmTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index for optional fields of the LimitAlarmType. More... | |
Public Member Functions inherited from OpcUa::AlarmConditionType | |
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 | setSuppressedStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field 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 | setOutOfServiceStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field OutOfServiceState. More... | |
virtual void | setLatchedState (OpcUa_Boolean latchedState) |
Sets the LatchedState. | |
virtual ShelvedStateMachineType * | getShelvingState () |
Returns the ShelvingState node. More... | |
virtual const ShelvedStateMachineType * | getShelvingState () const |
Returns the ShelvingState node. More... | |
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) |
https://reference.opcfoundation.org/v104/Core/docs/Part9/5.8.8 More... | |
virtual UaStatus | Reset (const ServiceContext &serviceContext) |
https://reference.opcfoundation.org/v104/Core/docs/Part9/5.8.4 More... | |
virtual UaStatus | Silence (const ServiceContext &serviceContext) |
https://reference.opcfoundation.org/v104/Core/docs/Part9/5.8.5 More... | |
virtual UaStatus | Suppress (const ServiceContext &serviceContext) |
https://reference.opcfoundation.org/v104/Core/docs/Part9/5.8.6 More... | |
virtual UaStatus | Unsuppress (const ServiceContext &serviceContext) |
https://reference.opcfoundation.org/v104/Core/docs/Part9/5.8.7 More... | |
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... | |
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 | 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 | 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::BaseDataVariableType * | getFirstInGroupFlagNode () |
Returns the FirstInGroupFlag node. More... | |
virtual const OpcUa::BaseDataVariableType * | 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::BaseDataVariableType * | getReAlarmRepeatCountNode () |
Returns the ReAlarmRepeatCount node. More... | |
virtual const OpcUa::BaseDataVariableType * | 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::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... | |
void | useAccessInfoFromInstance (AlarmConditionTypeBase *pInstance) |
Uses the NodeAccessInfo of pOther and its children. 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 | 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... | |
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 | 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... | |
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 | 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::LimitAlarmType | |
static void | createTypes () |
Create the type related static members of the class. | |
static void | clearStaticMembers () |
Clear the static members of the class. | |
Static Public Member Functions inherited from OpcUa::LimitAlarmTypeBase | |
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::AlarmConditionType | |
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 () |
Clear the static members of the 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 | 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 | ~NonExclusiveLimitAlarmTypeBase () |
Destroys the NonExclusiveLimitAlarmType object. | |
Protected Member Functions inherited from OpcUa::LimitAlarmType | |
virtual | ~LimitAlarmType () |
Destruction. | |
Protected Member Functions inherited from OpcUa::LimitAlarmTypeBase | |
virtual | ~LimitAlarmTypeBase () |
Destroys the LimitAlarmType object. | |
Protected Member Functions inherited from OpcUa::AlarmConditionType | |
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. | |
Generated base class for a NonExclusiveLimitAlarmType.
This class contains the auto generated code for the object type NonExclusiveLimitAlarmType representing an OPC UA condition type. This class is used to create the condition type and to create and represent the condition object in the server address space. It provides also the UaEventData interface for the access to event data containing the current state of the condition for events sent to the client.
Variable members of the NonExclusiveLimitAlarmType:
Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|---|
HighHighState | LocalizedText | TwoStateVariableType | Optional | getHighHighState, setHighHighState |
HighState | LocalizedText | TwoStateVariableType | Optional | getHighState, setHighState |
LowLowState | LocalizedText | TwoStateVariableType | Optional | getLowLowState, setLowLowState |
LowState | LocalizedText | TwoStateVariableType | Optional | getLowState, setLowState |
Used to specify the common behaviour for Alarm Types with multiple non-exclusive limits
HighHighState, HighState, LowState, and LowLowState represent the non-exclusive states. As an example, it is possible that both HighState and HighHighState are in their TRUE state. Vendors may choose to support any subset of these states.
Four optional limits are defined that configure these states. At least the HighState or the LowState shall be provided even though all states are optional. It is implied by the definition of a HighState and a LowState, that these groupings are mutually exclusive. A value cannot exceed both a HighState value and a LowState value simultaneously.
See also NonExclusiveLimitAlarmType for a documentation of the complete Information Model.
OpcUa::NonExclusiveLimitAlarmTypeBase::NonExclusiveLimitAlarmTypeBase | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class NonExclusiveLimitAlarmTypeBase 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. |
UaNodeId OpcUa::NonExclusiveLimitAlarmTypeBase::createBranch | ( | ) |
Creates a new branch from the current state and adds the branch to a list managed by the condition object.
ConditionType::getBranch() and ConditionType::deleteBranch() can be used to access or to delete the branch.
|
virtual |
Get the field value for the passed index.
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
Reimplemented from OpcUa::LimitAlarmTypeBase.
Reimplemented in OpcUa::NonExclusiveDeviationAlarmType, OpcUa::NonExclusiveRateOfChangeAlarmType, and OpcUa::NonExclusiveLevelAlarmType.
|
virtual |
Returns the LocalizedText representation of the HighHighState.
See NonExclusiveLimitAlarmTypeBase::getHighHighStateBool for a detailed description of HighHighState.
|
virtual |
Returns the boolean value of the HighHighState.
If m_pHighHighState is NULL, OpcUa_False is returned.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | HighHigh inactive | HighHigh active |
de | HighHigh inaktiv | HighHigh aktiv |
fr | Très Haute Inactive | Très Haute active |
|
virtual |
Returns the HighHighState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | HighHigh inactive | HighHigh active |
de | HighHigh inaktiv | HighHigh aktiv |
fr | Très Haute Inactive | Très Haute active |
|
virtual |
Returns the HighHighState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | HighHigh inactive | HighHigh active |
de | HighHigh inaktiv | HighHigh aktiv |
fr | Très Haute Inactive | Très Haute active |
|
virtual |
Sets the value of HighHighState to argument value.
See NonExclusiveLimitAlarmTypeBase::getHighHighStateBool for a detailed description of HighHighState.
|
virtual |
Returns the LocalizedText representation of the HighState.
See NonExclusiveLimitAlarmTypeBase::getHighStateBool for a detailed description of HighState.
|
virtual |
Returns the boolean value of the HighState.
If m_pHighState is NULL, OpcUa_False is returned.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | High inactive | High active |
de | High inaktiv | High aktiv |
fr | Haute inactive | Haute active |
|
virtual |
Returns the HighState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | High inactive | High active |
de | High inaktiv | High aktiv |
fr | Haute inactive | Haute active |
|
virtual |
Returns the HighState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | High inactive | High active |
de | High inaktiv | High aktiv |
fr | Haute inactive | Haute active |
|
virtual |
Sets the value of HighState to argument value.
See NonExclusiveLimitAlarmTypeBase::getHighStateBool for a detailed description of HighState.
|
virtual |
Returns the LocalizedText representation of the LowLowState.
See NonExclusiveLimitAlarmTypeBase::getLowLowStateBool for a detailed description of LowLowState.
|
virtual |
Returns the boolean value of the LowLowState.
If m_pLowLowState is NULL, OpcUa_False is returned.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | LowLow inactive | LowLow active |
de | LowLow inaktiv | LowLow aktiv |
fr | Très basse inactive | Très basse active |
|
virtual |
Returns the LowLowState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | LowLow inactive | LowLow active |
de | LowLow inaktiv | LowLow aktiv |
fr | Très basse inactive | Très basse active |
|
virtual |
Returns the LowLowState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | LowLow inactive | LowLow active |
de | LowLow inaktiv | LowLow aktiv |
fr | Très basse inactive | Très basse active |
|
virtual |
Sets the value of LowLowState to argument value.
See NonExclusiveLimitAlarmTypeBase::getLowLowStateBool for a detailed description of LowLowState.
|
virtual |
Returns the LocalizedText representation of the LowState.
See NonExclusiveLimitAlarmTypeBase::getLowStateBool for a detailed description of LowState.
|
virtual |
Returns the boolean value of the LowState.
If m_pLowState is NULL, OpcUa_False is returned.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Low inactive | Low active |
de | Low inaktiv | Low aktiv |
fr | Basse inactive | Basse active |
|
virtual |
Returns the LowState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Low inactive | Low active |
de | Low inaktiv | Low aktiv |
fr | Basse inactive | Basse active |
|
virtual |
Returns the LowState node.
If the Variable has not been created yet, this method returns NULL.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Low inactive | Low active |
de | Low inaktiv | Low aktiv |
fr | Basse inactive | Basse active |
|
virtual |
Sets the value of LowState to argument value.
See NonExclusiveLimitAlarmTypeBase::getLowStateBool for a detailed description of LowState.
|
virtual |
Get the field value for the passed index for optional fields of the NonExclusiveLimitAlarmType.
This function must be overwritten by derived classes to provide the optional fields registered with NonExclusiveLimitAlarmTypeData::registerOptionalEventFields.
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
|
virtual |
Sets the HighHighState.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | HighHigh inactive | HighHigh active |
de | HighHigh inaktiv | HighHigh aktiv |
fr | Très Haute Inactive | Très Haute active |
Reimplemented in OpcUa::NonExclusiveLimitAlarmType.
|
virtual |
Set a status code for the event field HighHighState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See NonExclusiveLimitAlarmTypeBase::setHighHighState for a detailed description of HighHighState.
|
virtual |
Sets the HighState.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | High inactive | High active |
de | High inaktiv | High aktiv |
fr | Haute inactive | Haute active |
Reimplemented in OpcUa::NonExclusiveLimitAlarmType.
|
virtual |
Set a status code for the event field HighState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See NonExclusiveLimitAlarmTypeBase::setHighState for a detailed description of HighState.
|
virtual |
Sets the LowLowState.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | LowLow inactive | LowLow active |
de | LowLow inaktiv | LowLow aktiv |
fr | Très basse inactive | Très basse active |
Reimplemented in OpcUa::NonExclusiveLimitAlarmType.
|
virtual |
Set a status code for the event field LowLowState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See NonExclusiveLimitAlarmTypeBase::setLowLowState for a detailed description of LowLowState.
|
virtual |
Sets the LowState.
Represents one of the four non-exclusive states.
Recommended state names for LocaleIds are listed in the following table.
LocaleId | FALSE State Name | TRUE State Name |
---|---|---|
en | Low inactive | Low active |
de | Low inaktiv | Low aktiv |
fr | Basse inactive | Basse active |
Reimplemented in OpcUa::NonExclusiveLimitAlarmType.
|
virtual |
Set a status code for the event field LowState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See NonExclusiveLimitAlarmTypeBase::setLowState for a detailed description of LowState.
|
virtual |
Send event with current event field data to the subscribed clients.
After setting the changed states of the event this method is used to trigger the event notification that contains the snapshot of the new state of the condition.
[in] | time | Time provides the time the Event occurred. This value is set as close to the event generator as possible. It often comes from the underlying system or device. |
[in] | receiveTime | ReceiveTime provides the time the OPC UA Server received the Event from the underlying device or another Server. |
[in] | userEventId | The server is responsible for generating a unique EventId for every event sent to the client. The SDK uses this parameter userEventId as part of the EventId but adds a unique part. The EventId is provided by the client in calls back to the server like in an alarm acknowledgement. The user specific part can be extracted from the EventId provided by the client by using EventManagerBase::getUserEventId(). |
Reimplemented from OpcUa::LimitAlarmTypeBase.
Reimplemented in OpcUa::NonExclusiveDeviationAlarmType, OpcUa::NonExclusiveRateOfChangeAlarmType, and OpcUa::NonExclusiveLevelAlarmType.
void OpcUa::NonExclusiveLimitAlarmTypeBase::useAccessInfoFromInstance | ( | NonExclusiveLimitAlarmTypeBase * | pOther | ) |
Uses the NodeAccessInfo of pOther and its children.
|
virtual |
Applies the NodeAccessInfo set at the NonExclusiveLimitAlarmTypeBase and its children.
Reimplemented from OpcUa::LimitAlarmTypeBase.
Reimplemented in OpcUa::NonExclusiveDeviationAlarmType, OpcUa::NonExclusiveRateOfChangeAlarmType, and OpcUa::NonExclusiveLevelAlarmType.