TPProto::ObjectDescription Class Reference

A description of object as sent as a Frame. More...

#include <objectdesc.h>

Inheritance diagram for TPProto::ObjectDescription:

List of all members.

Public Member Functions
	ObjectDescription ()
	Default constructor.
virtual	~ObjectDescription ()
	Destructor.
void	packBuffer (Buffer *buf)
	Pack into a Buffer, assert(0).
bool	unpackBuffer (Buffer *buf)
	Unpack this ObjectDescription from a Buffer.
uint32_t	getObjectType ()
	Gets the object type number of this object description.
std::string	getName ()
	Gets the name of this object description. /return The name of the object description.
std::string	getDescription ()
	Gets the text description of this object description. /return The text description of the object description.
std::list< ObjectParameterGroup * >	getParameterGroups ()
	Gets a copy of the ObjectParameterGroups in this object description.
uint64_t	getLastModifiedTime ()
	Returns the timestamp of the last time this object description was modified.

---

Detailed Description

A description of object as sent as a Frame.

---

Constructor & Destructor Documentation

TPProto::ObjectDescription::~ObjectDescription

(

)

[virtual]

Destructor.

Deletes the OrderParameters it contains.

---

Member Function Documentation

void TPProto::ObjectDescription::packBuffer

(

Buffer *

buf

)

[virtual]

Pack into a Buffer, assert(0).

This Frame is only received from the server and therefore does not get packed on the client side. assert(0) is called.

Parameters:

buf

The Buffer, ignored.

Implements TPProto::Frame.

bool TPProto::ObjectDescription::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack this ObjectDescription from a Buffer.

Parameters:

buf

The Buffer to unpack out of.

Returns:

True if successful.

Implements TPProto::Frame.

unsigned int TPProto::ObjectDescription::getObjectType

(

)

Gets the object type number of this object description.

Returns:

The object type number.

std::list< ObjectParameterGroup * > TPProto::ObjectDescription::getParameterGroups

(

)

Gets a copy of the ObjectParameterGroups in this object description.

Returns:

A copy of the list of ObjectParameterGroups.

uint64_t TPProto::ObjectDescription::getLastModifiedTime

(

)

Returns the timestamp of the last time this object description was modified.

Returns:

The timestamp of the modification time.

---

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

• tpproto/objectdesc.h
• tpproto/objectdesc.cpp

---