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

#include <uaannotation.h>

Inherits OpcUa_Annotation.

Public Member Functions
	UaAnnotation ()
	Constructs an annotation with intitial values.

	UaAnnotation (const UaAnnotation &other)
	Constructs an annotation with values from other UaAnnotation object.

	UaAnnotation (const OpcUa_Annotation &other)
	Constructs an annotation with values from other OpcUa_Annotation structure.

	UaAnnotation (const UaString &message, const UaString userName, const UaDateTime &annotationTime)
	Constructs an annotation with the passed message, user name and annotation time.

	~UaAnnotation ()
	Destroys the annotation.

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

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

	operator const OpcUa_Annotation * () const
	Return internal OpcUa_Annotation structure. More...

OpcUa_Annotation *	copy () const
	Copy UaAnnotation data to a newly allocated OpcUa_Annotation. More...

void	copyTo (OpcUa_Annotation *pDst) const
	Copy UaAnnotation data to an existing OpcUa_Annotation structure. More...

void	detach ()
	Reset OpcUa_Annotation structure without clearing the data. More...

UaString	toString () const
	Converts the UaAnnotation into a UaString. More...

void	setAnnotation (const UaString &message, const UaString userName, const UaDateTime &annotationTime)
	Sets the Annotation. More...

UaString	message () const
	The message of the annotation.

UaString	userName () const
	The user name of the annotation.

UaDateTime	annotationTime () const
	The annotation time.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_Annotation.

Member Function Documentation

void UaAnnotation::clear ( )

Clear the data of the UaAnnotation.

OpcUa_Annotation * UaAnnotation::clone ( const OpcUa_Annotation & source )

static

Copy OpcUa_VariableAttributes data to a newly allocated OpcUa_VariableAttributes.

Returns: new copy.

Parameters

source Source to clone.

void UaAnnotation::cloneTo	(	const OpcUa_Annotation &	source,
		OpcUa_Annotation &	copy
	)

static

Copy OpcUa_Annotation data to an existing OpcUa_Annotation structure.

Parameters

[in]	source	The source of the cloneoperation.
[in,out]	copy	The destination of the cloneoperation.

OpcUa_Annotation * UaAnnotation::copy ( ) const

Copy UaAnnotation data to a newly allocated OpcUa_Annotation.

Returns: data to a newly allocated OpcUa_Annotation.

void UaAnnotation::copyTo ( OpcUa_Annotation * pDst ) const

Copy UaAnnotation data to an existing OpcUa_Annotation structure.

Parameters

pDst	the destination of this copy operation.

void UaAnnotation::detach ( )

Reset OpcUa_Annotation structure without clearing the data.

UaAnnotation::operator const OpcUa_Annotation * ( ) const

Return internal OpcUa_Annotation structure.

Returns: internal OpcUa_Annotation structure.

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

Assignment operator.

Returns: Assignment operator.

Parameters

[in] other The UaAnnotation to assign.

void UaAnnotation::setAnnotation	(	const UaString &	message,
		const UaString	userName,
		const UaDateTime &	annotationTime
	)

Sets the Annotation.

Parameters

[in]	message	The passed message for the annotation.
[in]	userName	The correct user name for the annotation.
[in]	annotationTime	The time used in this annotation.

UaString UaAnnotation::toString ( ) const

Converts the UaAnnotation into a UaString.

Returns: the converted UaAnnotation.

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

D:/work/uasdkcpp/src/uabase/uabasecpp/uaannotation.h
D:/work/uasdkcpp/src/uabase/uabasecpp/uaannotation.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation