UaAnnotation Class Reference [UA Base Library Classes]

Wrapper classs for the ua stack structure OpcUa_Annotation. More...

#include <uaannotation.h>

List of all members.

Public Member Functions
	UaAnnotation ()
	UaAnnotation (const UaAnnotation &other)
	UaAnnotation (const OpcUa_Annotation &other)
	UaAnnotation (const UaString &message, const UaString userName, const UaDateTime &annotationTime)
	~UaAnnotation ()
void	clear ()
UaAnnotation &	operator= (const UaAnnotation &other)
	operator const OpcUa_Annotation * () const
OpcUa_Annotation *	copy () const
void	copyTo (OpcUa_Annotation *pDst) const
void	detach ()
UaString	toString () const
void	setAnnotation (const UaString &message, const UaString userName, const UaDateTime &annotationTime)
UaString	message () const
UaString	userName () const
UaDateTime	annotationTime () const
Static Public Member Functions
static OpcUa_Annotation *	clone (const OpcUa_Annotation &source)
static void	cloneTo (const OpcUa_Annotation &source, OpcUa_Annotation &copy)

---

Detailed Description

Wrapper classs for the ua stack structure OpcUa_Annotation.

---

Constructor & Destructor Documentation

UaAnnotation::UaAnnotation

(

)

Constructs an annotation with intitial values

UaAnnotation::UaAnnotation

(

const UaAnnotation &

other )

Constructs an annotation with values from other UaAnnotation object

UaAnnotation::UaAnnotation

(

const OpcUa_Annotation &

other )

Constructs an annotation with values from other OpcUa_Annotation structure

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

Constructs an annotation with the passed message, user name and annotation time

UaAnnotation::~UaAnnotation

(

)

Destroys the annotation

---

Member Function Documentation

UaDateTime UaAnnotation::annotationTime

(

)

const

The annotation time.

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 exisitng 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 exisitng OpcUa_Annotation structure.

Parameters:

pDst	the destination of this copyoperation.

void UaAnnotation::detach

(

)

Reset OpcUa_Annotation structure without clearing the data.

UaString UaAnnotation::message

(

)

const

The message of the annotation.

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.

UaString UaAnnotation::userName

(

)

const

The user name of the annotation.

---

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

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uaannotation.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uaannotation.cpp