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

#include <uauabinaryfiledatatype.h>

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

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

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

	UaUABinaryFileDataType (const UaStringArray &namespaces, const UaStructureDescriptions &structureDataTypes, const UaEnumDescriptions &enumDataTypes, const UaSimpleTypeDescriptions &simpleDataTypes, const UaString &schemaLocation, const UaKeyValuePairs &fileHeader, const UaVariant &body)
	Constructs an instance of the class UaUABinaryFileDataType with values provided in the constructor.

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

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

	~UaUABinaryFileDataType ()
	Destroys the UaUABinaryFileDataType object.

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

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

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

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

OpcUa_UABinaryFileDataType *	copy () const
	Copy UaUABinaryFileDataType data to a newly allocated OpcUa_UABinaryFileDataType. More...

void	copyTo (OpcUa_UABinaryFileDataType *pDst) const
	Copy UaUABinaryFileDataType data to an existing OpcUa_UABinaryFileDataType structure. More...

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

OpcUa_UABinaryFileDataType *	detach (OpcUa_UABinaryFileDataType *pDst)
	Detaches the internal UABinaryFileDataType structure from this class. More...

void	getNamespaces (UaStringArray &namespaces) const
	Returns the Namespaces.

void	getStructureDataTypes (UaStructureDescriptions &structureDataTypes) const
	Returns the StructureDataTypes.

void	getEnumDataTypes (UaEnumDescriptions &enumDataTypes) const
	Returns the EnumDataTypes.

void	getSimpleDataTypes (UaSimpleTypeDescriptions &simpleDataTypes) const
	Returns the SimpleDataTypes.

UaString	getSchemaLocation () const
	Returns the SchemaLocation.

void	getFileHeader (UaKeyValuePairs &fileHeader) const
	Returns the FileHeader.

UaVariant	getBody () const
	Returns the Body.

void	setNamespaces (const UaStringArray &namespaces)
	Sets the Namespaces.

void	setStructureDataTypes (const UaStructureDescriptions &structureDataTypes)
	Sets the StructureDataTypes.

void	setEnumDataTypes (const UaEnumDescriptions &enumDataTypes)
	Sets the EnumDataTypes.

void	setSimpleDataTypes (const UaSimpleTypeDescriptions &simpleDataTypes)
	Sets the SimpleDataTypes.

void	setSchemaLocation (const UaString &schemaLocation)
	Sets the SchemaLocation.

void	setFileHeader (const UaKeyValuePairs &fileHeader)
	Sets the FileHeader.

void	setBody (const UaVariant &body)
	Sets the Body.

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

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_UABinaryFileDataType.

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

Constructor & Destructor Documentation

UaUABinaryFileDataType::UaUABinaryFileDataType ( const UaUABinaryFileDataType & other )

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

Parameters

other the other UaUABinaryFileDataType used to initialize the object

UaUABinaryFileDataType::UaUABinaryFileDataType ( const OpcUa_UABinaryFileDataType & other )

Constructs an instance of the class UaUABinaryFileDataType with values from another OpcUa_UABinaryFileDataType structure.

Parameters

other the other OpcUa_UABinaryFileDataType used to initialize the object

UaUABinaryFileDataType::UaUABinaryFileDataType ( const UaExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the UABinaryFileDataType

UaUABinaryFileDataType::UaUABinaryFileDataType ( const OpcUa_ExtensionObject & extensionObject )

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

Parameters

extensionObject the extension object containing the UABinaryFileDataType

Member Function Documentation

void UaUABinaryFileDataType::attach ( OpcUa_UABinaryFileDataType * pValue )

Attaches to an existing OpcUa_UABinaryFileDataType structure.

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

Parameters

pValue [in] Parameter to attach to.

void UaUABinaryFileDataType::clear ( )

Clear the data of the UaUABinaryFileDataType.

OpcUa_UABinaryFileDataType * UaUABinaryFileDataType::clone ( const OpcUa_UABinaryFileDataType & source )

static

Copy OpcUa_UABinaryFileDataType data to a newly allocated OpcUa_UABinaryFileDataType.

Parameters

source Source to clone.

Returns: pointer to a newly allocated OpcUa_UABinaryFileDataType.

void UaUABinaryFileDataType::cloneTo	(	const OpcUa_UABinaryFileDataType &	source,
		OpcUa_UABinaryFileDataType &	copy
	)

static

Copy OpcUa_UABinaryFileDataType data to an existing OpcUa_UABinaryFileDataType structure.

Parameters

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

OpcUa_UABinaryFileDataType * UaUABinaryFileDataType::copy ( ) const

Copy UaUABinaryFileDataType data to a newly allocated OpcUa_UABinaryFileDataType.

Returns: pointer to a newly allocated OpcUa_UABinaryFileDataType.

void UaUABinaryFileDataType::copyTo ( OpcUa_UABinaryFileDataType * pDst ) const

Copy UaUABinaryFileDataType data to an existing OpcUa_UABinaryFileDataType structure.

Parameters

pDst	the destination of this copy operation.

OpcUa_UABinaryFileDataType * UaUABinaryFileDataType::detach ( OpcUa_UABinaryFileDataType * pDst )

Detaches the internal UABinaryFileDataType structure from this class.

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

Parameters

pDst	[out] Pointer to an OpcUa_UABinaryFileDataType structure that receives the UABinaryFileDataType data.

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

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

Compare two UaUABinaryFileDataType for inequality.

See also: operator==

Parameters

other the UaUABinaryFileDataType to compare with.

Returns: true if not equal, false otherwise.

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

Assignment operator.

Parameters

other the UaUABinaryFileDataType to assign.

Returns: reference to itself.

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

Compare two UaUABinaryFileDataType for equality.

Parameters

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation