UA Server SDK C++ Bundle
1.4.3.291
|
Generated base class for a OffNormalAlarmType. More...
#include <opcua_offnormalalarmtypebase.h>
Inherits OpcUa::DiscreteAlarmType.
Inherited by OpcUa::OffNormalAlarmType.
Public Member Functions | |
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::PropertyType * | getNormalStateNode () |
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::PropertyType * | getInputNodeNode () |
Returns the InputNode node. | |
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. | |
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... | |
ReferenceCounter * | getConditionDataReferenceCounter () |
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... | |
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... | |
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::PropertyType * | getBranchIdNode () |
Returns the BranchId node. | |
virtual OpcUa::PropertyType * | getClientUserIdNode () |
Returns the ClientUserId node. | |
virtual OpcUa::ConditionVariableType * | getCommentNode () |
Returns the Comment node. | |
virtual OpcUa::PropertyType * | getConditionClassIdNode () |
Returns the ConditionClassId node. | |
virtual OpcUa::PropertyType * | getConditionClassNameNode () |
Returns the ConditionClassName node. | |
virtual OpcUa::PropertyType * | getConditionNameNode () |
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::PropertyType * | getRetainNode () |
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... | |
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::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. | |
Protected Member Functions | |
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. | |
Generated base class for a OffNormalAlarmType.
This class contains the auto generated code for the object type OffNormalAlarmType 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.
The OffNormalAlarmType is a specialization of the DiscreteAlarmType intended to represent a discrete Condition that is considered to be not normal. This sub type is usually used to indicate that a discrete value is in an Alarm state, it is active as long as a non-normal value is present.
The NormalState Property is a Property that points to a Variable which has a value that corresponds to one of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode Property. When the value of the Variable referenced by the InputNode Property is not equal to the value of the NormalState Property the Alarm is Active. If this Variable is not in the AddressSpace, a Null NodeId shall be provided.
OpcUa::OffNormalAlarmTypeBase::OffNormalAlarmTypeBase | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class OffNormalAlarmTypeBase with all components.
[in] | pBaseNode | The "tree" of nodes that specifies the attributes of the instance and its children |
[in] | pFactory | The factory to create the children |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided |
UaNodeId OpcUa::OffNormalAlarmTypeBase::createBranch | ( | ) |
Creates a new branch from the current state and adds the branch to a list managed by the condition object.
ConditionType::getBranch() and ConditionType::deleteBranch() can be used to access or to delete the branch.
|
virtual |
Get the field value for the passed index.
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
Reimplemented from OpcUa::DiscreteAlarmTypeBase.
Reimplemented in OpcUa::SystemOffNormalAlarmType, and OpcUa::TripAlarmType.
|
virtual |
Returns the value of NormalState.
The NormalState Property is a Property that points to a Variable which has a value that corresponds to one of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode Property. When the value of the Variable referenced by the InputNode Property is not equal to the value of the NormalState Property the Alarm is Active. If this Variable is not in the AddressSpace, a Null NodeId shall be provided.
|
virtual |
Get the field value for the passed index for optional fields of the OffNormalAlarmType.
This function must be overwritten by derived classes to provide the optional fields registred with OffNormalAlarmTypeData::registerOptionalEventFields
index | The index of the selected field. |
pSession | The session context for the method call. |
data | The data for the selected field. |
|
virtual |
Sets the NormalState value.
The NormalState Property is a Property that points to a Variable which has a value that corresponds to one of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode Property. When the value of the Variable referenced by the InputNode Property is not equal to the value of the NormalState Property the Alarm is Active. If this Variable is not in the AddressSpace, a Null NodeId shall be provided.
|
virtual |
Set a status code for the event field NormalState.
If an event field is not available, a StatusCode must be provided instead of the value to indicate the error situation.
|
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::DiscreteAlarmTypeBase.
Reimplemented in OpcUa::SystemOffNormalAlarmType, and OpcUa::TripAlarmType.