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

#include <uafieldtargetdatatype.h>

Public Member Functions
	UaFieldTargetDataType ()
	Constructs an instance of the class UaFieldTargetDataType with empty default values.

	UaFieldTargetDataType (const UaFieldTargetDataType &other)
	Constructs an instance of the class UaFieldTargetDataType with values from another UaFieldTargetDataType object. More...

	UaFieldTargetDataType (const OpcUa_FieldTargetDataType &other)
	Constructs an instance of the class UaFieldTargetDataType with values from another OpcUa_FieldTargetDataType structure. More...

	UaFieldTargetDataType (const UaGuid &dataSetFieldId, const UaString &receiverIndexRange, const UaNodeId &targetNodeId, OpcUa_UInt32 attributeId, const UaString &writeIndexRange, OpcUa_OverrideValueHandling overrideValueHandling, const UaVariant &overrideValue)
	Constructs an instance of the class UaFieldTargetDataType with values provided in the constructor.

	UaFieldTargetDataType (const UaExtensionObject &extensionObject)
	Constructs an instance of the class UaFieldTargetDataType initialized with value from a UaExtensionObject. More...

	UaFieldTargetDataType (const OpcUa_ExtensionObject &extensionObject)
	Constructs an instance of the class UaFieldTargetDataType initialized with value from an OpcUa_ExtensionObject structure. More...

	~UaFieldTargetDataType ()
	Destroys the UaFieldTargetDataType object.

void	clear ()
	Clear the data of the UaFieldTargetDataType. More...

bool	operator== (const UaFieldTargetDataType &other) const
	Compare two UaFieldTargetDataType for equality. More...

bool	operator!= (const UaFieldTargetDataType &other) const
	Compare two UaFieldTargetDataType for inequality. More...

UaFieldTargetDataType &	operator= (const UaFieldTargetDataType &other)
	Assignment operator. More...

OpcUa_FieldTargetDataType *	copy () const
	Copy UaFieldTargetDataType data to a newly allocated OpcUa_FieldTargetDataType. More...

void	copyTo (OpcUa_FieldTargetDataType *pDst) const
	Copy UaFieldTargetDataType data to an existing OpcUa_FieldTargetDataType structure. More...

void	attach (OpcUa_FieldTargetDataType *pValue)
	Attaches to an existing OpcUa_FieldTargetDataType structure. More...

OpcUa_FieldTargetDataType *	detach (OpcUa_FieldTargetDataType *pDst)
	Detaches the internal FieldTargetDataType structure from this class. More...

UaGuid	getDataSetFieldId () const
	Returns the DataSetFieldId.

UaString	getReceiverIndexRange () const
	Returns the ReceiverIndexRange.

UaNodeId	getTargetNodeId () const
	Returns the TargetNodeId.

OpcUa_UInt32	getAttributeId () const
	Returns the AttributeId.

UaString	getWriteIndexRange () const
	Returns the WriteIndexRange.

OpcUa_OverrideValueHandling	getOverrideValueHandling () const
	Returns the OverrideValueHandling.

UaVariant	getOverrideValue () const
	Returns the OverrideValue.

void	setDataSetFieldId (const UaGuid &dataSetFieldId)
	Sets the DataSetFieldId.

void	setReceiverIndexRange (const UaString &receiverIndexRange)
	Sets the ReceiverIndexRange.

void	setTargetNodeId (const UaNodeId &targetNodeId)
	Sets the TargetNodeId.

void	setAttributeId (OpcUa_UInt32 attributeId)
	Sets the AttributeId.

void	setWriteIndexRange (const UaString &writeIndexRange)
	Sets the WriteIndexRange.

void	setOverrideValueHandling (OpcUa_OverrideValueHandling overrideValueHandling)
	Sets the OverrideValueHandling.

void	setOverrideValue (const UaVariant &overrideValue)
	Sets the OverrideValue.

Static Public Member Functions
static OpcUa_FieldTargetDataType *	clone (const OpcUa_FieldTargetDataType &source)
	Copy OpcUa_FieldTargetDataType data to a newly allocated OpcUa_FieldTargetDataType. More...

static void	cloneTo (const OpcUa_FieldTargetDataType &source, OpcUa_FieldTargetDataType &copy)
	Copy OpcUa_FieldTargetDataType data to an existing OpcUa_FieldTargetDataType structure. More...

Detailed Description

Wrapper class for the UA stack structure OpcUa_FieldTargetDataType.

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

Constructor & Destructor Documentation

UaFieldTargetDataType::UaFieldTargetDataType ( const UaFieldTargetDataType & other )

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

Parameters

other the other UaFieldTargetDataType used to initialize the object

UaFieldTargetDataType::UaFieldTargetDataType ( const OpcUa_FieldTargetDataType & other )

Constructs an instance of the class UaFieldTargetDataType with values from another OpcUa_FieldTargetDataType structure.

Parameters

other the other OpcUa_FieldTargetDataType used to initialize the object

UaFieldTargetDataType::UaFieldTargetDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the FieldTargetDataType

UaFieldTargetDataType::UaFieldTargetDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the FieldTargetDataType

Member Function Documentation

void UaFieldTargetDataType::attach ( OpcUa_FieldTargetDataType * pValue )

Attaches to an existing OpcUa_FieldTargetDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaFieldTargetDataType::clear ( )

Clear the data of the UaFieldTargetDataType.

OpcUa_FieldTargetDataType * UaFieldTargetDataType::clone ( const OpcUa_FieldTargetDataType & source )

static

Copy OpcUa_FieldTargetDataType data to a newly allocated OpcUa_FieldTargetDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_FieldTargetDataType.

void UaFieldTargetDataType::cloneTo	(	const OpcUa_FieldTargetDataType &	source,
		OpcUa_FieldTargetDataType &	copy
	)

static

Copy OpcUa_FieldTargetDataType data to an existing OpcUa_FieldTargetDataType structure.

Parameters

source	the source of the clone operation.
copy	the destination of the clone operation.

OpcUa_FieldTargetDataType * UaFieldTargetDataType::copy ( ) const

Copy UaFieldTargetDataType data to a newly allocated OpcUa_FieldTargetDataType.

Returns: pointer to a newly allocated OpcUa_FieldTargetDataType.

void UaFieldTargetDataType::copyTo ( OpcUa_FieldTargetDataType * pDst ) const

Copy UaFieldTargetDataType data to an existing OpcUa_FieldTargetDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_FieldTargetDataType * UaFieldTargetDataType::detach ( OpcUa_FieldTargetDataType * pDst )

Detaches the internal FieldTargetDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_FieldTargetDataType structure that receives the FieldTargetDataType data.

Returns: If the function succeeds, pDst is returned, otherwise 0 is returned.

bool UaFieldTargetDataType::operator!= ( const UaFieldTargetDataType & other ) const

Compare two UaFieldTargetDataType for inequality.

See also: operator==

Parameters

other the UaFieldTargetDataType to compare with.

Returns: true if not equal, false otherwise.

UaFieldTargetDataType & UaFieldTargetDataType::operator= ( const UaFieldTargetDataType & other )

Assignment operator.

Parameters

other the UaFieldTargetDataType to assign.

Returns: reference to itself.

bool UaFieldTargetDataType::operator== ( const UaFieldTargetDataType & other ) const

Compare two UaFieldTargetDataType for equality.

Parameters

other the UaFieldTargetDataType to compare with.

Returns: true if equal, false if not.

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

C:/work/uasdkcpp/src/uabase/uabasecpp/uafieldtargetdatatype.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uafieldtargetdatatype.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation