C++ Based OPC UA Client/Server/PubSub SDK  1.7.8.584
UaJsonDataSetWriterMessageDataType Class Reference

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

#include <uajsondatasetwritermessagedatatype.h>

Public Member Functions

 UaJsonDataSetWriterMessageDataType ()
 Constructs an instance of the class UaJsonDataSetWriterMessageDataType with empty default values.
 
 UaJsonDataSetWriterMessageDataType (const UaJsonDataSetWriterMessageDataType &other)
 Constructs an instance of the class UaJsonDataSetWriterMessageDataType with values from another UaJsonDataSetWriterMessageDataType object. More...
 
 UaJsonDataSetWriterMessageDataType (const OpcUa_JsonDataSetWriterMessageDataType &other)
 Constructs an instance of the class UaJsonDataSetWriterMessageDataType with values from another OpcUa_JsonDataSetWriterMessageDataType structure. More...
 
 UaJsonDataSetWriterMessageDataType (OpcUa_JsonDataSetMessageContentMask dataSetMessageContentMask)
 Constructs an instance of the class UaJsonDataSetWriterMessageDataType with values provided in the constructor.
 
 UaJsonDataSetWriterMessageDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaJsonDataSetWriterMessageDataType initialized with value from a UaExtensionObject. More...
 
 UaJsonDataSetWriterMessageDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaJsonDataSetWriterMessageDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaJsonDataSetWriterMessageDataType ()
 Destroys the UaJsonDataSetWriterMessageDataType object.
 
void clear ()
 Clear the data of the UaJsonDataSetWriterMessageDataType. More...
 
bool operator== (const UaJsonDataSetWriterMessageDataType &other) const
 Compare two UaJsonDataSetWriterMessageDataType for equality. More...
 
bool operator!= (const UaJsonDataSetWriterMessageDataType &other) const
 Compare two UaJsonDataSetWriterMessageDataType for inequality. More...
 
UaJsonDataSetWriterMessageDataTypeoperator= (const UaJsonDataSetWriterMessageDataType &other)
 Assignment operator. More...
 
OpcUa_JsonDataSetWriterMessageDataType * copy () const
 Copy UaJsonDataSetWriterMessageDataType data to a newly allocated OpcUa_JsonDataSetWriterMessageDataType. More...
 
void copyTo (OpcUa_JsonDataSetWriterMessageDataType *pDst) const
 Copy UaJsonDataSetWriterMessageDataType data to an existing OpcUa_JsonDataSetWriterMessageDataType structure. More...
 
void attach (OpcUa_JsonDataSetWriterMessageDataType *pValue)
 Attaches to an existing OpcUa_JsonDataSetWriterMessageDataType structure. More...
 
OpcUa_JsonDataSetWriterMessageDataType * detach (OpcUa_JsonDataSetWriterMessageDataType *pDst)
 Detaches the internal JsonDataSetWriterMessageDataType structure from this class. More...
 
OpcUa_JsonDataSetMessageContentMask getDataSetMessageContentMask () const
 Returns the DataSetMessageContentMask.
 
void setDataSetMessageContentMask (OpcUa_JsonDataSetMessageContentMask dataSetMessageContentMask)
 Sets the DataSetMessageContentMask.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_JsonDataSetWriterMessageDataType.

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

Constructor & Destructor Documentation

UaJsonDataSetWriterMessageDataType::UaJsonDataSetWriterMessageDataType ( const UaJsonDataSetWriterMessageDataType other)

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

Parameters
otherthe other UaJsonDataSetWriterMessageDataType used to initialize the object
UaJsonDataSetWriterMessageDataType::UaJsonDataSetWriterMessageDataType ( const OpcUa_JsonDataSetWriterMessageDataType &  other)

Constructs an instance of the class UaJsonDataSetWriterMessageDataType with values from another OpcUa_JsonDataSetWriterMessageDataType structure.

Parameters
otherthe other OpcUa_JsonDataSetWriterMessageDataType used to initialize the object
UaJsonDataSetWriterMessageDataType::UaJsonDataSetWriterMessageDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the JsonDataSetWriterMessageDataType
UaJsonDataSetWriterMessageDataType::UaJsonDataSetWriterMessageDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the JsonDataSetWriterMessageDataType

Member Function Documentation

void UaJsonDataSetWriterMessageDataType::attach ( OpcUa_JsonDataSetWriterMessageDataType *  pValue)

Attaches to an existing OpcUa_JsonDataSetWriterMessageDataType structure.

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

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

Clear the data of the UaJsonDataSetWriterMessageDataType.

OpcUa_JsonDataSetWriterMessageDataType * UaJsonDataSetWriterMessageDataType::clone ( const OpcUa_JsonDataSetWriterMessageDataType &  source)
static

Copy OpcUa_JsonDataSetWriterMessageDataType data to a newly allocated OpcUa_JsonDataSetWriterMessageDataType.

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

Copy OpcUa_JsonDataSetWriterMessageDataType data to an existing OpcUa_JsonDataSetWriterMessageDataType structure.

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

Copy UaJsonDataSetWriterMessageDataType data to a newly allocated OpcUa_JsonDataSetWriterMessageDataType.

Returns
pointer to a newly allocated OpcUa_JsonDataSetWriterMessageDataType.
void UaJsonDataSetWriterMessageDataType::copyTo ( OpcUa_JsonDataSetWriterMessageDataType *  pDst) const

Copy UaJsonDataSetWriterMessageDataType data to an existing OpcUa_JsonDataSetWriterMessageDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_JsonDataSetWriterMessageDataType * UaJsonDataSetWriterMessageDataType::detach ( OpcUa_JsonDataSetWriterMessageDataType *  pDst)

Detaches the internal JsonDataSetWriterMessageDataType structure from this class.

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

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

Compare two UaJsonDataSetWriterMessageDataType for inequality.

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

Assignment operator.

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

Compare two UaJsonDataSetWriterMessageDataType for equality.

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

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