C++ Based OPC UA Client/Server/PubSub SDK
1.7.6.537
|
Generated base class for a ReaderGroupType. More...
#include <opcua_readergrouptypebase.h>
Inherits OpcUa::PubSubGroupType.
Inherited by OpcUa::ReaderGroupType.
Public Member Functions | |
ReaderGroupTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an ReaderGroupType object using an instance declaration node as base. | |
ReaderGroupTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an ReaderGroupType object. | |
ReaderGroupTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class ReaderGroupTypeBase with all components. More... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the ReaderGroupType. | |
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 | AddDataSetReader (const ServiceContext &serviceContext, const UaDataSetReaderDataType &Configuration, UaNodeId &DataSetReaderNodeId)=0 |
virtual UaStatus | RemoveDataSetReader (const ServiceContext &serviceContext, const UaNodeId &DataSetReaderNodeId)=0 |
virtual OpcUa::PubSubDiagnosticsReaderGroupType * | getDiagnostics () |
Returns the Diagnostics node. More... | |
virtual const OpcUa::PubSubDiagnosticsReaderGroupType * | getDiagnostics () const |
Returns the Diagnostics node. More... | |
virtual OpcUa::ReaderGroupMessageType * | getMessageSettings () |
Returns the MessageSettings node. More... | |
virtual const OpcUa::ReaderGroupMessageType * | getMessageSettings () const |
Returns the MessageSettings node. More... | |
virtual OpcUa::ReaderGroupTransportType * | getTransportSettings () |
Returns the TransportSettings node. More... | |
virtual const OpcUa::ReaderGroupTransportType * | getTransportSettings () const |
Returns the TransportSettings node. More... | |
virtual OpcUa::BaseMethod * | getAddDataSetReader () |
Returns the AddDataSetReader node. More... | |
virtual const OpcUa::BaseMethod * | getAddDataSetReader () const |
Returns the AddDataSetReader node. More... | |
virtual OpcUa::BaseMethod * | getRemoveDataSetReader () |
Returns the RemoveDataSetReader node. More... | |
virtual const OpcUa::BaseMethod * | getRemoveDataSetReader () const |
Returns the RemoveDataSetReader node. More... | |
virtual UaStatus | addDataSetReaderName_Placeholder (OpcUa::DataSetReaderType *pDataSetReaderName_Placeholder) |
Adds the passed DataSetReaderType node by creating an HasDataSetReader reference. | |
Public Member Functions inherited from OpcUa::PubSubGroupType | |
PubSubGroupType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class PubSubGroupType. More... | |
PubSubGroupType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Construction of the class PubSubGroupType. More... | |
PubSubGroupType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class PubSubGroupType with all components. More... | |
UaStatus | enableObject (const ServiceContext &serviceContext) |
Enable command from a client. | |
UaStatus | disableObject (const ServiceContext &serviceContext) |
Disable command from a client. | |
void | startObject () |
Start command from the parent object. | |
void | stopObject () |
Stop command from the parent object. | |
Public Member Functions inherited from OpcUa::PubSubGroupTypeBase | |
PubSubGroupTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an PubSubGroupType object using an instance declaration node as base. | |
PubSubGroupTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an PubSubGroupType object. | |
PubSubGroupTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class PubSubGroupTypeBase with all components. More... | |
virtual void | setGroupProperties (const UaKeyValuePairs &GroupProperties) |
Sets the GroupProperties. | |
virtual void | getGroupProperties (UaKeyValuePairs &GroupProperties) const |
Gets the GroupProperties. | |
virtual void | setMaxNetworkMessageSize (OpcUa_UInt32 MaxNetworkMessageSize) |
Sets the MaxNetworkMessageSize value. | |
virtual OpcUa_UInt32 | getMaxNetworkMessageSize () const |
Returns the value of MaxNetworkMessageSize. | |
virtual void | setSecurityGroupId (const UaString &SecurityGroupId) |
Sets the SecurityGroupId value. More... | |
virtual UaString | getSecurityGroupId () const |
Returns the value of SecurityGroupId. More... | |
virtual void | setSecurityKeyServices (const UaEndpointDescriptions &SecurityKeyServices) |
Sets the SecurityKeyServices. | |
virtual void | getSecurityKeyServices (UaEndpointDescriptions &SecurityKeyServices) const |
Gets the SecurityKeyServices. | |
virtual void | setSecurityMode (OpcUa_MessageSecurityMode SecurityMode) |
Sets the SecurityMode value. | |
virtual OpcUa_MessageSecurityMode | getSecurityMode () const |
Returns the value of SecurityMode. | |
virtual OpcUa::PropertyType * | getGroupPropertiesNode () |
Returns the GroupProperties node. | |
virtual const OpcUa::PropertyType * | getGroupPropertiesNode () const |
Returns the GroupProperties node. | |
virtual OpcUa::PropertyType * | getMaxNetworkMessageSizeNode () |
Returns the MaxNetworkMessageSize node. | |
virtual const OpcUa::PropertyType * | getMaxNetworkMessageSizeNode () const |
Returns the MaxNetworkMessageSize node. | |
virtual OpcUa::PropertyType * | getSecurityGroupIdNode () |
Returns the SecurityGroupId node. More... | |
virtual const OpcUa::PropertyType * | getSecurityGroupIdNode () const |
Returns the SecurityGroupId node. More... | |
virtual OpcUa::PropertyType * | getSecurityKeyServicesNode () |
Returns the SecurityKeyServices node. More... | |
virtual const OpcUa::PropertyType * | getSecurityKeyServicesNode () const |
Returns the SecurityKeyServices node. More... | |
virtual OpcUa::PropertyType * | getSecurityModeNode () |
Returns the SecurityMode node. | |
virtual const OpcUa::PropertyType * | getSecurityModeNode () const |
Returns the SecurityMode node. | |
virtual OpcUa::PubSubStatusType * | getStatus () |
Returns the Status node. | |
virtual const OpcUa::PubSubStatusType * | getStatus () const |
Returns the Status node. | |
virtual void | useAccessInfoFromType () |
Applies the NodeAccessInfo set at the PubSubGroupTypeBase and its children. More... | |
void | useAccessInfoFromInstance (PubSubGroupTypeBase *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... | |
UaReferenceLists * | getUaReferenceLists () 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... | |
UaNode * | getUaNode () const |
Get the UaNode interface pointer of this node. More... | |
virtual OpcUa_Byte | eventNotifier () const |
Returns the EventNotifier for the BaseObjectType. More... | |
virtual MethodManager * | getMethodManager (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 UserDataBase * | getUserData () 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 NodeAccessInfo * | getAccessInfo () 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 | |
ChainEntry * | find (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... | |
ChainEntry * | remove (const UaNodeId &key, ChainEntry **ppNext) |
removes an entry from the list. More... | |
ChainEntry * | getNext () 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 UaReference * | pTargetNodes () const |
Returns the list of references to target nodes. More... | |
virtual const UaReference * | pSourceNodes () const |
Returns the list of references to source nodes. More... | |
virtual UaNode * | getTargetNodeByBrowseName (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::PubSubGroupType | |
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::PubSubGroupTypeBase | |
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 | ~ReaderGroupTypeBase () |
Destruction. | |
Protected Member Functions inherited from OpcUa::PubSubGroupType | |
virtual | ~PubSubGroupType () |
Destruction. | |
Protected Member Functions inherited from OpcUa::PubSubGroupTypeBase | |
virtual | ~PubSubGroupTypeBase () |
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 | |
Public Types inherited from OpcUa::PubSubStatusCallback | |
enum | PubSubStatusInternal { PubSubStatus_DisabledStopped = 0, PubSubStatus_DisabledStarted, PubSubStatus_Paused, PubSubStatus_Operational, PubSubStatus_Error } |
Enumeration used to define State of a PubSub object. More... | |
Protected Attributes inherited from UaReferenceLists | |
UaReference * | m_pTargetNodes |
List of references to target nodes where this node is the source node. More... | |
UaReference * | m_pLastTargetNode |
Last references in the list of references to the target nodes. More... | |
UaReference * | m_pSourceNodes |
List of references to source nodes where this node is the target node. More... | |
Generated base class for a ReaderGroupType.
This class contains the generated base code for the object type ReaderGroupType 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.
Object members of the ReaderGroupType:
Browse Name | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|
<DataSetReaderName> | DataSetReaderType | OptionalPlaceholder | |
Diagnostics | PubSubDiagnosticsReaderGroupType | Optional | getDiagnostics |
MessageSettings | ReaderGroupMessageType | Optional | getMessageSettings |
TransportSettings | ReaderGroupTransportType | Optional | getTransportSettings |
https://reference.opcfoundation.org/v104/Core/docs/Part14/9.1.6/#9.1.6.9
See also Doc_OpcUa_ReaderGroupType for a documentation of the complete Information Model.
OpcUa::ReaderGroupTypeBase::ReaderGroupTypeBase | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class ReaderGroupTypeBase 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 |
|
pure virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implemented in OpcUa::ReaderGroupType.
|
virtual |
Call method of an UA object.
Implementation of the MethodManager interface method beginCall.
Reimplemented from OpcUa::BaseObjectType.
|
virtual |
Returns the AddDataSetReader node.
If the AddDataSetReader node has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the AddDataSetReader node.
If the AddDataSetReader node has not been created yet, this method returns NULL.
|
virtual |
Returns the Diagnostics node.
If the Object has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the Diagnostics node.
If the Object has not been created yet, this method return NULL.
|
virtual |
Returns the MessageSettings node.
If the Object has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the MessageSettings node.
If the Object has not been created yet, this method return NULL.
|
virtual |
Returns the RemoveDataSetReader node.
If the RemoveDataSetReader node has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the RemoveDataSetReader node.
If the RemoveDataSetReader node has not been created yet, this method returns NULL.
|
virtual |
Returns the TransportSettings node.
If the Object has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the TransportSettings node.
If the Object has not been created yet, this method return NULL.
|
pure virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implemented in OpcUa::ReaderGroupType.