Generated base class for a PubSubConnectionType. More...

#include <opcua_pubsubconnectiontypebase.h>

Inherited by OpcUa::PubSubConnectionType.

Public Member Functions
	PubSubConnectionTypeBase (const UaNodeId &nodeId, UaObject pInstanceDeclarationObject, NodeManagerConfig pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
	Constructs an PubSubConnectionType object using an instance declaration node as base.

	PubSubConnectionTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an PubSubConnectionType object.

	PubSubConnectionTypeBase (UaBase::Object pBaseNode, XmlUaNodeFactoryManager pFactory, NodeManagerConfig pNodeConfig, UaMutexRefCounted pSharedMutex=NULL)
	Constructs an instance of the class PubSubConnectionTypeBase with all components. More...

virtual UaNodeId	typeDefinitionId () const
	Returns the type definition NodeId for the PubSubConnectionType.

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	AddReaderGroup (const ServiceContext &serviceContext, const UaReaderGroupDataType &Configuration, UaNodeId &GroupId)=0

virtual UaStatus	AddWriterGroup (const ServiceContext &serviceContext, const UaWriterGroupDataType &Configuration, UaNodeId &GroupId)=0

virtual UaStatus	RemoveGroup (const ServiceContext &serviceContext, const UaNodeId &GroupId)=0

virtual void	setConnectionProperties (const UaKeyValuePairs &ConnectionProperties)
	Sets the ConnectionProperties.

virtual void	getConnectionProperties (UaKeyValuePairs &ConnectionProperties) const
	Gets the ConnectionProperties.

virtual void	setPublisherId (const UaVariant &PublisherId)
	Sets the PublisherId value.

virtual UaVariant	getPublisherId () const
	Returns the value of PublisherId.

virtual void	setTransportProfileUri (const UaString &TransportProfileUri)
	Sets the TransportProfileUri value.

virtual UaString	getTransportProfileUri () const
	Returns the value of TransportProfileUri.

virtual OpcUa::NetworkAddressType *	getAddress ()
	Returns the Address node.

virtual const OpcUa::NetworkAddressType *	getAddress () const
	Returns the Address node.

virtual OpcUa::PropertyType *	getConnectionPropertiesNode ()
	Returns the ConnectionProperties node.

virtual const OpcUa::PropertyType *	getConnectionPropertiesNode () const
	Returns the ConnectionProperties node.

virtual OpcUa::PubSubDiagnosticsConnectionType *	getDiagnostics ()
	Returns the Diagnostics node. More...

virtual const OpcUa::PubSubDiagnosticsConnectionType *	getDiagnostics () const
	Returns the Diagnostics node. More...

virtual OpcUa::PropertyType *	getPublisherIdNode ()
	Returns the PublisherId node.

virtual const OpcUa::PropertyType *	getPublisherIdNode () const
	Returns the PublisherId node.

virtual OpcUa::PubSubStatusType *	getStatus ()
	Returns the Status node.

virtual const OpcUa::PubSubStatusType *	getStatus () const
	Returns the Status node.

virtual OpcUa::SelectionListType *	getTransportProfileUriNode ()
	Returns the TransportProfileUri node.

virtual const OpcUa::SelectionListType *	getTransportProfileUriNode () const
	Returns the TransportProfileUri node.

virtual OpcUa::ConnectionTransportType *	getTransportSettings ()
	Returns the TransportSettings node. More...

virtual const OpcUa::ConnectionTransportType *	getTransportSettings () const
	Returns the TransportSettings node. More...

virtual OpcUa::BaseMethod *	getAddReaderGroup ()
	Returns the AddReaderGroup node. More...

virtual const OpcUa::BaseMethod *	getAddReaderGroup () const
	Returns the AddReaderGroup node. More...

virtual OpcUa::BaseMethod *	getAddWriterGroup ()
	Returns the AddWriterGroup node. More...

virtual const OpcUa::BaseMethod *	getAddWriterGroup () const
	Returns the AddWriterGroup node. More...

virtual OpcUa::BaseMethod *	getRemoveGroup ()
	Returns the RemoveGroup node. More...

virtual const OpcUa::BaseMethod *	getRemoveGroup () const
	Returns the RemoveGroup node. More...

virtual UaStatus	addReaderGroupName_Placeholder (OpcUa::ReaderGroupType *pReaderGroupName_Placeholder)
	Adds the passed ReaderGroupType node by creating an HasComponent reference.

virtual UaStatus	addWriterGroupName_Placeholder (OpcUa::WriterGroupType *pWriterGroupName_Placeholder)
	Adds the passed WriterGroupType node by creating an HasComponent reference.

virtual void	useAccessInfoFromType ()
	Applies the NodeAccessInfo set at the PubSubConnectionTypeBase and its children. More...

void	useAccessInfoFromInstance (PubSubConnectionTypeBase *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 ()
	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 ()
	Construction of the UaNode. More...

virtual UaNodeId	getKey () const
	Get the key of the node used for the hash table. More...

virtual const NodeAccessInfo *	getAccessInfo () const
	Returns the access info for this node. 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	~PubSubConnectionTypeBase ()
	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)
	Collect a list of all child nodes. 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...

Detailed Description

Generated base class for a PubSubConnectionType.

This class contains the generated base code for the object type PubSubConnectionType 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 PubSubConnectionType:

Browse Name	TypeDefinition	Modelling Rule	See Also
<ReaderGroupName>	ReaderGroupType	OptionalPlaceholder
<WriterGroupName>	WriterGroupType	OptionalPlaceholder
Address	NetworkAddressType	Mandatory	getAddress
Diagnostics	PubSubDiagnosticsConnectionType	Optional	getDiagnostics
Status	PubSubStatusType	Mandatory	getStatus
TransportSettings	ConnectionTransportType	Optional	getTransportSettings

Variable members of the PubSubConnectionType:

Browse Name	DataType	TypeDefinition	Modelling Rule	See Also
ConnectionProperties	KeyValuePair	PropertyType	Mandatory	getConnectionProperties, setConnectionProperties
PublisherId	BaseDataType	PropertyType	Mandatory	getPublisherId, setPublisherId
TransportProfileUri	String	SelectionListType	Mandatory	getTransportProfileUri, setTransportProfileUri

Constructor & Destructor Documentation

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

Constructs an instance of the class PubSubConnectionTypeBase with all components.

Parameters

[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

Member Function Documentation

virtual UaStatus OpcUa::PubSubConnectionTypeBase::AddReaderGroup	(	const ServiceContext &	serviceContext,
		const UaReaderGroupDataType &	Configuration,
		UaNodeId &	GroupId
	)

pure virtual

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::PubSubConnectionType.

virtual UaStatus OpcUa::PubSubConnectionTypeBase::AddWriterGroup	(	const ServiceContext &	serviceContext,
		const UaWriterGroupDataType &	Configuration,
		UaNodeId &	GroupId
	)

pure virtual

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::PubSubConnectionType.

UaStatus OpcUa::PubSubConnectionTypeBase::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.

OpcUa::BaseMethod * OpcUa::PubSubConnectionTypeBase::getAddReaderGroup ( )

virtual

Returns the AddReaderGroup node.

If the AddReaderGroup node has not been created yet, this method creates the node and returns it.

const OpcUa::BaseMethod * OpcUa::PubSubConnectionTypeBase::getAddReaderGroup ( ) const

virtual

Returns the AddReaderGroup node.

If the AddReaderGroup node has not been created yet, this method returns NULL.

OpcUa::BaseMethod * OpcUa::PubSubConnectionTypeBase::getAddWriterGroup ( )

virtual

Returns the AddWriterGroup node.

If the AddWriterGroup node has not been created yet, this method creates the node and returns it.

const OpcUa::BaseMethod * OpcUa::PubSubConnectionTypeBase::getAddWriterGroup ( ) const

virtual

Returns the AddWriterGroup node.

If the AddWriterGroup node has not been created yet, this method returns NULL.

OpcUa::PubSubDiagnosticsConnectionType * OpcUa::PubSubConnectionTypeBase::getDiagnostics ( )

virtual

Returns the Diagnostics node.

If the Object has not been created yet, this method creates the node and returns it.

const OpcUa::PubSubDiagnosticsConnectionType * OpcUa::PubSubConnectionTypeBase::getDiagnostics ( ) const

virtual

Returns the Diagnostics node.

If the Object has not been created yet, this method return NULL.

OpcUa::BaseMethod * OpcUa::PubSubConnectionTypeBase::getRemoveGroup ( )

virtual

Returns the RemoveGroup node.

If the RemoveGroup node has not been created yet, this method creates the node and returns it.

const OpcUa::BaseMethod * OpcUa::PubSubConnectionTypeBase::getRemoveGroup ( ) const

virtual

Returns the RemoveGroup node.

If the RemoveGroup node has not been created yet, this method returns NULL.

OpcUa::ConnectionTransportType * OpcUa::PubSubConnectionTypeBase::getTransportSettings ( )

virtual

Returns the TransportSettings node.

If the Object has not been created yet, this method creates the node and returns it.

const OpcUa::ConnectionTransportType * OpcUa::PubSubConnectionTypeBase::getTransportSettings ( ) const

virtual

Returns the TransportSettings node.

If the Object has not been created yet, this method return NULL.

virtual UaStatus OpcUa::PubSubConnectionTypeBase::RemoveGroup	(	const ServiceContext &	serviceContext,
		const UaNodeId &	GroupId
	)

pure virtual

Parameters

serviceContext General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implemented in OpcUa::PubSubConnectionType.

void OpcUa::PubSubConnectionTypeBase::useAccessInfoFromInstance ( PubSubConnectionTypeBase * pOther )

Uses the NodeAccessInfo of pOther and its children.

void OpcUa::PubSubConnectionTypeBase::useAccessInfoFromType ( )

virtual

Applies the NodeAccessInfo set at the PubSubConnectionTypeBase and its children.

Reimplemented from OpcUa::BaseObjectType.

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

D:/work/uasdkcpp/src/uaserver/uaservercpp/pubsubmodule/opcua_pubsubconnectiontypebase.h
D:/work/uasdkcpp/src/uaserver/uaservercpp/pubsubmodule/opcua_pubsubconnectiontypebase.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation