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

#include <uatimezonedatatype.h>

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

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

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

	UaTimeZoneDataType (OpcUa_Int16 offset, OpcUa_Boolean daylightSavingInOffset)
	Constructs an instance of the class UaTimeZoneDataType with values provided in the constructor.

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

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

	~UaTimeZoneDataType ()
	Destroys the UaTimeZoneDataType object.

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

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

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

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

OpcUa_TimeZoneDataType *	copy () const
	Copy UaTimeZoneDataType data to a newly allocated OpcUa_TimeZoneDataType. More...

void	copyTo (OpcUa_TimeZoneDataType *pDst) const
	Copy UaTimeZoneDataType data to an existing OpcUa_TimeZoneDataType structure. More...

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

OpcUa_TimeZoneDataType *	detach (OpcUa_TimeZoneDataType *pDst)
	Detaches the internal TimeZoneDataType structure from this class. More...

OpcUa_Int16	getOffset () const
	The offset in minutes from UtcTime.

OpcUa_Boolean	getDaylightSavingInOffset () const
	If TRUE, daylight saving time (DST) is in effect and offset includes the DST correction. More...

void	setOffset (OpcUa_Int16 offset)
	The offset in minutes from UtcTime.

void	setDaylightSavingInOffset (OpcUa_Boolean daylightSavingInOffset)
	If TRUE, daylight saving time (DST) is in effect and offset includes the DST correction. More...

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_TimeZoneDataType.

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

The local time that may or may not take daylight saving time into account.

Constructor & Destructor Documentation

UaTimeZoneDataType::UaTimeZoneDataType ( const UaTimeZoneDataType & other )

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

Parameters

other the other UaTimeZoneDataType used to initialize the object

UaTimeZoneDataType::UaTimeZoneDataType ( const OpcUa_TimeZoneDataType & other )

Constructs an instance of the class UaTimeZoneDataType with values from another OpcUa_TimeZoneDataType structure.

Parameters

other the other OpcUa_TimeZoneDataType used to initialize the object

UaTimeZoneDataType::UaTimeZoneDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the TimeZoneDataType

UaTimeZoneDataType::UaTimeZoneDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the TimeZoneDataType

Member Function Documentation

void UaTimeZoneDataType::attach ( OpcUa_TimeZoneDataType * pValue )

Attaches to an existing OpcUa_TimeZoneDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaTimeZoneDataType::clear ( )

Clear the data of the UaTimeZoneDataType.

OpcUa_TimeZoneDataType * UaTimeZoneDataType::clone ( const OpcUa_TimeZoneDataType & source )

static

Copy OpcUa_TimeZoneDataType data to a newly allocated OpcUa_TimeZoneDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_TimeZoneDataType.

void UaTimeZoneDataType::cloneTo	(	const OpcUa_TimeZoneDataType &	source,
		OpcUa_TimeZoneDataType &	copy
	)

static

Copy OpcUa_TimeZoneDataType data to an existing OpcUa_TimeZoneDataType structure.

Parameters

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

OpcUa_TimeZoneDataType * UaTimeZoneDataType::copy ( ) const

Copy UaTimeZoneDataType data to a newly allocated OpcUa_TimeZoneDataType.

Returns: pointer to a newly allocated OpcUa_TimeZoneDataType.

void UaTimeZoneDataType::copyTo ( OpcUa_TimeZoneDataType * pDst ) const

Copy UaTimeZoneDataType data to an existing OpcUa_TimeZoneDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_TimeZoneDataType * UaTimeZoneDataType::detach ( OpcUa_TimeZoneDataType * pDst )

Detaches the internal TimeZoneDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_TimeZoneDataType structure that receives the TimeZoneDataType data.

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

OpcUa_Boolean UaTimeZoneDataType::getDaylightSavingInOffset ( ) const

If TRUE, daylight saving time (DST) is in effect and offset includes the DST correction.

If FALSE, the offset does not include the DST correction and DST may or may not have been in effect.

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

Compare two UaTimeZoneDataType for inequality.

See also: operator==

Parameters

other the UaTimeZoneDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaTimeZoneDataType to assign.

Returns: reference to itself.

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

Compare two UaTimeZoneDataType for equality.

Parameters

other the UaTimeZoneDataType to compare with.

Returns: true if equal, false if not.

void UaTimeZoneDataType::setDaylightSavingInOffset ( OpcUa_Boolean daylightSavingInOffset )

If TRUE, daylight saving time (DST) is in effect and offset includes the DST correction.

If FALSE, the offset does not include the DST correction and DST may or may not have been in effect.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation