C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
Generated base class for a DataSetReaderType. More...
#include <opcua_datasetreadertypebase.h>
Inherits OpcUa::BaseObjectType.
Inherited by OpcUa::DataSetReaderType.
Public Member Functions | |
DataSetReaderTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an DataSetReaderType object using an instance declaration node as base. | |
DataSetReaderTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an DataSetReaderType object. | |
DataSetReaderTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class DataSetReaderTypeBase with all components. More... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the DataSetReaderType. | |
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 | CreateDataSetMirror (const ServiceContext &serviceContext, const UaString &ParentNodeName, const UaRolePermissionTypes &RolePermissions, UaNodeId &ParentNodeId)=0 |
virtual UaStatus | CreateTargetVariables (const ServiceContext &serviceContext, const UaConfigurationVersionDataType &ConfigurationVersion, const UaFieldTargetDataTypes &TargetVariablesToAdd, UaStatusCodeArray &AddResults)=0 |
virtual void | setDataSetFieldContentMask (OpcUa_DataSetFieldContentMask DataSetFieldContentMask) |
Sets the DataSetFieldContentMask value. | |
virtual OpcUa_DataSetFieldContentMask | getDataSetFieldContentMask () const |
Returns the value of DataSetFieldContentMask. | |
virtual void | setDataSetMetaData (const UaDataSetMetaDataType &DataSetMetaData) |
Sets the DataSetMetaData value. | |
virtual UaDataSetMetaDataType | getDataSetMetaData () const |
Returns the value of DataSetMetaData. | |
virtual void | setDataSetReaderProperties (const UaKeyValuePairs &DataSetReaderProperties) |
Sets the DataSetReaderProperties. | |
virtual void | getDataSetReaderProperties (UaKeyValuePairs &DataSetReaderProperties) const |
Gets the DataSetReaderProperties. | |
virtual void | setDataSetWriterId (OpcUa_UInt16 DataSetWriterId) |
Sets the DataSetWriterId value. | |
virtual OpcUa_UInt16 | getDataSetWriterId () const |
Returns the value of DataSetWriterId. | |
virtual void | setHeaderLayoutUri (const UaString &HeaderLayoutUri) |
Sets the HeaderLayoutUri value. | |
virtual UaString | getHeaderLayoutUri () const |
Returns the value of HeaderLayoutUri. | |
virtual void | setKeyFrameCount (OpcUa_UInt32 KeyFrameCount) |
Sets the KeyFrameCount value. | |
virtual OpcUa_UInt32 | getKeyFrameCount () const |
Returns the value of KeyFrameCount. | |
virtual void | setMessageReceiveTimeout (OpcUa_Double MessageReceiveTimeout) |
Sets the MessageReceiveTimeout value. | |
virtual OpcUa_Double | getMessageReceiveTimeout () const |
Returns the value of MessageReceiveTimeout. | |
virtual void | setPublisherId (const UaVariant &PublisherId) |
Sets the PublisherId value. | |
virtual UaVariant | getPublisherId () const |
Returns the value of PublisherId. | |
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. More... | |
virtual OpcUa_MessageSecurityMode | getSecurityMode () const |
Returns the value of SecurityMode. More... | |
virtual void | setWriterGroupId (OpcUa_UInt16 WriterGroupId) |
Sets the WriterGroupId value. | |
virtual OpcUa_UInt16 | getWriterGroupId () const |
Returns the value of WriterGroupId. | |
virtual OpcUa::PropertyType * | getDataSetFieldContentMaskNode () |
Returns the DataSetFieldContentMask node. | |
virtual const OpcUa::PropertyType * | getDataSetFieldContentMaskNode () const |
Returns the DataSetFieldContentMask node. | |
virtual OpcUa::PropertyType * | getDataSetMetaDataNode () |
Returns the DataSetMetaData node. | |
virtual const OpcUa::PropertyType * | getDataSetMetaDataNode () const |
Returns the DataSetMetaData node. | |
virtual OpcUa::PropertyType * | getDataSetReaderPropertiesNode () |
Returns the DataSetReaderProperties node. | |
virtual const OpcUa::PropertyType * | getDataSetReaderPropertiesNode () const |
Returns the DataSetReaderProperties node. | |
virtual OpcUa::PropertyType * | getDataSetWriterIdNode () |
Returns the DataSetWriterId node. | |
virtual const OpcUa::PropertyType * | getDataSetWriterIdNode () const |
Returns the DataSetWriterId node. | |
virtual OpcUa::PubSubDiagnosticsDataSetReaderType * | getDiagnostics () |
Returns the Diagnostics node. More... | |
virtual const OpcUa::PubSubDiagnosticsDataSetReaderType * | getDiagnostics () const |
Returns the Diagnostics node. More... | |
virtual OpcUa::PropertyType * | getHeaderLayoutUriNode () |
Returns the HeaderLayoutUri node. | |
virtual const OpcUa::PropertyType * | getHeaderLayoutUriNode () const |
Returns the HeaderLayoutUri node. | |
virtual OpcUa::PropertyType * | getKeyFrameCountNode () |
Returns the KeyFrameCount node. | |
virtual const OpcUa::PropertyType * | getKeyFrameCountNode () const |
Returns the KeyFrameCount node. | |
virtual OpcUa::PropertyType * | getMessageReceiveTimeoutNode () |
Returns the MessageReceiveTimeout node. | |
virtual const OpcUa::PropertyType * | getMessageReceiveTimeoutNode () const |
Returns the MessageReceiveTimeout node. | |
virtual OpcUa::DataSetReaderMessageType * | getMessageSettings () |
Returns the MessageSettings node. More... | |
virtual const OpcUa::DataSetReaderMessageType * | getMessageSettings () const |
Returns the MessageSettings node. More... | |
virtual OpcUa::PropertyType * | getPublisherIdNode () |
Returns the PublisherId node. | |
virtual const OpcUa::PropertyType * | getPublisherIdNode () const |
Returns the PublisherId 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. More... | |
virtual const OpcUa::PropertyType * | getSecurityModeNode () const |
Returns the SecurityMode node. More... | |
virtual OpcUa::PubSubStatusType * | getStatus () |
Returns the Status node. | |
virtual const OpcUa::PubSubStatusType * | getStatus () const |
Returns the Status node. | |
virtual OpcUa::SubscribedDataSetType * | getSubscribedDataSet () |
Returns the SubscribedDataSet node. | |
virtual const OpcUa::SubscribedDataSetType * | getSubscribedDataSet () const |
Returns the SubscribedDataSet node. | |
virtual OpcUa::DataSetReaderTransportType * | getTransportSettings () |
Returns the TransportSettings node. More... | |
virtual const OpcUa::DataSetReaderTransportType * | getTransportSettings () const |
Returns the TransportSettings node. More... | |
virtual OpcUa::PropertyType * | getWriterGroupIdNode () |
Returns the WriterGroupId node. | |
virtual const OpcUa::PropertyType * | getWriterGroupIdNode () const |
Returns the WriterGroupId node. | |
virtual OpcUa::BaseMethod * | getCreateDataSetMirror () |
Returns the CreateDataSetMirror node. More... | |
virtual const OpcUa::BaseMethod * | getCreateDataSetMirror () const |
Returns the CreateDataSetMirror node. More... | |
virtual OpcUa::BaseMethod * | getCreateTargetVariables () |
Returns the CreateTargetVariables node. More... | |
virtual const OpcUa::BaseMethod * | getCreateTargetVariables () const |
Returns the CreateTargetVariables node. 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::BaseObjectType | |
static void | clearStaticMembers () |
Clear the static members of the class. | |
Protected Member Functions | |
virtual | ~DataSetReaderTypeBase () |
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... | |
UaStatus | readAdditionalAttributes (const ServiceContext &serviceContext, OpcUa_Boolean bReturnBrowseName, OpcUa_Boolean bReturnDisplayName, const UaBooleanArray &arrIndexAttributes, const UaBooleanArray &arrIndexTypeDefinition, UaReferenceDescriptions &references) |
Read attributes DisplayName, BrowseName and get the TypeDefinition references. More... | |
Additional Inherited Members | |
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 DataSetReaderType.
This class contains the generated base code for the object type DataSetReaderType 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 DataSetReaderType:
Browse Name | TypeDefinition | Modelling Rule | See Also |
---|---|---|---|
Diagnostics | PubSubDiagnosticsDataSetReaderType | Optional | getDiagnostics |
MessageSettings | DataSetReaderMessageType | Optional | getMessageSettings |
Status | PubSubStatusType | Mandatory | getStatus |
SubscribedDataSet | SubscribedDataSetType | Mandatory | getSubscribedDataSet |
TransportSettings | DataSetReaderTransportType | Optional | getTransportSettings |
Variable members of the DataSetReaderType:
https://reference.opcfoundation.org/v104/Core/docs/Part14/9.1.8/#9.1.8.2
See also Doc_OpcUa_DataSetReaderType for a documentation of the complete Information Model.
OpcUa::DataSetReaderTypeBase::DataSetReaderTypeBase | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class DataSetReaderTypeBase with all components.
[in] | pBaseNode | The "tree" of nodes that specifies the attributes of the instance and its children |
[in] | pFactory | The factory to create the children |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided |
|
virtual |
Call method of an UA object.
Implementation of the MethodManager interface method beginCall.
Reimplemented from OpcUa::BaseObjectType.
|
pure virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implemented in OpcUa::DataSetReaderType.
|
pure virtual |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
Implemented in OpcUa::DataSetReaderType.
|
virtual |
Returns the CreateDataSetMirror node.
If the CreateDataSetMirror node has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the CreateDataSetMirror node.
If the CreateDataSetMirror node has not been created yet, this method returns NULL.
|
virtual |
Returns the CreateTargetVariables node.
If the CreateTargetVariables node has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the CreateTargetVariables node.
If the CreateTargetVariables 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 value of SecurityGroupId.
If the optional SecurityGroupId node has not been created, the value of the InstanceDeclaration node of the ObjectType is returned.
|
virtual |
Returns the SecurityGroupId node.
If the Variable has not been created yet, this method returns NULL.
|
virtual |
Returns the SecurityGroupId node.
If the Variable has not been created yet, this method returns NULL.
|
virtual |
Returns the SecurityKeyServices node.
If the Variable has not been created yet, this method returns NULL.
|
virtual |
Returns the SecurityKeyServices node.
If the Variable has not been created yet, this method returns NULL.
|
virtual |
Returns the value of SecurityMode.
If the optional SecurityMode node has not been created, the value of the InstanceDeclaration node of the ObjectType is returned.
|
virtual |
Returns the SecurityMode node.
If the Variable has not been created yet, this method returns NULL.
|
virtual |
Returns the SecurityMode node.
If the Variable 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.
|
virtual |
Sets the SecurityGroupId value.
If the optional SecurityGroupId node has not been created, this method adds it to the address space.
|
virtual |
Sets the SecurityMode value.
If the optional SecurityMode node has not been created, this method adds it to the address space.