C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
PubSubBase::PublishedDataSet Class Reference

Management object for PublishedDataSets. More...

#include <publisheddataset.h>

Inherits PubSubBase::PubSubObject.

Public Member Functions

OpcUa_DataSetMetaDataType * pDataSetMetaData () const
 Returns a pointer to the DataSetMetaDataType structure of the PublishedDataSet. More...
 
UaDataSetMetaDataType dataSetMetaData ()
 Returns the DataSetMetaData for the published DataSet.
 
void setDataSetMetaData (const UaDataSetMetaDataType &dataSetMetaData)
 Sets the DataSetMetaData for the published DataSet. More...
 
OpcUa_PublishedDataItemsDataType * pPublishedDataItems () const
 Returns PublishedDataItemsDataType structure if DataSet is based on data items or NULL otherwise. More...
 
UaStatus publishedVariables (UaPublishedVariableDataTypes &publishedVariables)
 Returns published variables if published DataSet is based on Data Items or bad status otherwise. More...
 
void setPublishedVariables (UaPublishedVariableDataTypes &publishedVariables, bool detach=true)
 Sets the published variables for PublishedDataItems. More...
 
OpcUa_PublishedEventsDataType * pPublishedEvents () const
 Returns PublishedEventsDataType structure if DataSet is based on evetns or NULL otherwise. More...
 
- Public Member Functions inherited from PubSubBase::PubSubObject
 PubSubObject (PubSubResources *pPubSubResources, TransportFacet transportFacet, ConfigurationState configurationState)
 Creates an instance of the PubSubObject.
 
UaMutexpConfigMutex () 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

 PublishedDataSet (PubSubResources *pPubSubResources, OpcUa_PublishedDataSetDataType *pConfigData, OpcUa_UInt32 configIndex)
 Creates an instance of the PubSubConnection from central configuration structure tree. More...
 
 PublishedDataSet (PubSubResources *pPubSubResources, OpcUa_PublishedDataSetDataType *pConfigData)
 Creates an instance of the PubSubConnection with new structure. More...
 
virtual ~PublishedDataSet ()
 Destroys the PublishedDataSet 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 PublishedDataSets.

Constructor & Destructor Documentation

PubSubBase::PublishedDataSet::PublishedDataSet ( PubSubResources pPubSubResources,
OpcUa_PublishedDataSetDataType *  pConfigData,
OpcUa_UInt32  configIndex 
)
protected

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

Parameters
[in]pPubSubResourcesObject managing the resources of the PubSub configuration
[in]pConfigDataConfiguration structure for the PublishedDataSet
[in]configIndexIndex of the structure in the list of PublishedDataSets
PubSubBase::PublishedDataSet::PublishedDataSet ( PubSubResources pPubSubResources,
OpcUa_PublishedDataSetDataType *  pConfigData 
)
protected

Creates an instance of the PubSubConnection with new structure.

Parameters
[in]pPubSubResourcesObject managing the resources of the PubSub configuration
[in]pConfigDataConfiguration structure for the PublishedDataSet

Member Function Documentation

OpcUa_DataSetMetaDataType * PubSubBase::PublishedDataSet::pDataSetMetaData ( ) const

Returns a pointer to the DataSetMetaDataType structure of the PublishedDataSet.

The access to the method and the returned structure must be locked by the caller by using pMutex().

OpcUa_PublishedDataItemsDataType * PubSubBase::PublishedDataSet::pPublishedDataItems ( ) const

Returns PublishedDataItemsDataType structure if DataSet is based on data items or NULL otherwise.

The access to the method and the returned structure must be locked by the caller by using pMutex().

OpcUa_PublishedEventsDataType * PubSubBase::PublishedDataSet::pPublishedEvents ( ) const

Returns PublishedEventsDataType structure if DataSet is based on evetns or NULL otherwise.

The access to the method and the returned structure must be locked by the caller by using pMutex().

UaStatus PubSubBase::PublishedDataSet::publishedVariables ( UaPublishedVariableDataTypes publishedVariables)

Returns published variables if published DataSet is based on Data Items or bad status otherwise.

Parameters
[in]publishedVariablespublished variables
void PubSubBase::PublishedDataSet::setDataSetMetaData ( const UaDataSetMetaDataType dataSetMetaData)

Sets the DataSetMetaData for the published DataSet.

Parameters
[in]dataSetMetaDataDataSetMetaData
void PubSubBase::PublishedDataSet::setPublishedVariables ( UaPublishedVariableDataTypes publishedVariables,
bool  detach = true 
)

Sets the published variables for PublishedDataItems.

Parameters
[in]publishedVariablespublished variables
[in]detachFlag indicating if the passed published variables can be detached

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