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

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

#include <uauadpwritergroupmessagedatatype.h>

Public Member Functions

 UaUadpWriterGroupMessageDataType ()
 Constructs an instance of the class UaUadpWriterGroupMessageDataType with empty default values.
 
 UaUadpWriterGroupMessageDataType (const UaUadpWriterGroupMessageDataType &other)
 Constructs an instance of the class UaUadpWriterGroupMessageDataType with values from another UaUadpWriterGroupMessageDataType object. More...
 
 UaUadpWriterGroupMessageDataType (const OpcUa_UadpWriterGroupMessageDataType &other)
 Constructs an instance of the class UaUadpWriterGroupMessageDataType with values from another OpcUa_UadpWriterGroupMessageDataType structure. More...
 
 UaUadpWriterGroupMessageDataType (OpcUa_UInt32 groupVersion, OpcUa_DataSetOrderingType dataSetOrdering, OpcUa_UadpNetworkMessageContentMask networkMessageContentMask, OpcUa_Double samplingOffset, const UaDoubleArray &publishingOffset)
 Constructs an instance of the class UaUadpWriterGroupMessageDataType with values provided in the constructor.
 
 UaUadpWriterGroupMessageDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaUadpWriterGroupMessageDataType initialized with value from a UaExtensionObject. More...
 
 UaUadpWriterGroupMessageDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaUadpWriterGroupMessageDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaUadpWriterGroupMessageDataType ()
 Destroys the UaUadpWriterGroupMessageDataType object.
 
void clear ()
 Clear the data of the UaUadpWriterGroupMessageDataType. More...
 
bool operator== (const UaUadpWriterGroupMessageDataType &other) const
 Compare two UaUadpWriterGroupMessageDataType for equality. More...
 
bool operator!= (const UaUadpWriterGroupMessageDataType &other) const
 Compare two UaUadpWriterGroupMessageDataType for inequality. More...
 
UaUadpWriterGroupMessageDataTypeoperator= (const UaUadpWriterGroupMessageDataType &other)
 Assignment operator. More...
 
OpcUa_UadpWriterGroupMessageDataType * copy () const
 Copy UaUadpWriterGroupMessageDataType data to a newly allocated OpcUa_UadpWriterGroupMessageDataType. More...
 
void copyTo (OpcUa_UadpWriterGroupMessageDataType *pDst) const
 Copy UaUadpWriterGroupMessageDataType data to an existing OpcUa_UadpWriterGroupMessageDataType structure. More...
 
void attach (OpcUa_UadpWriterGroupMessageDataType *pValue)
 Attaches to an existing OpcUa_UadpWriterGroupMessageDataType structure. More...
 
OpcUa_UadpWriterGroupMessageDataType * detach (OpcUa_UadpWriterGroupMessageDataType *pDst)
 Detaches the internal UadpWriterGroupMessageDataType structure from this class. More...
 
OpcUa_UInt32 getGroupVersion () const
 Returns the GroupVersion.
 
OpcUa_DataSetOrderingType getDataSetOrdering () const
 Returns the DataSetOrdering.
 
OpcUa_UadpNetworkMessageContentMask getNetworkMessageContentMask () const
 Returns the NetworkMessageContentMask.
 
OpcUa_Double getSamplingOffset () const
 Returns the SamplingOffset.
 
void getPublishingOffset (UaDoubleArray &publishingOffset) const
 Returns the PublishingOffset.
 
void setGroupVersion (OpcUa_UInt32 groupVersion)
 Sets the GroupVersion.
 
void setDataSetOrdering (OpcUa_DataSetOrderingType dataSetOrdering)
 Sets the DataSetOrdering.
 
void setNetworkMessageContentMask (OpcUa_UadpNetworkMessageContentMask networkMessageContentMask)
 Sets the NetworkMessageContentMask.
 
void setSamplingOffset (OpcUa_Double samplingOffset)
 Sets the SamplingOffset.
 
void setPublishingOffset (const UaDoubleArray &publishingOffset)
 Sets the PublishingOffset.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_UadpWriterGroupMessageDataType.

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

Constructor & Destructor Documentation

UaUadpWriterGroupMessageDataType::UaUadpWriterGroupMessageDataType ( const UaUadpWriterGroupMessageDataType other)

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

Parameters
otherthe other UaUadpWriterGroupMessageDataType used to initialize the object
UaUadpWriterGroupMessageDataType::UaUadpWriterGroupMessageDataType ( const OpcUa_UadpWriterGroupMessageDataType &  other)

Constructs an instance of the class UaUadpWriterGroupMessageDataType with values from another OpcUa_UadpWriterGroupMessageDataType structure.

Parameters
otherthe other OpcUa_UadpWriterGroupMessageDataType used to initialize the object
UaUadpWriterGroupMessageDataType::UaUadpWriterGroupMessageDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the UadpWriterGroupMessageDataType
UaUadpWriterGroupMessageDataType::UaUadpWriterGroupMessageDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the UadpWriterGroupMessageDataType

Member Function Documentation

void UaUadpWriterGroupMessageDataType::attach ( OpcUa_UadpWriterGroupMessageDataType *  pValue)

Attaches to an existing OpcUa_UadpWriterGroupMessageDataType structure.

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

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

Clear the data of the UaUadpWriterGroupMessageDataType.

OpcUa_UadpWriterGroupMessageDataType * UaUadpWriterGroupMessageDataType::clone ( const OpcUa_UadpWriterGroupMessageDataType &  source)
static

Copy OpcUa_UadpWriterGroupMessageDataType data to a newly allocated OpcUa_UadpWriterGroupMessageDataType.

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

Copy OpcUa_UadpWriterGroupMessageDataType data to an existing OpcUa_UadpWriterGroupMessageDataType structure.

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

Copy UaUadpWriterGroupMessageDataType data to a newly allocated OpcUa_UadpWriterGroupMessageDataType.

Returns
pointer to a newly allocated OpcUa_UadpWriterGroupMessageDataType.
void UaUadpWriterGroupMessageDataType::copyTo ( OpcUa_UadpWriterGroupMessageDataType *  pDst) const

Copy UaUadpWriterGroupMessageDataType data to an existing OpcUa_UadpWriterGroupMessageDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_UadpWriterGroupMessageDataType * UaUadpWriterGroupMessageDataType::detach ( OpcUa_UadpWriterGroupMessageDataType *  pDst)

Detaches the internal UadpWriterGroupMessageDataType structure from this class.

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

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

Compare two UaUadpWriterGroupMessageDataType for inequality.

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

Assignment operator.

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

Compare two UaUadpWriterGroupMessageDataType for equality.

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

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