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

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

#include <uabrokerwritergrouptransportdatatype.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_BrokerWriterGroupTransportDataType.

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

Constructor & Destructor Documentation

UaBrokerWriterGroupTransportDataType::UaBrokerWriterGroupTransportDataType ( const UaBrokerWriterGroupTransportDataType other)

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

Parameters
otherthe other UaBrokerWriterGroupTransportDataType used to initialize the object
UaBrokerWriterGroupTransportDataType::UaBrokerWriterGroupTransportDataType ( const OpcUa_BrokerWriterGroupTransportDataType &  other)

Constructs an instance of the class UaBrokerWriterGroupTransportDataType with values from another OpcUa_BrokerWriterGroupTransportDataType structure.

Parameters
otherthe other OpcUa_BrokerWriterGroupTransportDataType used to initialize the object
UaBrokerWriterGroupTransportDataType::UaBrokerWriterGroupTransportDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the BrokerWriterGroupTransportDataType
UaBrokerWriterGroupTransportDataType::UaBrokerWriterGroupTransportDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the BrokerWriterGroupTransportDataType

Member Function Documentation

void UaBrokerWriterGroupTransportDataType::attach ( OpcUa_BrokerWriterGroupTransportDataType *  pValue)

Attaches to an existing OpcUa_BrokerWriterGroupTransportDataType structure.

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

Parameters
pValue[in] Parameter to attach to.
void UaBrokerWriterGroupTransportDataType::clear ( )

Clear the data of the UaBrokerWriterGroupTransportDataType.

OpcUa_BrokerWriterGroupTransportDataType * UaBrokerWriterGroupTransportDataType::clone ( const OpcUa_BrokerWriterGroupTransportDataType &  source)
static

Copy OpcUa_BrokerWriterGroupTransportDataType data to a newly allocated OpcUa_BrokerWriterGroupTransportDataType.

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

Copy OpcUa_BrokerWriterGroupTransportDataType data to an existing OpcUa_BrokerWriterGroupTransportDataType structure.

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

Copy UaBrokerWriterGroupTransportDataType data to a newly allocated OpcUa_BrokerWriterGroupTransportDataType.

Returns
pointer to a newly allocated OpcUa_BrokerWriterGroupTransportDataType.
void UaBrokerWriterGroupTransportDataType::copyTo ( OpcUa_BrokerWriterGroupTransportDataType *  pDst) const

Copy UaBrokerWriterGroupTransportDataType data to an existing OpcUa_BrokerWriterGroupTransportDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_BrokerWriterGroupTransportDataType * UaBrokerWriterGroupTransportDataType::detach ( OpcUa_BrokerWriterGroupTransportDataType *  pDst)

Detaches the internal BrokerWriterGroupTransportDataType structure from this class.

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

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

Compare two UaBrokerWriterGroupTransportDataType for inequality.

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

Assignment operator.

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

Compare two UaBrokerWriterGroupTransportDataType for equality.

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

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