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

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

#include <uadatagramwritergrouptransportdatatype.h>

Public Member Functions

 UaDatagramWriterGroupTransportDataType ()
 Constructs an instance of the class UaDatagramWriterGroupTransportDataType with empty default values.
 
 UaDatagramWriterGroupTransportDataType (const UaDatagramWriterGroupTransportDataType &other)
 Constructs an instance of the class UaDatagramWriterGroupTransportDataType with values from another UaDatagramWriterGroupTransportDataType object. More...
 
 UaDatagramWriterGroupTransportDataType (const OpcUa_DatagramWriterGroupTransportDataType &other)
 Constructs an instance of the class UaDatagramWriterGroupTransportDataType with values from another OpcUa_DatagramWriterGroupTransportDataType structure. More...
 
 UaDatagramWriterGroupTransportDataType (OpcUa_Byte messageRepeatCount, OpcUa_Double messageRepeatDelay)
 Constructs an instance of the class UaDatagramWriterGroupTransportDataType with values provided in the constructor.
 
 UaDatagramWriterGroupTransportDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaDatagramWriterGroupTransportDataType initialized with value from a UaExtensionObject. More...
 
 UaDatagramWriterGroupTransportDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaDatagramWriterGroupTransportDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaDatagramWriterGroupTransportDataType ()
 Destroys the UaDatagramWriterGroupTransportDataType object.
 
void clear ()
 Clear the data of the UaDatagramWriterGroupTransportDataType. More...
 
bool operator== (const UaDatagramWriterGroupTransportDataType &other) const
 Compare two UaDatagramWriterGroupTransportDataType for equality. More...
 
bool operator!= (const UaDatagramWriterGroupTransportDataType &other) const
 Compare two UaDatagramWriterGroupTransportDataType for inequality. More...
 
UaDatagramWriterGroupTransportDataTypeoperator= (const UaDatagramWriterGroupTransportDataType &other)
 Assignment operator. More...
 
OpcUa_DatagramWriterGroupTransportDataType * copy () const
 Copy UaDatagramWriterGroupTransportDataType data to a newly allocated OpcUa_DatagramWriterGroupTransportDataType. More...
 
void copyTo (OpcUa_DatagramWriterGroupTransportDataType *pDst) const
 Copy UaDatagramWriterGroupTransportDataType data to an existing OpcUa_DatagramWriterGroupTransportDataType structure. More...
 
void attach (OpcUa_DatagramWriterGroupTransportDataType *pValue)
 Attaches to an existing OpcUa_DatagramWriterGroupTransportDataType structure. More...
 
OpcUa_DatagramWriterGroupTransportDataType * detach (OpcUa_DatagramWriterGroupTransportDataType *pDst)
 Detaches the internal DatagramWriterGroupTransportDataType structure from this class. More...
 
OpcUa_Byte getMessageRepeatCount () const
 Returns the MessageRepeatCount.
 
OpcUa_Double getMessageRepeatDelay () const
 Returns the MessageRepeatDelay.
 
void setMessageRepeatCount (OpcUa_Byte messageRepeatCount)
 Sets the MessageRepeatCount.
 
void setMessageRepeatDelay (OpcUa_Double messageRepeatDelay)
 Sets the MessageRepeatDelay.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_DatagramWriterGroupTransportDataType.

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

Constructor & Destructor Documentation

UaDatagramWriterGroupTransportDataType::UaDatagramWriterGroupTransportDataType ( const UaDatagramWriterGroupTransportDataType other)

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

Parameters
otherthe other UaDatagramWriterGroupTransportDataType used to initialize the object
UaDatagramWriterGroupTransportDataType::UaDatagramWriterGroupTransportDataType ( const OpcUa_DatagramWriterGroupTransportDataType &  other)

Constructs an instance of the class UaDatagramWriterGroupTransportDataType with values from another OpcUa_DatagramWriterGroupTransportDataType structure.

Parameters
otherthe other OpcUa_DatagramWriterGroupTransportDataType used to initialize the object
UaDatagramWriterGroupTransportDataType::UaDatagramWriterGroupTransportDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the DatagramWriterGroupTransportDataType
UaDatagramWriterGroupTransportDataType::UaDatagramWriterGroupTransportDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the DatagramWriterGroupTransportDataType

Member Function Documentation

void UaDatagramWriterGroupTransportDataType::attach ( OpcUa_DatagramWriterGroupTransportDataType *  pValue)

Attaches to an existing OpcUa_DatagramWriterGroupTransportDataType structure.

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

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

Copy OpcUa_DatagramWriterGroupTransportDataType data to a newly allocated OpcUa_DatagramWriterGroupTransportDataType.

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

Copy OpcUa_DatagramWriterGroupTransportDataType data to an existing OpcUa_DatagramWriterGroupTransportDataType structure.

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

Copy UaDatagramWriterGroupTransportDataType data to a newly allocated OpcUa_DatagramWriterGroupTransportDataType.

Returns
pointer to a newly allocated OpcUa_DatagramWriterGroupTransportDataType.
void UaDatagramWriterGroupTransportDataType::copyTo ( OpcUa_DatagramWriterGroupTransportDataType *  pDst) const

Copy UaDatagramWriterGroupTransportDataType data to an existing OpcUa_DatagramWriterGroupTransportDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_DatagramWriterGroupTransportDataType * UaDatagramWriterGroupTransportDataType::detach ( OpcUa_DatagramWriterGroupTransportDataType *  pDst)

Detaches the internal DatagramWriterGroupTransportDataType structure from this class.

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

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

Compare two UaDatagramWriterGroupTransportDataType for inequality.

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

Assignment operator.

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

Compare two UaDatagramWriterGroupTransportDataType for equality.

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

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