C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa::AlarmMetricsTypeBase Class Referenceabstract

Generated base class for a AlarmMetricsType. More...

#include <opcua_alarmmetricstypebase.h>

Inherits OpcUa::BaseObjectType.

Inherited by OpcUa::AlarmMetricsType.

Public Member Functions

 AlarmMetricsTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an AlarmMetricsType object using an instance declaration node as base.
 
 AlarmMetricsTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an AlarmMetricsType object.
 
 AlarmMetricsTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class AlarmMetricsTypeBase with all components. More...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the AlarmMetricsType.
 
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 UaStatus Reset (const ServiceContext &serviceContext)=0
 
virtual void setAlarmCount (OpcUa_UInt32 AlarmCount)
 Sets the AlarmCount value.
 
virtual OpcUa_UInt32 getAlarmCount () const
 Returns the value of AlarmCount.
 
virtual void setAverageAlarmRate (OpcUa_Double AverageAlarmRate)
 Sets the AverageAlarmRate value.
 
virtual OpcUa_Double getAverageAlarmRate () const
 Returns the value of AverageAlarmRate.
 
virtual void setCurrentAlarmRate (OpcUa_Double CurrentAlarmRate)
 Sets the CurrentAlarmRate value.
 
virtual OpcUa_Double getCurrentAlarmRate () const
 Returns the value of CurrentAlarmRate.
 
virtual void setMaximumActiveState (OpcUa_Double MaximumActiveState)
 Sets the MaximumActiveState value.
 
virtual OpcUa_Double getMaximumActiveState () const
 Returns the value of MaximumActiveState.
 
virtual void setMaximumAlarmRate (OpcUa_Double MaximumAlarmRate)
 Sets the MaximumAlarmRate value.
 
virtual OpcUa_Double getMaximumAlarmRate () const
 Returns the value of MaximumAlarmRate.
 
virtual void setMaximumReAlarmCount (OpcUa_UInt32 MaximumReAlarmCount)
 Sets the MaximumReAlarmCount value.
 
virtual OpcUa_UInt32 getMaximumReAlarmCount () const
 Returns the value of MaximumReAlarmCount.
 
virtual void setMaximumUnAck (OpcUa_Double MaximumUnAck)
 Sets the MaximumUnAck value.
 
virtual OpcUa_Double getMaximumUnAck () const
 Returns the value of MaximumUnAck.
 
virtual void setStartTime (const UaDateTime &StartTime)
 Sets the StartTime value.
 
virtual UaDateTime getStartTime () const
 Returns the value of StartTime.
 
virtual
OpcUa::BaseDataVariableType
getAlarmCountNode ()
 Returns the AlarmCount node.
 
virtual const
OpcUa::BaseDataVariableType
getAlarmCountNode () const
 Returns the AlarmCount node.
 
virtual
OpcUa::AlarmRateVariableType
getAverageAlarmRateNode ()
 Returns the AverageAlarmRate node.
 
virtual const
OpcUa::AlarmRateVariableType
getAverageAlarmRateNode () const
 Returns the AverageAlarmRate node.
 
virtual
OpcUa::AlarmRateVariableType
getCurrentAlarmRateNode ()
 Returns the CurrentAlarmRate node.
 
virtual const
OpcUa::AlarmRateVariableType
getCurrentAlarmRateNode () const
 Returns the CurrentAlarmRate node.
 
virtual
OpcUa::BaseDataVariableType
getMaximumActiveStateNode ()
 Returns the MaximumActiveState node.
 
virtual const
OpcUa::BaseDataVariableType
getMaximumActiveStateNode () const
 Returns the MaximumActiveState node.
 
virtual
OpcUa::AlarmRateVariableType
getMaximumAlarmRateNode ()
 Returns the MaximumAlarmRate node.
 
virtual const
OpcUa::AlarmRateVariableType
getMaximumAlarmRateNode () const
 Returns the MaximumAlarmRate node.
 
virtual
OpcUa::BaseDataVariableType
getMaximumReAlarmCountNode ()
 Returns the MaximumReAlarmCount node.
 
virtual const
OpcUa::BaseDataVariableType
getMaximumReAlarmCountNode () const
 Returns the MaximumReAlarmCount node.
 
virtual
OpcUa::BaseDataVariableType
getMaximumUnAckNode ()
 Returns the MaximumUnAck node.
 
virtual const
OpcUa::BaseDataVariableType
getMaximumUnAckNode () const
 Returns the MaximumUnAck node.
 
virtual
OpcUa::BaseDataVariableType
getStartTimeNode ()
 Returns the StartTime node.
 
virtual const
OpcUa::BaseDataVariableType
getStartTimeNode () const
 Returns the StartTime node.
 
virtual OpcUa::BaseMethodgetReset ()
 Returns the Reset node.
 
virtual const OpcUa::BaseMethodgetReset () const
 Returns the Reset node.
 
virtual void useAccessInfoFromType ()
 Applies the NodeAccessInfo set at the AlarmMetricsTypeBase and its children. More...
 
void useAccessInfoFromInstance (AlarmMetricsTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- 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, NodeAccessInfo *pDefaultPermissions, 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 (UaMutexRefCounted *pSharedMutex=NULL)
 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, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
virtual bool hasAccessInfo () const
 Check if this UaNode has a NodeAccessInfo assigned. More...
 
virtual void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
virtual void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
virtual void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. 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...
 
void clearChain ()
 Clear the chain when the hashtable is cleared.
 
- 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...
 

Static Public Member Functions

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.
 

Protected Member Functions

virtual ~AlarmMetricsTypeBase ()
 Destruction.
 
- 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
 
- Protected Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
 Collect a list of all child nodes. More...
 

Additional Inherited Members

- 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

Generated base class for a AlarmMetricsType.

This class contains the generated base code for the object type AlarmMetricsType representing an OPC UA ObjectType. This class is used to create the object type and to create and represent instances of the object type in the server address space.

Variable members of the AlarmMetricsType:

Browse Name DataType TypeDefinition Modelling Rule See Also
AlarmCount UInt32 BaseDataVariableType Mandatory getAlarmCount, setAlarmCount
AverageAlarmRate Double AlarmRateVariableType Mandatory getAverageAlarmRate, setAverageAlarmRate
CurrentAlarmRate Double AlarmRateVariableType Mandatory getCurrentAlarmRate, setCurrentAlarmRate
MaximumActiveState Duration BaseDataVariableType Mandatory getMaximumActiveState, setMaximumActiveState
MaximumAlarmRate Double AlarmRateVariableType Mandatory getMaximumAlarmRate, setMaximumAlarmRate
MaximumReAlarmCount UInt32 BaseDataVariableType Mandatory getMaximumReAlarmCount, setMaximumReAlarmCount
MaximumUnAck Duration BaseDataVariableType Mandatory getMaximumUnAck, setMaximumUnAck
StartTime UtcTime BaseDataVariableType Mandatory getStartTime, setStartTime

https://reference.opcfoundation.org/v104/Core/docs/Part9/8.2

See also Doc_OpcUa_AlarmMetricsType for a documentation of the complete Information Model.

Constructor & Destructor Documentation

OpcUa::AlarmMetricsTypeBase::AlarmMetricsTypeBase ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Constructs an instance of the class AlarmMetricsTypeBase 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

Member Function Documentation

UaStatus OpcUa::AlarmMetricsTypeBase::beginCall ( MethodManagerCallback pCallback,
const ServiceContext serviceContext,
OpcUa_UInt32  callbackHandle,
MethodHandle pMethodHandle,
const UaVariantArray inputArguments 
)
virtual

Call method of an UA object.

Implementation of the MethodManager interface method beginCall.

Reimplemented from OpcUa::BaseObjectType.

virtual UaStatus OpcUa::AlarmMetricsTypeBase::Reset ( const ServiceContext serviceContext)
pure virtual
Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::AlarmMetricsType.

void OpcUa::AlarmMetricsTypeBase::useAccessInfoFromInstance ( AlarmMetricsTypeBase pOther)

Uses the NodeAccessInfo of pOther and its children.

void OpcUa::AlarmMetricsTypeBase::useAccessInfoFromType ( )
virtual

Applies the NodeAccessInfo set at the AlarmMetricsTypeBase and its children.

Reimplemented from OpcUa::BaseObjectType.


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