---

cluster::DataPacket Class Reference

#include <DataPacket.h>

Inheritance diagram for cluster::DataPacket:

[legend]Collaboration diagram for cluster::DataPacket:

[legend]List of all members.

Public Methods
	DataPacket ()
	Default constructor used by the PacketFactory. More...
	DataPacket (const vpr::GUID &plugin_id, const vpr::GUID &object_id, std::vector< vpr::Uint8 > *data)
	Create a DataPacket to send raw data accross the network. More...
virtual	~DataPacket ()
	Clean up all unused memory. More...
void	serialize ()
	Serializes member variables into a data stream. More...
virtual void	parse (vpr::BufferObjectReader *reader)
	Parses the data stream into the local member variables. More...
virtual void	printData (int debug_level)
	Print the data to the screen in a readable form. More...
vpr::GUID	getObjectId ()
	Return the GUID of the object that we are sending raw data for. More...
std::vector< vpr::Uint8 > *	getDeviceData ()
	Return a pointer to the raw data that we are sending across the network. More...
Static Public Methods
vpr::Uint16	getPacketFactoryType ()
	Return the type of this packet. More...

---

Constructor & Destructor Documentation

cluster::DataPacket::DataPacket (    )

Default constructor used by the PacketFactory. Definition at line 53 of file DataPacket.cpp. : mDeviceData(NULL) {;}

cluster::DataPacket::DataPacket (  const vpr::GUID &    plugin_id, const vpr::GUID &    object_id, std::vector< vpr::Uint8 > *    data )

Create a DataPacket to send raw data accross the network. Parameters: plugin_guid  -GUID of the ClusterPlugin that should handle this packet. id  -GUID of the object that we are acknowledging. data  -Pointer to the raw data that we want to send across the network Definition at line 56 of file DataPacket.cpp. References cluster::Packet::mHeader, cluster::Packet::mPluginId, and serialize. : mObjectId(object_id), mDeviceData(data) { mPluginId = plugin_id; // Create a Header for this packet with the correect type and size. mHeader = new Header(Header::RIM_PACKET, Header::RIM_DATA_PACKET, Header::RIM_PACKET_HEAD_SIZE + 16 /*Plugin GUID*/ + 16 /*Plugin GUID*/ + mDeviceData->size(), 0/*Field not curently used*/); // Serialize the given data. serialize(); }

virtual cluster::DataPacket::~DataPacket (    )  [inline, virtual]

Clean up all unused memory. Definition at line 66 of file DataPacket.h. { delete mDeviceData; }

---

Member Function Documentation

void cluster::DataPacket::serialize (    )

Serializes member variables into a data stream. Definition at line 73 of file DataPacket.cpp. References cluster::Packet::mHeader, cluster::Packet::mPacketWriter, and cluster::Packet::mPluginId. Referenced by DataPacket. { // Clear the data stream. mPacketWriter->getData()->clear(); mPacketWriter->setCurPos(0); // Serialize the header. mHeader->serializeHeader(); // Serialize plugin GUID. mPluginId.writeObject(mPacketWriter); // Serialize device GUID. mObjectId.writeObject(mPacketWriter); // mDeviceData is a pointer that points at the DeviceData located in the DeviceServer // this data will be updated every frame before sent. }

void cluster::DataPacket::parse (  vpr::BufferObjectReader *    reader )  [virtual]

Parses the data stream into the local member variables. Implements cluster::Packet. Definition at line 92 of file DataPacket.cpp. References cluster::Packet::mHeader, and cluster::Packet::mPluginId. { // De-Serialize plugin GUID mPluginId.readObject(reader); // De-Serialize plugin GUID mObjectId.readObject(reader); mDeviceData = new std::vector<vpr::Uint8>(); unsigned int data_size = mHeader->getPacketLength() - Header::RIM_PACKET_HEAD_SIZE - 32; for(unsigned int i = 0 ; i < data_size ; i++) { mDeviceData->push_back(*(reader->readRaw(1))); } }

void cluster::DataPacket::printData (  int    debug_level )  [virtual]

Print the data to the screen in a readable form. Implements cluster::Packet. Definition at line 109 of file DataPacket.cpp. { // NOTE: This should be removed if any of the below code ever puts // debug_level to use. boost::ignore_unused_variable_warning(debug_level); /* vprDEBUG_BEGIN(gadgetDBG_RIM,debug_level) << clrOutBOLD(clrYELLOW,"==== Device Data Packet ====\n") << vprDEBUG_FLUSH; Packet::printData(debug_level); vprDEBUG(gadgetDBG_RIM,debug_level) << clrOutBOLD(clrYELLOW, "Plugin ID: ") << mPluginId.toString() << std::endl << vprDEBUG_FLUSH; vprDEBUG(gadgetDBG_RIM,debug_level) << clrOutBOLD(clrYELLOW, "Object ID: ") << mObjectId.toString() << std::endl << vprDEBUG_FLUSH; vprDEBUG_END(gadgetDBG_RIM,debug_level) << clrOutBOLD(clrYELLOW,"============================\n") << vprDEBUG_FLUSH; */ }

vpr::Uint16 cluster::DataPacket::getPacketFactoryType (    )  [inline, static]

Return the type of this packet. Definition at line 89 of file DataPacket.h. { return(Header::RIM_DATA_PACKET); }

vpr::GUID cluster::DataPacket::getObjectId (    )  [inline]

Return the GUID of the object that we are sending raw data for. Definition at line 97 of file DataPacket.h. { return mObjectId; }

std::vector<vpr::Uint8>* cluster::DataPacket::getDeviceData (    )  [inline]

Return a pointer to the raw data that we are sending across the network. Definition at line 103 of file DataPacket.h. { return mDeviceData; }

---

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

• DataPacket.h
• DataPacket.cpp

---