sp2plib::VObject Class Reference

Virtual object for index server store More...

#include <VObject.h>

Public Member Functions
	VObject ()
	Initializes new instance of VObject object
	~VObject ()
	Destructor.
Guid	UID ()
	Gets unique identifier of virtual object
int	AllPropertiesCount ()
	Getas number of custom properties
::std::string	PropertyNameOnIndex (int Index)
	Getas name of property on (name,vale) pair located at index postion
void	RemoveProperty (std::string name)
	Removes property with name if exists
::std::string &	operator[] (::std::string Name)
	Array indexer operator for getting/setting object properties.
::std::string	getProperty (::std::string name)
	Gets property value by property name, value = getProperty("property_name") is equivalent to value = VObject["property_name"]
void	setProperty (::std::string name,::std::string value)
	Sets property value, setProperty("property_name",value) is equivalent to VObject["property_name"] = value
int	ParseFromBytes (unsigned char *buff, int startIndex=0)
	Initializes VObject object from byte array
sp2plib::UInt32	GetSerializationLength ()
	Gets number of bytes needed to store object
int	WriteToByteArray (unsigned char *buff, int startIndex=0)
	Wrtites VObject object bytes to byte array
unsigned char *	new_GetBytes (int *len)
	Gets VObject object bytes

Detailed Description

Virtual object for index server store

Constructor & Destructor Documentation

sp2plib::VObject::VObject

(

)

Initializes new instance of VObject object

sp2plib::VObject::~VObject

(

)

Destructor.

Member Function Documentation

int sp2plib::VObject::AllPropertiesCount

(

)

Getas number of custom properties

::std::string sp2plib::VObject::getProperty

(

::std::string

name

)

Gets property value by property name, value = getProperty("property_name") is equivalent to value = VObject["property_name"]

Parameters

name	Property name

Returns

Property value

sp2plib::UInt32 sp2plib::VObject::GetSerializationLength

(

)

Gets number of bytes needed to store object

Returns

Number of bytes

unsigned char* sp2plib::VObject::new_GetBytes

(

int *

len

)

Gets VObject object bytes

Parameters

len	Int variable to strore length value to</parm> Returns VObject object bytes

::std::string& sp2plib::VObject::operator[]

(

::std::string

Name

)

Array indexer operator for getting/setting object properties.

Parameters

Name	Property name

int sp2plib::VObject::ParseFromBytes	(	unsigned char *	buff,
		int	startIndex = 0
	)

Initializes VObject object from byte array

Parameters

buff	Buffer holding VObject bytes
startIndex	Start index from whict to start parsing

Returns

Number of bytes parsed

::std::string sp2plib::VObject::PropertyNameOnIndex

(

int

Index

)

Getas name of property on (name,vale) pair located at index postion

void sp2plib::VObject::RemoveProperty

(

std::string

name

)

Removes property with name if exists

Parameters

name	Property name

void sp2plib::VObject::setProperty	(	::std::string	name,
		::std::string	value
	)

Sets property value, setProperty("property_name",value) is equivalent to VObject["property_name"] = value

Parameters

name	Property name
value	Property value

Guid sp2plib::VObject::UID

(

)

Gets unique identifier of virtual object

Returns

VObject Uid

int sp2plib::VObject::WriteToByteArray	(	unsigned char *	buff,
		int	startIndex = 0
	)

Wrtites VObject object bytes to byte array

Parameters

buff	Buffer to store VObject object to
startIndex	Starting index from which to start writing

Returns

Number of butes writen

---

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

• sp2plib_to_doc/VObject.h