UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
OpcUa::OffNormalAlarmType Class Reference

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

#include <opcua_offnormalalarmtype.h>

Inherits OpcUa::OffNormalAlarmTypeBase.

Inherited by OpcUa::SystemOffNormalAlarmType, and OpcUa::TripAlarmType.

Public Member Functions

 OffNormalAlarmType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class OffNormalAlarmType. More...
 
 OffNormalAlarmType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class OffNormalAlarmType. More...
 
 OffNormalAlarmType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class OffNormalAlarmType with all components. More...
 
- Public Member Functions inherited from OpcUa::OffNormalAlarmTypeBase
 OffNormalAlarmTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the OffNormalAlarmType condition type using an instance declaration node as base.
 
 OffNormalAlarmTypeBase (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 OffNormalAlarmType condition type.
 
 OffNormalAlarmTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class OffNormalAlarmTypeBase with all components. More...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the OffNormalAlarmType.
 
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 setNormalState (const UaNodeId &NormalState)
 Sets the NormalState value. More...
 
virtual UaNodeId getNormalState () const
 Returns the value of NormalState. More...
 
virtual void setNormalStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field NormalState. More...
 
virtual OpcUa::PropertyTypegetNormalStateNode ()
 Returns the NormalState node.
 
virtual UaStatus triggerEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
 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. More...
 
virtual void getOffNormalAlarmTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
 Get the field value for the passed index for optional fields of the OffNormalAlarmType. More...
 
- Public Member Functions inherited from OpcUa::DiscreteAlarmType
 DiscreteAlarmType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class DiscreteAlarmType. More...
 
 DiscreteAlarmType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class DiscreteAlarmType. More...
 
 DiscreteAlarmType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class DiscreteAlarmType with all components. More...
 
- Public Member Functions inherited from OpcUa::DiscreteAlarmTypeBase
 DiscreteAlarmTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the DiscreteAlarmType condition type using an instance declaration node as base.
 
 DiscreteAlarmTypeBase (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 DiscreteAlarmType condition type.
 
 DiscreteAlarmTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class DiscreteAlarmTypeBase 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 getDiscreteAlarmTypeOptionalFieldData (OpcUa_UInt32 index, Session *pSession, OpcUa_Variant &data)
 Get the field value for the passed index for optional fields of the DiscreteAlarmType. 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 addActiveStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Active state strings for additional locale. More...
 
void addSuppressedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Suppressed state strings for additional locale. 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)
 
virtual void setActiveState (OpcUa_Boolean activeState)
 
- 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 UaLocalizedText getActiveState ()
 
virtual void setActiveStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field ActiveState. 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 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 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 UaLocalizedText getSuppressedState ()
 
virtual void setSuppressedStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field SuppressedState. More...
 
virtual
OpcUa::TwoStateVariableType
getActiveStateNode ()
 Returns the ActiveState node.
 
virtual OpcUa::PropertyTypegetInputNodeNode ()
 Returns the InputNode node.
 
virtual OpcUa::PropertyTypegetMaxTimeShelvedNode ()
 Returns the MaxTimeShelved node. More...
 
virtual
OpcUa::ShelvedStateMachineType
getShelvingState ()
 Returns the ShelvingState node. More...
 
virtual OpcUa::PropertyTypegetSuppressedOrShelvedNode ()
 Returns the SuppressedOrShelved node.
 
virtual
OpcUa::TwoStateVariableType
getSuppressedStateNode ()
 Returns the SuppressedState node. 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)
 
virtual UaStatus Confirm (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment)
 
void addAckedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Acked state strings for additional locale.
 
void addConfirmedStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Confirmed state strings for additional locale.
 
virtual void setConfirmedState (OpcUa_Boolean confirmedState)
 
virtual void setAckedState (OpcUa_Boolean ackedState)
 
- 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 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 UaLocalizedText getAckedState ()
 
virtual void setAckedStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field AckedState. More...
 
virtual UaLocalizedText getConfirmedState ()
 
virtual void setConfirmedStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field ConfirmedState. More...
 
virtual
OpcUa::TwoStateVariableType
getAckedStateNode ()
 Returns the AckedState node.
 
virtual
OpcUa::TwoStateVariableType
getConfirmedStateNode ()
 Returns the ConfirmedState node. 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...
 
ReferenceCountergetConditionDataReferenceCounter ()
 Get the ReferenceCounter interface necessary for condition event data classes.
 
virtual UaStatus AddComment (const ServiceContext &serviceContext, UaByteString &EventId, const UaLocalizedText &Comment)
 AddComment is used to apply a comment to a specific state of a Condition instance. More...
 
virtual UaStatus Enable (const ServiceContext &serviceContext)
 
virtual UaStatus Disable (const ServiceContext &serviceContext)
 
void addEnabledStateLocale (const UaLocalizedText &falseName, const UaLocalizedText &trueName)
 Add Enabled state strings for additional locale.
 
virtual UaNodeId getConditionNodeId ()
 Returns the condition NodeId for the condition object. More...
 
virtual UaNodeId getConditionBranchNodeId ()
 Returns the condition branch NodeId for the condition object. More...
 
virtual OpcUa_Boolean getConditionRetain ()
 Returns the Retain flag for the condition object. More...
 
OpcUa_UInt32 getBranchCount ()
 Returns the number of active branches. More...
 
ConditionTypeDatagetBranch (const UaNodeId &branchNodeId)
 Returns a pointer to the branch event data based on the passed branch NodeId. More...
 
ConditionTypeDatagetBranchByEventId (const UaByteString &eventId, UaByteString &userEventId)
 Returns a pointer to the branch event data based on the passed EventId. More...
 
void getAllBranches (UaPointerArray< ConditionTypeData > &branchArray)
 Returns an array of the available branches. More...
 
OpcUa_StatusCode deleteBranch (const UaNodeId &branchNodeId)
 Deletes the branch identified by the branch NodeId. More...
 
UaStatus triggerBranchEvent (ConditionTypeData *pConditionTypeData, const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
 Send event with event field data of the passed condition branch to the subscribed clients After setting the changed states of the condition branch this method is used to trigger the event notification that contains the snapshot of the new state of the condition branch. 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 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 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 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 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 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 setEnabledState (OpcUa_Boolean enabledState)
 
virtual UaLocalizedText getEnabledState ()
 
virtual void setEnabledStateStatus (OpcUa_StatusCode status)
 Set a status code for the event field EnabledState. 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 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 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 OpcUa::PropertyTypegetBranchIdNode ()
 Returns the BranchId node.
 
virtual OpcUa::PropertyTypegetClientUserIdNode ()
 Returns the ClientUserId node.
 
virtual
OpcUa::ConditionVariableType
getCommentNode ()
 Returns the Comment node.
 
virtual OpcUa::PropertyTypegetConditionClassIdNode ()
 Returns the ConditionClassId node.
 
virtual OpcUa::PropertyTypegetConditionClassNameNode ()
 Returns the ConditionClassName node.
 
virtual OpcUa::PropertyTypegetConditionNameNode ()
 Returns the ConditionName node.
 
virtual
OpcUa::TwoStateVariableType
getEnabledStateNode ()
 Returns the EnabledState node.
 
virtual
OpcUa::ConditionVariableType
getLastSeverityNode ()
 Returns the LastSeverity node.
 
virtual
OpcUa::ConditionVariableType
getQualityNode ()
 Returns the Quality node.
 
virtual OpcUa::PropertyTypegetRetainNode ()
 Returns the Retain node.
 
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...
 
- Public Member Functions inherited from OpcUa::BaseEventType
 BaseEventType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseEventType. More...
 
 BaseEventType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, const UaNodeId &sourceNode, const UaString &sourceName, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseEventType. More...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the ConditionType.
 
virtual void setSourceNode (const UaNodeId &sourceNode)
 Set the value of the SourceNode field. More...
 
virtual UaNodeId getSourceNode () const
 Get the value of the SourceNode field. More...
 
virtual void setSourceName (const UaString &sourceName)
 Set the value of the SourceName field. More...
 
virtual UaString getSourceName () const
 Get the value of the SourceName field. More...
 
virtual void setMessage (const UaLocalizedText &message)
 Set the value of the Message field. More...
 
virtual void setMessageStatus (OpcUa_StatusCode status)
 Set a status code for the Message event field value. More...
 
virtual UaLocalizedText getMessage () const
 Get the value of the Message field. More...
 
virtual void setSeverity (OpcUa_UInt16 severity)
 Set the value of the Severity field. More...
 
virtual void setSeverityStatus (OpcUa_StatusCode status)
 Set a status code for the Severity event field value. More...
 
virtual OpcUa_UInt16 getSeverity () const
 Get the value of the Severity field. More...
 
virtual void setTimeStatus (OpcUa_StatusCode status)
 Set a status code for the Time event field value. More...
 
virtual void setLocalTime (const UaTimeZoneDataType &localTime)
 Set value for optional event property LocalTime. More...
 
virtual UaTimeZoneDataType getLocalTime () const
 Get the LocalTime event field value. More...
 
virtual OpcUa::PropertyTypegetEventIdNode ()
 Returns the EventId node.
 
virtual OpcUa::PropertyTypegetEventTypeNode ()
 Returns the EventType node.
 
virtual OpcUa::PropertyTypegetSourceNodeNode ()
 Returns the SourceNode node.
 
virtual OpcUa::PropertyTypegetSourceNameNode ()
 Returns the SourceName node.
 
virtual OpcUa::PropertyTypegetTimeNode ()
 Returns the Time node.
 
virtual OpcUa::PropertyTypegetReceiveTimeNode ()
 Returns the ReceiveTime node.
 
virtual OpcUa::PropertyTypegetLocalTimeNode ()
 Returns the LocalTime node. More...
 
virtual OpcUa::PropertyTypegetMessageNode ()
 Returns the Message node.
 
virtual OpcUa::PropertyTypegetSeverityNode ()
 Returns the Severity node.
 
virtual UaStatus triggerEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &eventId)
 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.
 
void lock ()
 Lock the access to the object.
 
void unlock ()
 Unlock the access to the object.
 
- Public Member Functions inherited from OpcUa::BaseObjectType
 BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
 BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
UaReferenceListsgetUaReferenceLists () const
 Get the UaReferenceLists interface for the node. More...
 
virtual UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *pSession) const
 Get the displayName as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isDescriptionSupported () const
 Check if Node is DescriptionSupported. More...
 
virtual UaLocalizedText description (Session *pSession) const
 Get the description as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isWriteMaskSupported () const
 Check if Node is WriteMaskSupported. More...
 
virtual OpcUa_UInt32 writeMask () const
 Get the writeMask of the current Node. More...
 
virtual OpcUa_Boolean isUserWriteMaskSupported () const
 Check if Node is UserWriteMaskSupported. More...
 
virtual OpcUa_UInt32 userWriteMask (Session *pSession) const
 Check if Node has a userWriteMask. More...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
virtual OpcUa_Byte eventNotifier () const
 Returns the EventNotifier for the BaseObjectType. More...
 
virtual MethodManagergetMethodManager (UaMethod *pMethod) const
 Returns the method manager interface for the BaseObjectType instance. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Method to set user data stored in this class. More...
 
virtual UserDataBasegetUserData () const
 Method to get the user data stored in this class. More...
 
virtual void setBrowseName (const UaQualifiedName &browseName)
 Sets the browse name attribute value. More...
 
virtual void setDisplayName (const UaLocalizedText &displayName)
 Sets the display name attribute value. More...
 
virtual void setDescription (const UaLocalizedText &description)
 Sets the description attribute value. More...
 
virtual void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the write mask attribute value. More...
 
virtual void setEventNotifier (OpcUa_Byte eventNotifier)
 Sets the eventNotifier attribute value. More...
 
virtual void setModellingRuleId (const UaNodeId &modellingRuleId)
 Set NodeId of the modeling rule for this node. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
void setMethodManager (MethodManager *pMethodManager)
 Allows a class aggregating the object to implement the MethodManager for this object. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from MethodManager
 MethodManager ()
 construction
 
virtual ~MethodManager ()
 destruction
 
- Public Member Functions inherited from UaObject
 UaObject ()
 Construction of the UaObject. More...
 
OpcUa_NodeClass nodeClass () const
 Get the node class of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode ()
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (const UaNodeId &key, ChainEntry **ppPrevious)
 finds the right entry in the chain. More...
 
void add (ChainEntry *pNewEntry)
 adds a new entry to the list. More...
 
void prepend (ChainEntry *pNewEntry)
 prepends a new entry to the list. More...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. More...
 
virtual void setInvalid ()
 Set the entry to invalid. More...
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 
- Public Member Functions inherited from UaReferenceLists
 UaReferenceLists ()
 Constructs the reference lists object.
 
virtual ~UaReferenceLists ()
 Destroys the reference lists object.
 
virtual UaStatus browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaStatus translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
 Find a node based on an element of an relative path. More...
 
virtual const UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (const UaQualifiedName &browseName) const
 Searches a target node with the passed browse name and returns the UaNode interface if found. More...
 
virtual void addTargetNode (UaReference *pReference)
 Add a reference to a target node where this node is the source node. More...
 
virtual void addSourceNode (UaReference *pReference)
 Adds a reference to a source node where this node is the target node. More...
 
virtual UaStatus removeSourceNode (UaReference *pReferenceToRemove)
 Remove a reference to a source node where this node is the target node. More...
 
virtual bool removeSourceReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a source node. More...
 
virtual UaStatus removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual UaStatus removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual bool removeTargetReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a target node. More...
 
virtual UaStatus removeCrossNodeManagerRef (NodeManager *pNodeManager)
 Remove references to another NodeManager. More...
 
virtual UaStatus invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
 Set all references from SourceNodes to this Node invalid. More...
 
virtual UaStatus invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
 Set all references to TargetNode of this node invalid. More...
 
virtual UaStatus deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
 Deletes all child nodes. More...
 
- Public Member Functions inherited from BaseEventTypeData
 BaseEventTypeData ()
 Constructs a BaseEventTypeData object.
 
virtual ~BaseEventTypeData ()
 Destroys the BaseEventTypeData object.
 
virtual void prepareNewEvent (const UaDateTime &time, const UaDateTime &receiveTime, const UaByteString &userEventId)
 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. More...
 
virtual void setSource (const UaNode *pNode)
 Set the SourceNode and SoruceName by passing in a node pointer for the source node.
 
virtual void setSourceNode (const UaNodeId &sourceNode)
 Set the SourceNode event field. More...
 
virtual UaNodeId getSourceNode () const
 Get the SourceNode event field. More...
 
virtual void setSourceName (const UaString &sourceName)
 Set the SourceName event field. More...
 
virtual UaString getSourceName () const
 Get the SourceName event field. More...
 
virtual void setTime (const UaDateTime &time)
 Set the Time event field. More...
 
virtual UaDateTime getTime () const
 Get the Time event field. More...
 
virtual void setReceiveTime (const UaDateTime &receiveTime)
 Set the ReceiveTime event field. More...
 
virtual UaDateTime getReceiveTime () const
 Get the ReceiveTime event field. More...
 
virtual void setMessage (const UaLocalizedText &message)
 Set the Message event field. More...
 
virtual UaLocalizedText getMessage () const
 Get the Message event field. More...
 
virtual void getMessageValue (Session *pSession, UaVariant &data)
 Get the message field value. More...
 
virtual void setSeverity (OpcUa_UInt16 severity)
 Set the Severity event field. More...
 
virtual OpcUa_UInt16 getSeverity () const
 Get the Severity event field. More...
 
virtual void setLocalTime (const UaTimeZoneDataType &localTime)
 Set the LocalTime event field. More...
 
virtual UaTimeZoneDataType getLocalTime () const
 Get the LocalTime event field. More...
 
- Public Member Functions inherited from UaEventData
 UaEventData ()
 construction
 
virtual ~UaEventData ()
 destruction
 
void setEventUserData (OpcUa_Handle pEventUserData)
 Sets the user specific event data to the EventData object. More...
 
OpcUa_Handle getEventUserData () const
 Returns the user specific event data.
 

Static Public Member Functions

static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::OffNormalAlarmTypeBase
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::DiscreteAlarmType
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::DiscreteAlarmTypeBase
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 createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Internal SDK method used to clear the static members of this class.
 
- Static Public Member Functions inherited from OpcUa::AlarmConditionTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
static void registerEventFields ()
 Registers all event type fields with the EventManagerBase.
 
static OpcUa_UInt32 registerOptionalEventFields (const UaString &fieldName)
 Registers optional event fields with the EventManagerBase.
 
- Static Public Member Functions inherited from OpcUa::AcknowledgeableConditionType
static void 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 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.
 
- Static Public Member Functions inherited from OpcUa::BaseEventType
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::BaseObjectType
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from BaseEventTypeData
static void registerEventFields ()
 Registers all event type fields with the EventManagerBase.
 
- Static Public Member Functions inherited from UaEventData
static void registerEventFields ()
 Registers all event type fields with the EventManagerBase.
 

Protected Member Functions

virtual ~OffNormalAlarmType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::OffNormalAlarmTypeBase
virtual ~OffNormalAlarmTypeBase ()
 Destroys the OffNormalAlarmType object.
 
- Protected Member Functions inherited from OpcUa::DiscreteAlarmType
virtual ~DiscreteAlarmType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::DiscreteAlarmTypeBase
virtual ~DiscreteAlarmTypeBase ()
 Destroys the DiscreteAlarmType 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.
 
- Protected Member Functions inherited from OpcUa::BaseEventType
virtual ~BaseEventType ()
 Destruction.
 
virtual OpcUa_StatusCode sendEvent (UaEventData *pEventData)
 Adds the event field values of this type and fires the event.
 
- Protected Member Functions inherited from OpcUa::BaseObjectType
virtual ~BaseObjectType ()
 Destruction of the BaseObjectType. More...
 
- Protected Member Functions inherited from UaObject
virtual ~UaObject ()
 Destruction of the UaObject. More...
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 

Additional Inherited Members

- Public Attributes inherited from BaseEventTypeData
UaVariant m_EventId
 Field 01 - EventId.
 
UaNodeId m_EventTypeId
 Field 02 - EventType.
 
UaVariant m_SourceNode
 Field 03 - SourceNode.
 
UaVariant m_SourceName
 Field 04 - SourceName.
 
UaVariant m_Time
 Field 05 - Time.
 
UaVariant m_ReceiveTime
 Field 06 - ReceiveTime.
 
UaVariant m_LocalTime
 Field 07 - LocalTime.
 
UaVariant m_Message
 Field 08 - Message.
 
UaVariant m_Severity
 Field 09 - Severity.
 
- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

Class implementing the UaObject interface for the OffNormalAlarmType.

OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.

Constructor & Destructor Documentation

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

Construction of the class OffNormalAlarmType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.
The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]sourceNodeNodeId of the source node used for this condition object. Can be null if the source is not a node in the address space
[in]sourceNameName of the source used for this condition object
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::OffNormalAlarmType::OffNormalAlarmType ( const UaNodeId nodeId,
const UaString name,
OpcUa_UInt16  browseNameNameSpaceIndex,
NodeManagerConfig pNodeConfig,
const UaNodeId sourceNode,
const UaString sourceName,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class OffNormalAlarmType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class. The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

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

Constructs an instance of the class OffNormalAlarmType with all components.

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

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