TPProto::Board Class Reference

Board Frame class. More...

#include <board.h>

Inheritance diagram for TPProto::Board:

TPProto::Frame List of all members.

Public Member Functions

 Board ()
 Default Constructor.
virtual ~Board ()
 Virtual destructor as required.
void packBuffer (Buffer *buf)
 Packs the board into a buffer.
bool unpackBuffer (Buffer *buf)
 Unpacks a board from a buffer.
unsigned int getId ()
 Gets the board's id number.
std::string getName ()
 Gets the board's name.
std::string getDescription ()
 Gets the board's description.
int numMessages ()
 Get the number of messages on the board.
uint64_t getLastModifiedTime ()
 Gets the last time this board was modified.

Detailed Description

Board Frame class.

The Board class is the representation of the board Frame, and provides an interface to the boards.


Member Function Documentation

void TPProto::Board::packBuffer ( Buffer buf  )  [virtual]

Packs the board into a buffer.

Currently assets(0). Should not be used, sending boards to the server is not needed at this time.

Parameters:
buf The buffer to pack into.

Implements TPProto::Frame.

bool TPProto::Board::unpackBuffer ( Buffer buf  )  [virtual]

Unpacks a board from a buffer.

Unpacks a buffer, setting the values given by the server.

Parameters:
buf The buffer to unpack from.
Returns:
True if successful.

Implements TPProto::Frame.

unsigned int TPProto::Board::getId (  ) 

Gets the board's id number.

Returns:
The Board ID number.

std::string TPProto::Board::getName (  ) 

Gets the board's name.

Returns:
The board's name.

std::string TPProto::Board::getDescription (  ) 

Gets the board's description.

Returns:
The board's description.

int TPProto::Board::numMessages (  ) 

Get the number of messages on the board.

The id of the messages are 0 to numMessages() - 1.

Returns:
The number of messages.

uint64_t TPProto::Board::getLastModifiedTime (  ) 

Gets the last time this board was modified.

Returns:
The timestamp of the last modification time.


The documentation for this class was generated from the following files:
Generated on Tue Jan 6 08:00:47 2009 for libtpproto-cpp by  doxygen 1.5.1