C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
UaBrokerDataSetReaderTransportDataType Class Reference

Wrapper class for the UA stack structure OpcUa_BrokerDataSetReaderTransportDataType. More...

#include <uabrokerdatasetreadertransportdatatype.h>

Public Member Functions

 UaBrokerDataSetReaderTransportDataType ()
 Constructs an instance of the class UaBrokerDataSetReaderTransportDataType with empty default values.
 
 UaBrokerDataSetReaderTransportDataType (const UaBrokerDataSetReaderTransportDataType &other)
 Constructs an instance of the class UaBrokerDataSetReaderTransportDataType with values from another UaBrokerDataSetReaderTransportDataType object. More...
 
 UaBrokerDataSetReaderTransportDataType (const OpcUa_BrokerDataSetReaderTransportDataType &other)
 Constructs an instance of the class UaBrokerDataSetReaderTransportDataType with values from another OpcUa_BrokerDataSetReaderTransportDataType structure. More...
 
 UaBrokerDataSetReaderTransportDataType (const UaString &queueName, const UaString &resourceUri, const UaString &authenticationProfileUri, OpcUa_BrokerTransportQualityOfService requestedDeliveryGuarantee, const UaString &metaDataQueueName)
 Constructs an instance of the class UaBrokerDataSetReaderTransportDataType with values provided in the constructor.
 
 UaBrokerDataSetReaderTransportDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaBrokerDataSetReaderTransportDataType initialized with value from a UaExtensionObject. More...
 
 UaBrokerDataSetReaderTransportDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaBrokerDataSetReaderTransportDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaBrokerDataSetReaderTransportDataType ()
 Destroys the UaBrokerDataSetReaderTransportDataType object.
 
void clear ()
 Clear the data of the UaBrokerDataSetReaderTransportDataType. More...
 
bool operator== (const UaBrokerDataSetReaderTransportDataType &other) const
 Compare two UaBrokerDataSetReaderTransportDataType for equality. More...
 
bool operator!= (const UaBrokerDataSetReaderTransportDataType &other) const
 Compare two UaBrokerDataSetReaderTransportDataType for inequality. More...
 
UaBrokerDataSetReaderTransportDataTypeoperator= (const UaBrokerDataSetReaderTransportDataType &other)
 Assignment operator. More...
 
OpcUa_BrokerDataSetReaderTransportDataType * copy () const
 Copy UaBrokerDataSetReaderTransportDataType data to a newly allocated OpcUa_BrokerDataSetReaderTransportDataType. More...
 
void copyTo (OpcUa_BrokerDataSetReaderTransportDataType *pDst) const
 Copy UaBrokerDataSetReaderTransportDataType data to an existing OpcUa_BrokerDataSetReaderTransportDataType structure. More...
 
void attach (OpcUa_BrokerDataSetReaderTransportDataType *pValue)
 Attaches to an existing OpcUa_BrokerDataSetReaderTransportDataType structure. More...
 
OpcUa_BrokerDataSetReaderTransportDataType * detach (OpcUa_BrokerDataSetReaderTransportDataType *pDst)
 Detaches the internal BrokerDataSetReaderTransportDataType structure from this class. More...
 
UaString getQueueName () const
 Returns the QueueName.
 
UaString getResourceUri () const
 Returns the ResourceUri.
 
UaString getAuthenticationProfileUri () const
 Returns the AuthenticationProfileUri.
 
OpcUa_BrokerTransportQualityOfService getRequestedDeliveryGuarantee () const
 Returns the RequestedDeliveryGuarantee.
 
UaString getMetaDataQueueName () const
 Returns the MetaDataQueueName.
 
void setQueueName (const UaString &queueName)
 Sets the QueueName.
 
void setResourceUri (const UaString &resourceUri)
 Sets the ResourceUri.
 
void setAuthenticationProfileUri (const UaString &authenticationProfileUri)
 Sets the AuthenticationProfileUri.
 
void setRequestedDeliveryGuarantee (OpcUa_BrokerTransportQualityOfService requestedDeliveryGuarantee)
 Sets the RequestedDeliveryGuarantee.
 
void setMetaDataQueueName (const UaString &metaDataQueueName)
 Sets the MetaDataQueueName.
 

Static Public Member Functions

static
OpcUa_BrokerDataSetReaderTransportDataType * 
clone (const OpcUa_BrokerDataSetReaderTransportDataType &source)
 Copy OpcUa_BrokerDataSetReaderTransportDataType data to a newly allocated OpcUa_BrokerDataSetReaderTransportDataType. More...
 
static void cloneTo (const OpcUa_BrokerDataSetReaderTransportDataType &source, OpcUa_BrokerDataSetReaderTransportDataType &copy)
 Copy OpcUa_BrokerDataSetReaderTransportDataType data to an existing OpcUa_BrokerDataSetReaderTransportDataType structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_BrokerDataSetReaderTransportDataType.

This class encapsulates the native OpcUa_BrokerDataSetReaderTransportDataType structure and handles memory allocation and cleanup for you. UaBrokerDataSetReaderTransportDataType uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared BrokerDataSetReaderTransportDataType it creates a copy for that (copy-on-write). So assigning another UaBrokerDataSetReaderTransportDataType or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Constructor & Destructor Documentation

UaBrokerDataSetReaderTransportDataType::UaBrokerDataSetReaderTransportDataType ( const UaBrokerDataSetReaderTransportDataType other)

Constructs an instance of the class UaBrokerDataSetReaderTransportDataType with values from another UaBrokerDataSetReaderTransportDataType object.

Parameters
otherthe other UaBrokerDataSetReaderTransportDataType used to initialize the object
UaBrokerDataSetReaderTransportDataType::UaBrokerDataSetReaderTransportDataType ( const OpcUa_BrokerDataSetReaderTransportDataType &  other)

Constructs an instance of the class UaBrokerDataSetReaderTransportDataType with values from another OpcUa_BrokerDataSetReaderTransportDataType structure.

Parameters
otherthe other OpcUa_BrokerDataSetReaderTransportDataType used to initialize the object
UaBrokerDataSetReaderTransportDataType::UaBrokerDataSetReaderTransportDataType ( const UaExtensionObject extensionObject)

Constructs an instance of the class UaBrokerDataSetReaderTransportDataType initialized with value from a UaExtensionObject.

Parameters
extensionObjectthe extension object containing the BrokerDataSetReaderTransportDataType
UaBrokerDataSetReaderTransportDataType::UaBrokerDataSetReaderTransportDataType ( const OpcUa_ExtensionObject extensionObject)

Constructs an instance of the class UaBrokerDataSetReaderTransportDataType initialized with value from an OpcUa_ExtensionObject structure.

Parameters
extensionObjectthe extension object containing the BrokerDataSetReaderTransportDataType

Member Function Documentation

void UaBrokerDataSetReaderTransportDataType::attach ( OpcUa_BrokerDataSetReaderTransportDataType *  pValue)

Attaches to an existing OpcUa_BrokerDataSetReaderTransportDataType structure.

Don't manually free the attached structure afterwards, because UaBrokerDataSetReaderTransportDataType is responsible for it now.

Parameters
pValue[in] Parameter to attach to.
void UaBrokerDataSetReaderTransportDataType::clear ( )
OpcUa_BrokerDataSetReaderTransportDataType * UaBrokerDataSetReaderTransportDataType::clone ( const OpcUa_BrokerDataSetReaderTransportDataType &  source)
static

Copy OpcUa_BrokerDataSetReaderTransportDataType data to a newly allocated OpcUa_BrokerDataSetReaderTransportDataType.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_BrokerDataSetReaderTransportDataType.
void UaBrokerDataSetReaderTransportDataType::cloneTo ( const OpcUa_BrokerDataSetReaderTransportDataType &  source,
OpcUa_BrokerDataSetReaderTransportDataType &  copy 
)
static

Copy OpcUa_BrokerDataSetReaderTransportDataType data to an existing OpcUa_BrokerDataSetReaderTransportDataType structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_BrokerDataSetReaderTransportDataType * UaBrokerDataSetReaderTransportDataType::copy ( ) const

Copy UaBrokerDataSetReaderTransportDataType data to a newly allocated OpcUa_BrokerDataSetReaderTransportDataType.

Returns
pointer to a newly allocated OpcUa_BrokerDataSetReaderTransportDataType.
void UaBrokerDataSetReaderTransportDataType::copyTo ( OpcUa_BrokerDataSetReaderTransportDataType *  pDst) const

Copy UaBrokerDataSetReaderTransportDataType data to an existing OpcUa_BrokerDataSetReaderTransportDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_BrokerDataSetReaderTransportDataType * UaBrokerDataSetReaderTransportDataType::detach ( OpcUa_BrokerDataSetReaderTransportDataType *  pDst)

Detaches the internal BrokerDataSetReaderTransportDataType structure from this class.

This way you take over the control of freeing the BrokerDataSetReaderTransportDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters
pDst[out] Pointer to an OpcUa_BrokerDataSetReaderTransportDataType structure that receives the BrokerDataSetReaderTransportDataType data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
bool UaBrokerDataSetReaderTransportDataType::operator!= ( const UaBrokerDataSetReaderTransportDataType other) const

Compare two UaBrokerDataSetReaderTransportDataType for inequality.

See also
operator==
Parameters
otherthe UaBrokerDataSetReaderTransportDataType to compare with.
Returns
true if not equal, false otherwise.
UaBrokerDataSetReaderTransportDataType & UaBrokerDataSetReaderTransportDataType::operator= ( const UaBrokerDataSetReaderTransportDataType other)

Assignment operator.

Parameters
otherthe UaBrokerDataSetReaderTransportDataType to assign.
Returns
reference to itself.
bool UaBrokerDataSetReaderTransportDataType::operator== ( const UaBrokerDataSetReaderTransportDataType other) const

Compare two UaBrokerDataSetReaderTransportDataType for equality.

Parameters
otherthe UaBrokerDataSetReaderTransportDataType to compare with.
Returns
true if equal, false if not.

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