UaByteString Class Reference
[UA Base Library Classes]

Wrapper classs for the ua stack structure OpcUa_ByteString. Derived from OpcUa_ByteString. More...

#include <uabytestring.h>

List of all members.

Public Member Functions
	UaByteString ()
	UaByteString (const UaByteString &other)
	UaByteString (const OpcUa_ByteString &other)
	UaByteString (OpcUa_Int32 Length, OpcUa_Byte *pData)
	~UaByteString ()
void	clear ()
void	setByteString (OpcUa_Int32 Length, OpcUa_Byte *pData)
UaByteString &	operator= (const UaByteString &other)
void	operator<< (const UaByteString &)
bool	operator== (const UaByteString &) const
bool	operator!= (const UaByteString &) const
	operator const OpcUa_ByteString * () const
OpcUa_ByteString *	copy () const
void	copyTo (OpcUa_ByteString *pDst) const
void	detach ()
void	attach (const OpcUa_ByteString *pSrc)
OpcUa_Int32	length () const
const OpcUa_Byte *	data () const
Static Public Member Functions
static bool	compare (const OpcUa_ByteString &, const OpcUa_ByteString &)
static OpcUa_ByteString *	clone (const OpcUa_ByteString &source)
static void	cloneTo (const OpcUa_ByteString &source, OpcUa_ByteString &copy)
static char *	base64encode (const OpcUa_ByteString rawData)
static OpcUa_StatusCode	base64decode (const char *pBase64, UaByteString &rawData)

---

Detailed Description

Wrapper classs for the ua stack structure OpcUa_ByteString. Derived from OpcUa_ByteString.

---

Constructor & Destructor Documentation

UaByteString::UaByteString

(

)

construction

UaByteString::UaByteString

(

const UaByteString &

other

)

construction

Parameters:

other

the UaBytestring

UaByteString::UaByteString

(

const OpcUa_ByteString &

other

)

construction

Parameters:

other

the OpcUa_ByteString

UaByteString::UaByteString	(	OpcUa_Int32	iLength,
		OpcUa_Byte *	pData
	)

construction

Parameters:

	iLength	the length of the data.
	pData	a pointer to the data itself.

UaByteString::~UaByteString

(

)

destruction

---

Member Function Documentation

void UaByteString::clear

(

)

Clear the data of the UaByteString.

void UaByteString::setByteString	(	OpcUa_Int32	iLength,
		OpcUa_Byte *	pData
	)

Set ByteString data.

Parameters:

	iLength	the length of the data.
	pData	the actual used data.

UaByteString & UaByteString::operator=

(

const UaByteString &

other

)

Assignment operator.

Parameters:

other

the ByteString to assign.

Returns:

Assignment operator.

void UaByteString::operator<<

(

const UaByteString &

other

)

Appends the other bytestring. This method reallocated the internal memory as needed.

Parameters:

other

the ByteString to append.

bool UaByteString::operator==

(

const UaByteString &

other

)

const

Compare variables if they are similar.

Parameters:

other

the char to compare.

Returns:

true if not similar false if similar.

bool UaByteString::operator!=

(

const UaByteString &

other

)

const

Returns true if other is not equal to this.

See also:

operator==

Parameters:

other

the UaString to compare.

Returns:

true if other is not equal to this.

bool UaByteString::compare	(	const OpcUa_ByteString &	data1,
		const OpcUa_ByteString &	data2
	)			[static]

Compare two UaByteString variables.

Parameters:

	data1	a value as UaByteString.
	data2	a value as UaByteString.

Returns:

true if equal false if not.

UaByteString::operator const OpcUa_ByteString *

(

)

const

Return internal OpcUa_ByteString structure.

Returns:

internal OpcUa_ByteString structure.

OpcUa_ByteString * UaByteString::copy

(

)

const

Copy UaByteString data to a newly allocated OpcUa_ByteString.

Returns:

a newly allocated OpcUa_ByteString.

void UaByteString::copyTo

(

OpcUa_ByteString *

pDst

)

const

Copy UaByteString data to an exisitng OpcUa_ByteString structure.

Parameters:

pDst

the destination of the copyoperation.

OpcUa_ByteString * UaByteString::clone

(

const OpcUa_ByteString &

source

)

[static]

Copy OpcUa_ByteString data to a newly allocated OpcUa_ByteString.

Parameters:

source

the source of this operation.

Returns:

a newly allocated OpcUa_ByteString.

void UaByteString::cloneTo	(	const OpcUa_ByteString &	source,
		OpcUa_ByteString &	copy
	)			[static]

Copy OpcUa_ByteString data to an exisitng OpcUa_ByteString structure.

Parameters:

	source	Source OpcUa_ByteString to clone.
	copy	New copy of source OpcUa_ByteString.

void UaByteString::detach

(

)

Detach internal structure from data. A caller must take ownership of the internal memory before calling detach.

void UaByteString::attach

(

const OpcUa_ByteString *

pSrc

)

Attach the internal byte string data of the passed byte string to the own byte string.

Parameters:

vVal

a value as OpcUa_Variant.

OpcUa_Int32 UaByteString::length

(

)

const [inline]

Get the length of the var.

Returns:

the length of the var.

const OpcUa_Byte* UaByteString::data

(

)

const [inline]

Get the data of the actual variable.

Returns:

the data of the actual variable.

char * UaByteString::base64encode

(

const OpcUa_ByteString

rawData

)

[static]

This method encodes the passed ByteString into a BASE64 encoded string.

Parameters:

rawData

ByteString to encode

Returns:

Returns the encoded string. Must be deleted with delete[].

OpcUa_StatusCode UaByteString::base64decode	(	const char *	pBase64,
		UaByteString &	rawData
	)			[static]

This method decodes a BASE64 encoded string and returns the decoded data.

Parameters:

	pBase64	[in] The BASE64 string
	rawData	[out] The decoded raw data

Returns:

Returns the result code for the operation.

---

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

• src/uabase/uabasecpp/uabytestring.h
• src/uabase/uabasecpp/uabytestring.cpp