TPProto::OrderDescription Class Reference

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

#include <orderdesc.h>

Inheritance diagram for TPProto::OrderDescription:

TPProto::Frame List of all members.

Public Member Functions

 OrderDescription ()
 Default constructor.
virtual ~OrderDescription ()
 Destructor.
void packBuffer (Buffer *buf)
 Pack into a Buffer, assert(0).
bool unpackBuffer (Buffer *buf)
 Unpack this OrderDescription from a Buffer.
unsigned int getOrderType ()
 Gets the order type number of this order description.
std::string getName ()
 Gets the name of this order description. /return The name of the order description.
std::string getDescription ()
 Gets the text description of this order description. /return The text description of the order description.
std::list< OrderParameter * > getParameters ()
 Gets a copy of the OrderParameters in this order description.
uint64_t getLastModifiedTime ()
 Returns the timestamp of the last time this order description was modified.

Detailed Description

A description of orders as sent as a Frame.


Constructor & Destructor Documentation

TPProto::OrderDescription::~OrderDescription (  )  [virtual]

Destructor.

Deletes the OrderParameters it contains.


Member Function Documentation

void TPProto::OrderDescription::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::OrderDescription::unpackBuffer ( Buffer buf  )  [virtual]

Unpack this OrderDescription from a Buffer.

Parameters:
buf The Buffer to unpack out of.
Returns:
True if successful.

Implements TPProto::Frame.

unsigned int TPProto::OrderDescription::getOrderType (  ) 

Gets the order type number of this order description.

Returns:
The order type number.

std::list< OrderParameter * > TPProto::OrderDescription::getParameters (  ) 

Gets a copy of the OrderParameters in this order description.

Returns:
A copy of the list of OrderParameters.

uint64_t TPProto::OrderDescription::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:
Generated on Tue Jan 6 08:15:48 2009 for libtpproto-cpp by  doxygen 1.5.1