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

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

#include <uabrokerconnectiontransportdatatype.h>

Public Member Functions

 UaBrokerConnectionTransportDataType ()
 Constructs an instance of the class UaBrokerConnectionTransportDataType with empty default values.
 
 UaBrokerConnectionTransportDataType (const UaBrokerConnectionTransportDataType &other)
 Constructs an instance of the class UaBrokerConnectionTransportDataType with values from another UaBrokerConnectionTransportDataType object. More...
 
 UaBrokerConnectionTransportDataType (const OpcUa_BrokerConnectionTransportDataType &other)
 Constructs an instance of the class UaBrokerConnectionTransportDataType with values from another OpcUa_BrokerConnectionTransportDataType structure. More...
 
 UaBrokerConnectionTransportDataType (const UaString &resourceUri, const UaString &authenticationProfileUri)
 Constructs an instance of the class UaBrokerConnectionTransportDataType with values provided in the constructor.
 
 UaBrokerConnectionTransportDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaBrokerConnectionTransportDataType initialized with value from a UaExtensionObject. More...
 
 UaBrokerConnectionTransportDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaBrokerConnectionTransportDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaBrokerConnectionTransportDataType ()
 Destroys the UaBrokerConnectionTransportDataType object.
 
void clear ()
 Clear the data of the UaBrokerConnectionTransportDataType. More...
 
bool operator== (const UaBrokerConnectionTransportDataType &other) const
 Compare two UaBrokerConnectionTransportDataType for equality. More...
 
bool operator!= (const UaBrokerConnectionTransportDataType &other) const
 Compare two UaBrokerConnectionTransportDataType for inequality. More...
 
UaBrokerConnectionTransportDataTypeoperator= (const UaBrokerConnectionTransportDataType &other)
 Assignment operator. More...
 
OpcUa_BrokerConnectionTransportDataType * copy () const
 Copy UaBrokerConnectionTransportDataType data to a newly allocated OpcUa_BrokerConnectionTransportDataType. More...
 
void copyTo (OpcUa_BrokerConnectionTransportDataType *pDst) const
 Copy UaBrokerConnectionTransportDataType data to an existing OpcUa_BrokerConnectionTransportDataType structure. More...
 
void attach (OpcUa_BrokerConnectionTransportDataType *pValue)
 Attaches to an existing OpcUa_BrokerConnectionTransportDataType structure. More...
 
OpcUa_BrokerConnectionTransportDataType * detach (OpcUa_BrokerConnectionTransportDataType *pDst)
 Detaches the internal BrokerConnectionTransportDataType structure from this class. More...
 
UaString getResourceUri () const
 Returns the ResourceUri.
 
UaString getAuthenticationProfileUri () const
 Returns the AuthenticationProfileUri.
 
void setResourceUri (const UaString &resourceUri)
 Sets the ResourceUri.
 
void setAuthenticationProfileUri (const UaString &authenticationProfileUri)
 Sets the AuthenticationProfileUri.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_BrokerConnectionTransportDataType.

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

Constructor & Destructor Documentation

UaBrokerConnectionTransportDataType::UaBrokerConnectionTransportDataType ( const UaBrokerConnectionTransportDataType other)

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

Parameters
otherthe other UaBrokerConnectionTransportDataType used to initialize the object
UaBrokerConnectionTransportDataType::UaBrokerConnectionTransportDataType ( const OpcUa_BrokerConnectionTransportDataType &  other)

Constructs an instance of the class UaBrokerConnectionTransportDataType with values from another OpcUa_BrokerConnectionTransportDataType structure.

Parameters
otherthe other OpcUa_BrokerConnectionTransportDataType used to initialize the object
UaBrokerConnectionTransportDataType::UaBrokerConnectionTransportDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the BrokerConnectionTransportDataType
UaBrokerConnectionTransportDataType::UaBrokerConnectionTransportDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the BrokerConnectionTransportDataType

Member Function Documentation

void UaBrokerConnectionTransportDataType::attach ( OpcUa_BrokerConnectionTransportDataType *  pValue)

Attaches to an existing OpcUa_BrokerConnectionTransportDataType structure.

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

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

Clear the data of the UaBrokerConnectionTransportDataType.

OpcUa_BrokerConnectionTransportDataType * UaBrokerConnectionTransportDataType::clone ( const OpcUa_BrokerConnectionTransportDataType &  source)
static

Copy OpcUa_BrokerConnectionTransportDataType data to a newly allocated OpcUa_BrokerConnectionTransportDataType.

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

Copy OpcUa_BrokerConnectionTransportDataType data to an existing OpcUa_BrokerConnectionTransportDataType structure.

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

Copy UaBrokerConnectionTransportDataType data to a newly allocated OpcUa_BrokerConnectionTransportDataType.

Returns
pointer to a newly allocated OpcUa_BrokerConnectionTransportDataType.
void UaBrokerConnectionTransportDataType::copyTo ( OpcUa_BrokerConnectionTransportDataType *  pDst) const

Copy UaBrokerConnectionTransportDataType data to an existing OpcUa_BrokerConnectionTransportDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_BrokerConnectionTransportDataType * UaBrokerConnectionTransportDataType::detach ( OpcUa_BrokerConnectionTransportDataType *  pDst)

Detaches the internal BrokerConnectionTransportDataType structure from this class.

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

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

Compare two UaBrokerConnectionTransportDataType for inequality.

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

Assignment operator.

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

Compare two UaBrokerConnectionTransportDataType for equality.

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

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