C++ Based OPC UA Client/Server SDK
1.5.5.355
|
Generated base class for a AlarmConditionType. More...
#include <opcua_alarmconditiontypebase.h>
Inherits OpcUa::AcknowledgeableConditionType.
Inherited by OpcUa::AlarmConditionType.
Public Member Functions | |
AlarmConditionTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the AlarmConditionType condition type using an instance declaration node as base. | |
AlarmConditionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the AlarmConditionType condition type. | |
AlarmConditionTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class AlarmConditionTypeBase with all components. More... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the AlarmConditionType. | |
virtual void | getFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data) |
Get the field value for the passed index. More... | |
void | clearFieldData () |
Clears the event field data after event processing. | |
UaNodeId | createBranch () |
Creates a new branch from the current state and adds the branch to a list managed by the condition object. More... | |
virtual UaStatus | beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments) |
Call method of an UA object. More... | |
virtual UaStatus | call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag) |
Synchronous version of the MethodManager method call executed in a worker thread. | |
virtual void | setActiveState (OpcUa_Boolean activeState) |
Sets the ActiveState. More... | |
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 | 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 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 | 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 void | setSuppressedState (OpcUa_Boolean suppressedState) |
Sets the SuppressedState. 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 OpcUa::PropertyType * | getInputNodeNode () |
Returns the InputNode node. More... | |
virtual OpcUa::PropertyType * | getMaxTimeShelvedNode () |
Returns the MaxTimeShelved node. More... | |
virtual OpcUa::ShelvedStateMachineType * | getShelvingState () |
Returns the ShelvingState node. More... | |
virtual OpcUa::PropertyType * | getSuppressedOrShelvedNode () |
Returns the SuppressedOrShelved node. More... | |
virtual OpcUa::TwoStateVariableType * | getSuppressedStateNode () |
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 | setEnabledState (OpcUa_Boolean enabledState) |
Sets the EnabledState. More... | |
virtual OpcUa_Boolean | getEnabledStateBool () |
Returns the boolean value of the EnabledState. More... | |
virtual UaLocalizedText | getEnabledState () |
Returns the LocalizedText representation of the EnabledState. More... | |
virtual void | setEnabledStateStatus (OpcUa_StatusCode status) |
Set a status code for the event field EnabledState. More... | |
virtual void | getEnabledStateValue (Session *pSession, UaVariant &value) |
Sets the value of EnabledState to argument value. More... | |
virtual void | getEnabledState_EffectiveDisplayNameValue (Session *pSession, OpcUa_Variant &value) |
Sets the value of the EffectiveDisplayName property to value. More... | |
virtual void | setLastSeverity (OpcUa_UInt16 LastSeverity) |
Sets the LastSeverity value. More... | |
virtual OpcUa_UInt16 | getLastSeverity () const |
Returns the value of LastSeverity. More... | |
virtual void | setLastSeverityStatus (OpcUa_StatusCode status) |
Set a status code for the event field LastSeverity. More... | |
virtual void | getLastSeverityValue (Session *pSession, UaVariant &value) |
Sets the value of LastSeverity to argument value. More... | |
virtual void | setQuality (OpcUa_StatusCode Quality) |
Sets the Quality value. More... | |
virtual OpcUa_StatusCode | getQuality () const |
Returns the value of Quality. More... | |
virtual void | setQualityStatus (OpcUa_StatusCode status) |
Set a status code for the event field Quality. More... | |
virtual void | getQualityValue (Session *pSession, UaVariant &value) |
Sets the value of Quality to argument value. More... | |
virtual void | setRetain (OpcUa_Boolean Retain) |
Sets the Retain value. More... | |
virtual OpcUa_Boolean | getRetain () const |
Returns the value of Retain. More... | |
virtual void | setRetainStatus (OpcUa_StatusCode status) |
Set a status code for the event field Retain. More... | |
virtual void | getRetainValue (Session *pSession, UaVariant &value) |
Sets the value of Retain to argument value. More... | |
virtual OpcUa::PropertyType * | getBranchIdNode () |
Returns the BranchId node. More... | |
virtual OpcUa::PropertyType * | getClientUserIdNode () |
Returns the ClientUserId node. More... | |
virtual OpcUa::ConditionVariableType * | getCommentNode () |
Returns the Comment node. More... | |
virtual OpcUa::PropertyType * | getConditionClassIdNode () |
Returns the ConditionClassId node. More... | |
virtual OpcUa::PropertyType * | getConditionClassNameNode () |
Returns the ConditionClassName node. More... | |
virtual OpcUa::PropertyType * | getConditionNameNode () |
Returns the ConditionName node. More... | |
virtual OpcUa::TwoStateVariableType * | getEnabledStateNode () |
Returns the EnabledState node. More... | |
virtual OpcUa::ConditionVariableType * | getLastSeverityNode () |
Returns the LastSeverity node. More... | |
virtual OpcUa::ConditionVariableType * | getQualityNode () |
Returns the Quality node. More... | |
virtual OpcUa::PropertyType * | getRetainNode () |
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::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 | ~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 AlarmConditionType.
This class contains the auto generated code for the object type AlarmConditionType representing an OPC UA condition type. This class is used to create the condition type and to create and represent the condition object in the server address space. It provides also the UaEventData interface for the access to event data containing the current state of the condition for events sent to the client.
Object members of the AlarmConditionType:
Browse Name | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|
ShelvingState | ShelvedStateMachineType | Optional | getShelvingState |
Variable members of the AlarmConditionType:
Browse Name | DataType | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|---|
ActiveState | LocalizedText | TwoStateVariableType | Mandatory | getActiveState, setActiveState |
InputNode | NodeId | PropertyType | Mandatory | getInputNode, setInputNode |
MaxTimeShelved | Duration | PropertyType | Optional | getMaxTimeShelved, setMaxTimeShelved |
SuppressedOrShelved | Boolean | PropertyType | Mandatory | getSuppressedOrShelved, setSuppressedOrShelved |
SuppressedState | LocalizedText | TwoStateVariableType | Optional | getSuppressedState, setSuppressedState |
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::AlarmConditionTypeBase::AlarmConditionTypeBase | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class AlarmConditionTypeBase with all components.
[in] | pBaseNode | The "tree" of nodes that specifies the attributes of the instance and its children. |
[in] | pFactory | The factory to create the children. |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space. |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided. |
|
virtual |
Call method of an UA object.
Implementation of the MethodManager interface method beginCall.
Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.
UaNodeId OpcUa::AlarmConditionTypeBase::createBranch | ( | ) |
Creates a new branch from the current state and adds the branch to a list managed by the condition object.
ConditionType::getBranch() and ConditionType::deleteBranch() can be used to access or to delete the branch.
|
virtual |
Returns the LocalizedText representation of the ActiveState.
See AlarmConditionTypeBase::getActiveStateBool for a detailed description of ActiveState.
|
virtual |
Sets the value of the EffectiveDisplayName property to value.
Reimplemented in OpcUa::NonExclusiveLimitAlarmType, and OpcUa::ExclusiveLimitAlarmType.
|
virtual |
Returns the boolean value of 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 |
|
virtual |
Returns the ActiveState node.
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 |
|
virtual |
Sets the value of ActiveState to argument value.
See AlarmConditionTypeBase::getActiveStateBool for a detailed description of ActiveState.
|
virtual |
Get the field value for the passed index for optional fields of the AlarmConditionType.
This function must be overwritten by derived classes to provide the optional fields registered with AlarmConditionTypeData::registerOptionalEventFields.
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
|
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::AcknowledgeableConditionTypeBase.
Reimplemented in OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::NonExclusiveDeviationAlarmType, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::ExclusiveDeviationAlarmType, OpcUa::CertificateExpirationAlarmType, OpcUa::NonExclusiveRateOfChangeAlarmType, OpcUa::OffNormalAlarmTypeBase, OpcUa::ExclusiveRateOfChangeAlarmType, OpcUa::NonExclusiveLevelAlarmType, OpcUa::ExclusiveLevelAlarmType, OpcUa::TripAlarmType, OpcUa::DiscreteAlarmTypeBase, and OpcUa::SystemOffNormalAlarmType.
|
virtual |
Returns the value of InputNode.
Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state.
If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.
|
virtual |
Returns the InputNode node.
Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state.
If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.
|
virtual |
Sets the value of InputNode to argument value.
Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state.
If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.
|
virtual |
Returns the value of MaxTimeShelved.
If the optional MaxTimeShelved node has not been created, the value of the InstanceDeclaration node of the ObjectType is returned.
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
|
virtual |
Returns the MaxTimeShelved node.
If the Variable has not been created yet, this method returns NULL.
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
|
virtual |
Sets the value of MaxTimeShelved to argument value.
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
|
virtual |
Returns the ShelvingState node.
If the Object has not been created yet, this method creates the node and returns it.
Suggests whether an Alarm shall (temporarily) be prevented from being displayed to the user.
It is quite often used to block nuisance Alarms.
|
virtual |
Returns the value of SuppressedOrShelved.
The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.
When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.
|
virtual |
Returns the SuppressedOrShelved node.
The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.
When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.
|
virtual |
Sets the value of SuppressedOrShelved to argument value.
The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.
When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.
|
virtual |
Returns the LocalizedText representation of the SuppressedState.
See AlarmConditionTypeBase::getSuppressedStateBool for a detailed description of SuppressedState.
|
virtual |
Returns the boolean value of the SuppressedState.
If m_pSuppressedState is NULL, OpcUa_False is returned.
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é |
|
virtual |
Returns the SuppressedState node.
If the Variable has not been created yet, this method returns NULL.
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é |
|
virtual |
Sets the value of SuppressedState to argument value.
See AlarmConditionTypeBase::getSuppressedStateBool for a detailed description of SuppressedState.
|
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 in OpcUa::AlarmConditionType.
|
virtual |
Set a status code for the event field ActiveState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See AlarmConditionTypeBase::setActiveState for a detailed description of ActiveState.
|
virtual |
Sets the InputNode value.
Provides the NodeId of the Variable the Value of which is used as primary input in the calculation of the Alarm state.
If this Variable is not in the AddressSpace, a Null NodeId shall be provided. In some systems, an Alarm may be calculated based on multiple Variables Values, it is up to the system to determine which Variable’s NodeId is used.
|
virtual |
Set a status code for the event field InputNode.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the MaxTimeShelved value.
If the optional MaxTimeShelved node has not been created, this method adds it to the address space.
Optional Property used to set the maximum time that an Alarm Condition may be shelved.
The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. If this Property is present it will be an upper limit on the duration passed into a TimedShelve method call. If a value that exceeds the value of this property is passed to the TimedShelve method, then a Bad_ShelvingTimeOutOfRange error code is returned on the call. If this Property is present it will also be enforced for the OneShotShelved state, in that a Alarm Condition will transition to the Unshelved state from the OneShotShelved state if the duration specified in this Property expires following a OneShotShelve operation without a change of any of the other items associated with the Condition.
|
virtual |
Set a status code for the event field MaxTimeShelved.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
virtual |
Sets the SuppressedOrShelved value.
The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.
When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the Suppressed or Shelved state.
|
virtual |
Set a status code for the event field SuppressedOrShelved.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
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 in OpcUa::AlarmConditionType.
|
virtual |
Set a status code for the event field SuppressedState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
See AlarmConditionTypeBase::setSuppressedState for a detailed description of SuppressedState.
|
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::AcknowledgeableConditionTypeBase.
Reimplemented in OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::CertificateExpirationAlarmType, OpcUa::NonExclusiveDeviationAlarmType, OpcUa::ExclusiveDeviationAlarmType, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmType, OpcUa::ExclusiveRateOfChangeAlarmType, OpcUa::NonExclusiveLevelAlarmType, OpcUa::ExclusiveLevelAlarmType, OpcUa::DiscreteAlarmTypeBase, OpcUa::TripAlarmType, and OpcUa::SystemOffNormalAlarmType.
void OpcUa::AlarmConditionTypeBase::useAccessInfoFromInstance | ( | AlarmConditionTypeBase * | pOther | ) |
Uses the NodeAccessInfo of pOther and its children.
|
virtual |
Applies the NodeAccessInfo set at the AlarmConditionTypeBase and its children.
Reimplemented from OpcUa::AcknowledgeableConditionTypeBase.
Reimplemented in OpcUa::NonExclusiveLimitAlarmTypeBase, OpcUa::LimitAlarmTypeBase, OpcUa::CertificateExpirationAlarmType, OpcUa::NonExclusiveDeviationAlarmType, OpcUa::ExclusiveDeviationAlarmType, OpcUa::ExclusiveLimitAlarmTypeBase, OpcUa::OffNormalAlarmTypeBase, OpcUa::NonExclusiveRateOfChangeAlarmType, OpcUa::ExclusiveRateOfChangeAlarmType, OpcUa::NonExclusiveLevelAlarmType, OpcUa::ExclusiveLevelAlarmType, OpcUa::DiscreteAlarmTypeBase, OpcUa::TripAlarmType, and OpcUa::SystemOffNormalAlarmType.