C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537

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

#include <uawritergroupdatatype.h>

Public Member Functions

 UaWriterGroupDataType ()
 Constructs an instance of the class UaWriterGroupDataType with empty default values.
 
 UaWriterGroupDataType (const UaWriterGroupDataType &other)
 Constructs an instance of the class UaWriterGroupDataType with values from another UaWriterGroupDataType object. More...
 
 UaWriterGroupDataType (const OpcUa_WriterGroupDataType &other)
 Constructs an instance of the class UaWriterGroupDataType with values from another OpcUa_WriterGroupDataType structure. More...
 
 UaWriterGroupDataType (const UaString &name, OpcUa_Boolean enabled, OpcUa_MessageSecurityMode securityMode, const UaString &securityGroupId, const UaEndpointDescriptions &securityKeyServices, OpcUa_UInt32 maxNetworkMessageSize, const UaKeyValuePairs &groupProperties, OpcUa_UInt16 writerGroupId, OpcUa_Double publishingInterval, OpcUa_Double keepAliveTime, OpcUa_Byte priority, const UaStringArray &localeIds, const UaString &headerLayoutUri, UaExtensionObject &transportSettings, UaExtensionObject &messageSettings, const UaDataSetWriterDataTypes &dataSetWriters)
 Constructs an instance of the class UaWriterGroupDataType with values provided in the constructor.
 
 UaWriterGroupDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaWriterGroupDataType initialized with value from a UaExtensionObject. More...
 
 UaWriterGroupDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaWriterGroupDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaWriterGroupDataType ()
 Destroys the UaWriterGroupDataType object.
 
void clear ()
 Clear the data of the UaWriterGroupDataType. More...
 
bool operator== (const UaWriterGroupDataType &other) const
 Compare two UaWriterGroupDataType for equality. More...
 
bool operator!= (const UaWriterGroupDataType &other) const
 Compare two UaWriterGroupDataType for inequality. More...
 
UaWriterGroupDataTypeoperator= (const UaWriterGroupDataType &other)
 Assignment operator. More...
 
OpcUa_WriterGroupDataType * copy () const
 Copy UaWriterGroupDataType data to a newly allocated OpcUa_WriterGroupDataType. More...
 
void copyTo (OpcUa_WriterGroupDataType *pDst) const
 Copy UaWriterGroupDataType data to an existing OpcUa_WriterGroupDataType structure. More...
 
void attach (OpcUa_WriterGroupDataType *pValue)
 Attaches to an existing OpcUa_WriterGroupDataType structure. More...
 
OpcUa_WriterGroupDataType * detach (OpcUa_WriterGroupDataType *pDst)
 Detaches the internal WriterGroupDataType structure from this class. More...
 
UaString getName () const
 Returns the Name.
 
OpcUa_Boolean getEnabled () const
 Returns the Enabled.
 
OpcUa_MessageSecurityMode getSecurityMode () const
 Returns the SecurityMode.
 
UaString getSecurityGroupId () const
 Returns the SecurityGroupId.
 
void getSecurityKeyServices (UaEndpointDescriptions &securityKeyServices) const
 Returns the SecurityKeyServices.
 
OpcUa_UInt32 getMaxNetworkMessageSize () const
 Returns the MaxNetworkMessageSize.
 
void getGroupProperties (UaKeyValuePairs &groupProperties) const
 Returns the GroupProperties.
 
OpcUa_UInt16 getWriterGroupId () const
 Returns the WriterGroupId.
 
OpcUa_Double getPublishingInterval () const
 Returns the PublishingInterval.
 
OpcUa_Double getKeepAliveTime () const
 Returns the KeepAliveTime.
 
OpcUa_Byte getPriority () const
 Returns the Priority.
 
void getLocaleIds (UaStringArray &localeIds) const
 Returns the LocaleIds.
 
UaString getHeaderLayoutUri () const
 Returns the HeaderLayoutUri.
 
UaExtensionObject getTransportSettings () const
 Returns the TransportSettings.
 
UaExtensionObject getMessageSettings () const
 Returns the MessageSettings.
 
void getDataSetWriters (UaDataSetWriterDataTypes &dataSetWriters) const
 Returns the DataSetWriters.
 
void setName (const UaString &name)
 Sets the Name.
 
void setEnabled (OpcUa_Boolean enabled)
 Sets the Enabled.
 
void setSecurityMode (OpcUa_MessageSecurityMode securityMode)
 Sets the SecurityMode.
 
void setSecurityGroupId (const UaString &securityGroupId)
 Sets the SecurityGroupId.
 
void setSecurityKeyServices (const UaEndpointDescriptions &securityKeyServices)
 Sets the SecurityKeyServices.
 
void setMaxNetworkMessageSize (OpcUa_UInt32 maxNetworkMessageSize)
 Sets the MaxNetworkMessageSize.
 
void setGroupProperties (const UaKeyValuePairs &groupProperties)
 Sets the GroupProperties.
 
void setWriterGroupId (OpcUa_UInt16 writerGroupId)
 Sets the WriterGroupId.
 
void setPublishingInterval (OpcUa_Double publishingInterval)
 Sets the PublishingInterval.
 
void setKeepAliveTime (OpcUa_Double keepAliveTime)
 Sets the KeepAliveTime.
 
void setPriority (OpcUa_Byte priority)
 Sets the Priority.
 
void setLocaleIds (const UaStringArray &localeIds)
 Sets the LocaleIds.
 
void setHeaderLayoutUri (const UaString &headerLayoutUri)
 Sets the HeaderLayoutUri.
 
void setTransportSettings (UaExtensionObject &transportSettings)
 Sets the TransportSettings.
 
void setMessageSettings (UaExtensionObject &messageSettings)
 Sets the MessageSettings.
 
void setDataSetWriters (const UaDataSetWriterDataTypes &dataSetWriters)
 Sets the DataSetWriters.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_WriterGroupDataType.

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

Constructor & Destructor Documentation

UaWriterGroupDataType::UaWriterGroupDataType ( const UaWriterGroupDataType other)

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

Parameters
otherthe other UaWriterGroupDataType used to initialize the object
UaWriterGroupDataType::UaWriterGroupDataType ( const OpcUa_WriterGroupDataType &  other)

Constructs an instance of the class UaWriterGroupDataType with values from another OpcUa_WriterGroupDataType structure.

Parameters
otherthe other OpcUa_WriterGroupDataType used to initialize the object
UaWriterGroupDataType::UaWriterGroupDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the WriterGroupDataType
UaWriterGroupDataType::UaWriterGroupDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the WriterGroupDataType

Member Function Documentation

void UaWriterGroupDataType::attach ( OpcUa_WriterGroupDataType *  pValue)

Attaches to an existing OpcUa_WriterGroupDataType structure.

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

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

Clear the data of the UaWriterGroupDataType.

OpcUa_WriterGroupDataType * UaWriterGroupDataType::clone ( const OpcUa_WriterGroupDataType &  source)
static

Copy OpcUa_WriterGroupDataType data to a newly allocated OpcUa_WriterGroupDataType.

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

Copy OpcUa_WriterGroupDataType data to an existing OpcUa_WriterGroupDataType structure.

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

Copy UaWriterGroupDataType data to a newly allocated OpcUa_WriterGroupDataType.

Returns
pointer to a newly allocated OpcUa_WriterGroupDataType.
void UaWriterGroupDataType::copyTo ( OpcUa_WriterGroupDataType *  pDst) const

Copy UaWriterGroupDataType data to an existing OpcUa_WriterGroupDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_WriterGroupDataType * UaWriterGroupDataType::detach ( OpcUa_WriterGroupDataType *  pDst)

Detaches the internal WriterGroupDataType structure from this class.

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

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

Compare two UaWriterGroupDataType for inequality.

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

Assignment operator.

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

Compare two UaWriterGroupDataType for equality.

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

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