TPProto::CommandDescription Class Reference

A description of a command. More...

#include <commanddesc.h>

Inheritance diagram for TPProto::CommandDescription:

List of all members.

Public Member Functions
	CommandDescription ()
	Default constructor.
virtual	~CommandDescription ()
	Destructor.
void	packBuffer (Buffer *buf)
	Pack into a Buffer, assert(0).
bool	unpackBuffer (Buffer *buf)
	Unpack this CommandDescription from a Buffer.
unsigned int	getCommandType ()
	Gets the command type number of this command description.
std::string	getName ()
	Gets the name of this command description.
std::string	getDescription ()
	Gets the text description of this command description.
std::list< CommandParameter * >	getParameters ()
	Gets a copy of the CommandParameters in this command description.
uint64_t	getLastModifiedTime ()
	Returns the timestamp of the last time this order description was modified.

---

Detailed Description

A description of a command.

---

Constructor & Destructor Documentation

TPProto::CommandDescription::~CommandDescription

(

)

[virtual]

Destructor.

Deletes the CommandParameters it contains.

---

Member Function Documentation

void TPProto::CommandDescription::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::CommandDescription::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack this CommandDescription from a Buffer.

Parameters:

buf

The Buffer to unpack out of.

Returns:

True if successful.

Implements TPProto::Frame.

unsigned int TPProto::CommandDescription::getCommandType

(

)

Gets the command type number of this command description.

Returns:

The command type number.

std::string TPProto::CommandDescription::getName

(

)

Gets the name of this command description.

Returns:

The name of the command description.

std::string TPProto::CommandDescription::getDescription

(

)

Gets the text description of this command description.

Returns:

The text description of the command description.

std::list< CommandParameter * > TPProto::CommandDescription::getParameters

(

)

Gets a copy of the CommandParameters in this command description.

Returns:

A copy of the list of CommandParameters.

uint64_t TPProto::CommandDescription::getLastModifiedTime

(

)

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

Returns:

The timestamp of the modification time.

---

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

• tpproto/commanddesc.h
• tpproto/commanddesc.cpp

---