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

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

#include <uabrokerdatasetwritertransportdatatype.h>

Public Member Functions

 UaBrokerDataSetWriterTransportDataType ()
 Constructs an instance of the class UaBrokerDataSetWriterTransportDataType with empty default values.
 
 UaBrokerDataSetWriterTransportDataType (const UaBrokerDataSetWriterTransportDataType &other)
 Constructs an instance of the class UaBrokerDataSetWriterTransportDataType with values from another UaBrokerDataSetWriterTransportDataType object. More...
 
 UaBrokerDataSetWriterTransportDataType (const OpcUa_BrokerDataSetWriterTransportDataType &other)
 Constructs an instance of the class UaBrokerDataSetWriterTransportDataType with values from another OpcUa_BrokerDataSetWriterTransportDataType structure. More...
 
 UaBrokerDataSetWriterTransportDataType (const UaString &queueName, const UaString &resourceUri, const UaString &authenticationProfileUri, OpcUa_BrokerTransportQualityOfService requestedDeliveryGuarantee, const UaString &metaDataQueueName, OpcUa_Double metaDataUpdateTime)
 Constructs an instance of the class UaBrokerDataSetWriterTransportDataType with values provided in the constructor.
 
 UaBrokerDataSetWriterTransportDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaBrokerDataSetWriterTransportDataType initialized with value from a UaExtensionObject. More...
 
 UaBrokerDataSetWriterTransportDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaBrokerDataSetWriterTransportDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaBrokerDataSetWriterTransportDataType ()
 Destroys the UaBrokerDataSetWriterTransportDataType object.
 
void clear ()
 Clear the data of the UaBrokerDataSetWriterTransportDataType. More...
 
bool operator== (const UaBrokerDataSetWriterTransportDataType &other) const
 Compare two UaBrokerDataSetWriterTransportDataType for equality. More...
 
bool operator!= (const UaBrokerDataSetWriterTransportDataType &other) const
 Compare two UaBrokerDataSetWriterTransportDataType for inequality. More...
 
UaBrokerDataSetWriterTransportDataTypeoperator= (const UaBrokerDataSetWriterTransportDataType &other)
 Assignment operator. More...
 
OpcUa_BrokerDataSetWriterTransportDataType * copy () const
 Copy UaBrokerDataSetWriterTransportDataType data to a newly allocated OpcUa_BrokerDataSetWriterTransportDataType. More...
 
void copyTo (OpcUa_BrokerDataSetWriterTransportDataType *pDst) const
 Copy UaBrokerDataSetWriterTransportDataType data to an existing OpcUa_BrokerDataSetWriterTransportDataType structure. More...
 
void attach (OpcUa_BrokerDataSetWriterTransportDataType *pValue)
 Attaches to an existing OpcUa_BrokerDataSetWriterTransportDataType structure. More...
 
OpcUa_BrokerDataSetWriterTransportDataType * detach (OpcUa_BrokerDataSetWriterTransportDataType *pDst)
 Detaches the internal BrokerDataSetWriterTransportDataType 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.
 
OpcUa_Double getMetaDataUpdateTime () const
 Returns the MetaDataUpdateTime.
 
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.
 
void setMetaDataUpdateTime (OpcUa_Double metaDataUpdateTime)
 Sets the MetaDataUpdateTime.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_BrokerDataSetWriterTransportDataType.

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

Constructor & Destructor Documentation

UaBrokerDataSetWriterTransportDataType::UaBrokerDataSetWriterTransportDataType ( const UaBrokerDataSetWriterTransportDataType other)

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

Parameters
otherthe other UaBrokerDataSetWriterTransportDataType used to initialize the object
UaBrokerDataSetWriterTransportDataType::UaBrokerDataSetWriterTransportDataType ( const OpcUa_BrokerDataSetWriterTransportDataType &  other)

Constructs an instance of the class UaBrokerDataSetWriterTransportDataType with values from another OpcUa_BrokerDataSetWriterTransportDataType structure.

Parameters
otherthe other OpcUa_BrokerDataSetWriterTransportDataType used to initialize the object
UaBrokerDataSetWriterTransportDataType::UaBrokerDataSetWriterTransportDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the BrokerDataSetWriterTransportDataType
UaBrokerDataSetWriterTransportDataType::UaBrokerDataSetWriterTransportDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the BrokerDataSetWriterTransportDataType

Member Function Documentation

void UaBrokerDataSetWriterTransportDataType::attach ( OpcUa_BrokerDataSetWriterTransportDataType *  pValue)

Attaches to an existing OpcUa_BrokerDataSetWriterTransportDataType structure.

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

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

Copy OpcUa_BrokerDataSetWriterTransportDataType data to a newly allocated OpcUa_BrokerDataSetWriterTransportDataType.

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

Copy OpcUa_BrokerDataSetWriterTransportDataType data to an existing OpcUa_BrokerDataSetWriterTransportDataType structure.

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

Copy UaBrokerDataSetWriterTransportDataType data to a newly allocated OpcUa_BrokerDataSetWriterTransportDataType.

Returns
pointer to a newly allocated OpcUa_BrokerDataSetWriterTransportDataType.
void UaBrokerDataSetWriterTransportDataType::copyTo ( OpcUa_BrokerDataSetWriterTransportDataType *  pDst) const

Copy UaBrokerDataSetWriterTransportDataType data to an existing OpcUa_BrokerDataSetWriterTransportDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_BrokerDataSetWriterTransportDataType * UaBrokerDataSetWriterTransportDataType::detach ( OpcUa_BrokerDataSetWriterTransportDataType *  pDst)

Detaches the internal BrokerDataSetWriterTransportDataType structure from this class.

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

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

Compare two UaBrokerDataSetWriterTransportDataType for inequality.

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

Assignment operator.

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

Compare two UaBrokerDataSetWriterTransportDataType for equality.

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

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