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

#include <uabuildinfo.h>

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

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

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

	UaBuildInfo (const UaString &productUri, const UaString &manufacturerName, const UaString &productName, const UaString &softwareVersion, const UaString &buildNumber, const UaDateTime &buildDate)
	Constructs an instance of the class UaBuildInfo with values provided in the constructor.

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

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

	~UaBuildInfo ()
	Destroys the UaBuildInfo object.

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

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

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

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

OpcUa_BuildInfo *	copy () const
	Copy UaBuildInfo data to a newly allocated OpcUa_BuildInfo. More...

void	copyTo (OpcUa_BuildInfo *pDst) const
	Copy UaBuildInfo data to an existing OpcUa_BuildInfo structure. More...

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

OpcUa_BuildInfo *	detach (OpcUa_BuildInfo *pDst)
	Detaches the internal BuildInfo structure from this class. More...

UaString	getProductUri () const
	URI that identifies the software.

UaString	getManufacturerName () const
	Name of the software manufacturer.

UaString	getProductName () const
	Name of the software.

UaString	getSoftwareVersion () const
	Software version.

UaString	getBuildNumber () const
	Build number.

UaDateTime	getBuildDate () const
	Date and time of the build.

void	setProductUri (const UaString &productUri)
	URI that identifies the software.

void	setManufacturerName (const UaString &manufacturerName)
	Name of the software manufacturer.

void	setProductName (const UaString &productName)
	Name of the software.

void	setSoftwareVersion (const UaString &softwareVersion)
	Software version.

void	setBuildNumber (const UaString &buildNumber)
	Build number.

void	setBuildDate (const UaDateTime &buildDate)
	Date and time of the build.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_BuildInfo.

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

Contains elements that describe the build information of the Server.

Constructor & Destructor Documentation

UaBuildInfo::UaBuildInfo ( const UaBuildInfo & other )

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

Parameters

other the other UaBuildInfo used to initialize the object

UaBuildInfo::UaBuildInfo ( const OpcUa_BuildInfo & other )

Constructs an instance of the class UaBuildInfo with values from another OpcUa_BuildInfo structure.

Parameters

other the other OpcUa_BuildInfo used to initialize the object

UaBuildInfo::UaBuildInfo ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the BuildInfo

UaBuildInfo::UaBuildInfo ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the BuildInfo

Member Function Documentation

void UaBuildInfo::attach ( OpcUa_BuildInfo * pValue )

Attaches to an existing OpcUa_BuildInfo structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaBuildInfo::clear ( )

Clear the data of the UaBuildInfo.

OpcUa_BuildInfo * UaBuildInfo::clone ( const OpcUa_BuildInfo & source )

static

Copy OpcUa_BuildInfo data to a newly allocated OpcUa_BuildInfo.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_BuildInfo.

void UaBuildInfo::cloneTo	(	const OpcUa_BuildInfo &	source,
		OpcUa_BuildInfo &	copy
	)

static

Copy OpcUa_BuildInfo data to an existing OpcUa_BuildInfo structure.

Parameters

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

OpcUa_BuildInfo * UaBuildInfo::copy ( ) const

Copy UaBuildInfo data to a newly allocated OpcUa_BuildInfo.

Returns: pointer to a newly allocated OpcUa_BuildInfo.

void UaBuildInfo::copyTo ( OpcUa_BuildInfo * pDst ) const

Copy UaBuildInfo data to an existing OpcUa_BuildInfo structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_BuildInfo * UaBuildInfo::detach ( OpcUa_BuildInfo * pDst )

Detaches the internal BuildInfo structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_BuildInfo structure that receives the BuildInfo data.

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

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

Compare two UaBuildInfo for inequality.

See also: operator==

Parameters

other the UaBuildInfo to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaBuildInfo to assign.

Returns: reference to itself.

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

Compare two UaBuildInfo for equality.

Parameters

other the UaBuildInfo 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/uabuildinfo.h
C:/work/uasdkcpp/src/uabase/uabasecpp/uabuildinfo.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation