Property Class Reference

Creates and parses property values of different types. More...

Inheritance diagram for Property:

Collaboration diagram for Property:

Public Member Functions
	Property (void)
	Property (const char *data, int len)
	Property (const char *str)
	Property (int val, int len)
	Property (const ByteArray &ba)
	Property (const Property &prop)
virtual	~Property (void)
void	clear (void)
char *	getString (void)
void	setString (const char *str)
const Property &	operator= (const Property &prop)
Public Member Functions inherited from ByteArray
	ByteArray (void)
	ByteArray (int len)
	ByteArray (const char *data, int len)
	ByteArray (const char *str)
	ByteArray (int val, int len)
	ByteArray (const ByteArray &ba)
virtual	~ByteArray (void)
void	clear (void)
int	length (void) const
char *	get (void)
const char *	get (void) const
void	set (const char *data, int len)
void	append (const char *data, int len)
void	append (const ByteArray &ba)
void	insert (const char *data, int len, int offset)
void	fill (char value, int len, int offset)
int	getInt (int def_val=0) const
void	setInt (int val, int len)
void	appendInt (int val, int len)
void	getString (char *str, int max_size) const
void	setString (const char *str)
void	appendString (const char *str)
std::string	toString (void) const
std::string	toHexString (void) const
int	compare (const ByteArray &ba) const
ByteArray	sub (int offset, int len=-1) const
ByteArray	lstrip (void) const
ByteArray	rstrip (const std::set< char > &charsToBeStripped) const
void	read (const char *filename)
void	write (const char *filename) const
void	xtrace (const char *text=0) const
ByteArray &	operator= (const ByteArray &ba)
const ByteArray &	operator+= (const ByteArray &ba)
const ByteArray &	operator|= (const ByteArray &ba)
const ByteArray &	operator^= (const ByteArray &ba)
char &	operator[] (int idx)

Detailed Description

Creates and parses property values of different types.

The following example illustrates the usage of the Property class:

// set unicode string as key name property
wchar_t *name = L"Key Name";
int name_len = (wcslen(name) + 1) * 2;
 
Property prop = Property((char*)name, len);
 
PropertyList keyTemplate;
keyTemplate.set(CXI_PROP_KEY_NAME, prop);
 
// ...
 
printf("Name: %s", keyTemplate.getName());  // output: '{U}Key Name'

Constructor & Destructor Documentation

Property() [1/6]

Property

(

void

)

Default Constructor: creates empty property value.

Property() [2/6]

Property	(	const char *	data,
		int	len
	)

Overloaded Constructor: creates property value from given data.

Parameters

data	pointer to data to be set
len	length of data to be set

Property() [3/6]

Property

(

const char *

str

)

Overloaded Constructor: creates property value from given C-string.

Parameters

str	C-string to be set

Property() [4/6]

Property	(	int	val,
		int	len
	)

Overloaded Constructor: creates property value from given integer.

Parameters

val	integer to be set
len	number of bytes to be converted [1..4].

Property() [5/6]

Property

(

const ByteArray &

ba

)

Overloaded Constructor: creates property value from given byte array.

Parameters

ba	byte array to be set

Property() [6/6]

Property

(

const Property &

prop

)

Copy Constructor: create deep copy of property class

~Property()

~Property ( void  )

virtual

Destructor: frees internal resources

Member Function Documentation

clear()

void clear

(

void

)

Clears all internal resources

getString()

char * getString

(

void

)

Returns property string.

Returns

property value as zero terminated C-string

setString()

void setString

(

const char *

str

)

Sets given string as property value.

Parameters

str	string to be set [zero terminated C-string]

operator=()

const Property & operator=

(

const Property &

prop

)

Copies one instance of byte array to another.

Parameters

prop	source property