Management object for PubSubConnections. More...

#include <datasetreader.h>

Public Member Functions
UaStatus	startUp ()
	Start up the DataSetReader object.

UaStatus	shutDown ()
	Shut down the DataSetReader object.

OpcUa_MessageSecurityMode	securityMode () const
	Returns the security mode setting for the DataSetReader.

void	setSecurityMode (OpcUa_MessageSecurityMode securityMode)
	Set the security mode for the DataSetReader. More...

UaStatus	transportSettingsBroker (UaBrokerDataSetReaderTransportDataType &brokerTransportSettings) const
	Returns the broker transport settings structure if a broker transport is configured. More...

UaStatus	setTransportSettingsBroker (const UaBrokerDataSetReaderTransportDataType &brokerTransportSettings)
	Sets the broker transport settings structure if a broker transport is configured. More...

UaStatus	messageSettingsUadp (UaUadpDataSetReaderMessageDataType &uadpMessageSettings) const
	Returns the UADP message settings structure if a UADP message mapping is configured. More...

UaStatus	setMessageSettingsUadp (const UaUadpDataSetReaderMessageDataType &uadpMessageSettings)
	Sets the UADP message settings structure if a UADP message mapping is configured. More...

UaStatus	messageSettingsJson (UaJsonDataSetReaderMessageDataType &jsonMessageSettings) const
	Returns the JSON message settings structure if a JSON message mapping is configured. More...

UaStatus	setMessageSettingsJson (const UaJsonDataSetReaderMessageDataType &jsonMessageSettings)
	Sets the JSON message settings structure if a JSON message mapping is configured. More...

OpcUa_TargetVariablesDataType *	pTargetVariables ()
	Returns TargetVariablesDataType structure if subscribed DataSet is based on target variables or NULL otherwise.

UaStatus	targetVariables (UaFieldTargetDataTypes &targetVariables)
	Returns target variables if subscribed DataSet is based on target variables or bad status otherwise.

void	setTargetVariables (UaFieldTargetDataTypes &targetVariables, bool detach=true)
	Sets the subscribed DataSet to target variables. More...

OpcUa_SubscribedDataSetMirrorDataType *	pSubscribedDataSetMirror ()
	Returns SubscribedDataSetMirrorDataType structure if subscribed DataSet is based on mirror configuration or NULL otherwise.

void	setMirror (const UaString &parentNodeName)
	Sets the subscribed DataSet to mirror. More...

void	setDataSetReaderCallback (DataSetReaderCallback *pDataSetReaderCallback)
	Set the callback for application specific message decoding.

OpcUa_UInt32	getQueueSize () const
	Returns number of ReaderQueueItems.

ReaderQueueItem *	getQueueItem (OpcUa_UInt32 index)
	Returns ReaderQueueItem for index or NULL if index is invalid. More...

Public Member Functions inherited from PubSubBase::PubSubObject
	PubSubObject (PubSubResources *pPubSubResources, TransportFacet transportFacet, ConfigurationState configurationState)
	Creates an instance of the PubSubObject.

UaMutex *	pConfigMutex () const
	Get the shared mutex for the complete configuration.

void	incrementErrorCounter ()
	Increments the error counter for the PubSub object.

void	decrementErrorCounter ()
	Decrements the error counter for the PubSub object.

Public Member Functions inherited from ReferenceCounter
	ReferenceCounter ()
	construction

virtual	~ReferenceCounter ()
	destruction

Protected Member Functions
	DataSetReader (ReaderGroup pParent, OpcUa_DataSetReaderDataType pConfigData, OpcUa_UInt32 configIndex, OpcUa_Int32 stackHandle)
	Creates an instance of the DataSetReader from central configuration structure tree. More...

	DataSetReader (ReaderGroup pParent, OpcUa_DataSetReaderDataType pConfigData)
	Creates an instance of the DataSetReader with new structure. More...

virtual	~DataSetReader ()
	Destroys the DataSetReader object.

Protected Member Functions inherited from PubSubBase::PubSubObject
virtual	~PubSubObject ()
	Destroys the PubSubObject object.

Additional Inherited Members
Public Types inherited from PubSubBase::PubSubObject
enum	PubSubObjectType
	PubSub transport facet reflecting the defined TransportProfileUris.

enum	TransportFacet { TransportFacet_None = 0x0, TransportFacet_PubSub_UDP_UADP = 0x11, TransportFacet_PubSub_ETH_UADP = 0x21, TransportFacet_PubSub_AMQP_UADP = 0x31, TransportFacet_PubSub_MQTT_UADP = 0x41, TransportFacet_PubSub_CUSTOM = 0xFF }
	PubSub transport facet reflecting the defined TransportProfileUris. More...

enum	ConfigurationState { ConfigurationState_None, ConfigurationState_Deleted, ConfigurationState_InSyncWithStruct, ConfigurationState_New, ConfigurationState_Modified }
	PubSub configuration object state. More...

enum	PubSubHeaderLayout { PubSubHeaderLayout_Custom, PubSubHeaderLayout_UADP_PeriodicFixed, PubSubHeaderLayout_UADP_Dynamic }
	PubSub header configuration. More...

Detailed Description

Management object for PubSubConnections.

Constructor & Destructor Documentation

PubSubBase::DataSetReader::DataSetReader	(	ReaderGroup *	pParent,
		OpcUa_DataSetReaderDataType *	pConfigData,
		OpcUa_UInt32	configIndex,
		OpcUa_Int32	stackHandle
	)

protected

Creates an instance of the DataSetReader from central configuration structure tree.

Parameters

[in]	pParent	Parent group
[in]	pConfigData	Configuration structure for the DataSetReader
[in]	configIndex	Index of the structure in the list of DataSet readers in a group
[in]	stackHandle	Handle of the WriterGroup in the stack. PUBSUB_INVALID_STACKHANDLE if no corresponding stack object exists.

PubSubBase::DataSetReader::DataSetReader	(	ReaderGroup *	pParent,
		OpcUa_DataSetReaderDataType *	pConfigData
	)

protected

Creates an instance of the DataSetReader with new structure.

Parameters

[in]	pParent	Parent group
[in]	pConfigData	Configuration structure for the DataSetReader

Member Function Documentation

ReaderQueueItem * PubSubBase::DataSetReader::getQueueItem ( OpcUa_UInt32 index )

Returns ReaderQueueItem for index or NULL if index is invalid.

Parameters

[in] index Index of the WriterQueueItem

UaStatus PubSubBase::DataSetReader::messageSettingsJson ( UaJsonDataSetReaderMessageDataType & jsonMessageSettings ) const

Returns the JSON message settings structure if a JSON message mapping is configured.

Returns BadInvalidArgument if another message mapping is configured< [out] JSON message settings structure

UaStatus PubSubBase::DataSetReader::messageSettingsUadp ( UaUadpDataSetReaderMessageDataType & uadpMessageSettings ) const

Returns the UADP message settings structure if a UADP message mapping is configured.

Returns BadInvalidArgument if another message mapping is configured< [out] UADP message settings structure

UaStatus PubSubBase::DataSetReader::setMessageSettingsJson ( const UaJsonDataSetReaderMessageDataType & jsonMessageSettings )

Sets the JSON message settings structure if a JSON message mapping is configured.

Returns BadInvalidArgument if another message mapping is configured

UaStatus PubSubBase::DataSetReader::setMessageSettingsUadp ( const UaUadpDataSetReaderMessageDataType & uadpMessageSettings )

Sets the UADP message settings structure if a UADP message mapping is configured.

Returns BadInvalidArgument if another message mapping is configured

void PubSubBase::DataSetReader::setMirror ( const UaString & parentNodeName )

Sets the subscribed DataSet to mirror.

Parameters

[in] parentNodeName Name of the mirror object

void PubSubBase::DataSetReader::setSecurityMode ( OpcUa_MessageSecurityMode securityMode )

Set the security mode for the DataSetReader.

If the security mode is None or Invalid, the SecurityGroupId and the SecurityKeyServices are set to null.

void PubSubBase::DataSetReader::setTargetVariables	(	UaFieldTargetDataTypes &	targetVariables,
		bool	detach = `true`
	)

Sets the subscribed DataSet to target variables.

Parameters

[in]	targetVariables	target variables
[in]	detach	Flag indicating if the passed target variables can be detached

UaStatus PubSubBase::DataSetReader::setTransportSettingsBroker ( const UaBrokerDataSetReaderTransportDataType & brokerTransportSettings )

Sets the broker transport settings structure if a broker transport is configured.

Returns BadInvalidState if another transport mapping is configured

UaStatus PubSubBase::DataSetReader::transportSettingsBroker ( UaBrokerDataSetReaderTransportDataType & brokerTransportSettings ) const

Returns the broker transport settings structure if a broker transport is configured.

Returns BadInvalidState if another transport mapping is configured< [out] Broker transport settings structure

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

C:/work/uasdkcpp/src/uabase/pubsubbasecpp/datasetreader.h
C:/work/uasdkcpp/src/uabase/pubsubbasecpp/datasetreader.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation