TPProto::FrameFactory Class Reference

FrameFactory baseclass. More...

#include <framefactory.h>

List of all members.

Public Member Functions
	FrameFactory ()
	Constructs object and sets up defaults.
virtual	~FrameFactory ()
	Require virtual destructor.
void	setProtocolVersion (int ver)
	Sets the protocol version the frames should have.
int	getProtocolVersion () const
	Gets the protocol version.
void	setProtocolLayer (ProtocolLayer *pl)
	Sets the ProtocolLayer.
virtual OkFrame *	createOk ()
	Creates an OkFrame.
virtual FailFrame *	createFail ()
	Creates a FailFrame.
virtual Sequence *	createSequence ()
	Creates a Sequence Frame.
virtual Connect *	createConnect ()
	Creates a Connect Frame.
virtual AccountCreate *	createAccountCreate ()
	Creates an AccountCreate Frame.
virtual Login *	createLogin ()
	Creates a Login Frame.
virtual Redirect *	createRedirect ()
	Creates a Redirect Frame.
virtual GetFeatures *	createGetFeatures ()
	Creates a GetFeatures Frame.
virtual Features *	createFeatures ()
	Creates a Features Frame.
virtual SetFilters *	createSetFilters ()
	Creates a Set Filters Frame.
virtual GetGameInfo *	createGetGameInfo ()
	Creates a Get Game Info Frame.
virtual GameInfo *	createGameInfo ()
	Creates a Game Info Frame.
virtual Ping *	createPing ()
	Creates a Ping Frame.
virtual FinishedFrame *	createFinished ()
	Creates a Finished Turn Frame.
virtual GetObjectTypesList *	createGetObjectTypesList ()
	Creates a Get Object Types List Frame.
virtual ObjectTypesList *	createObjectTypesList ()
	Creates an Object Types List Frame.
virtual GetObjectDescription *	createGetObjectDescription ()
	Creates a Get Object Description Frame.
virtual ObjectDescription *	createObjectDescription ()
	Creates an Object Description Frame.
virtual Object *	createObject ()
	Creates an Object Frame.
virtual GetObjectById *	createGetObjectById ()
	Creates a GetObjectById Frame.
virtual GetObjectByPos *	createGetObjectByPos ()
	Creates a GetObjectByPos Frame.
virtual GetObjectIdsList *	createGetObjectIdsList ()
	Creates a GetObjectIdsList Frame.
virtual GetObjectIdsByPos *	createGetObjectIdsByPos ()
	Creates a GetObjectIdsByPos Frame.
virtual GetObjectIdsByContainer *	createGetObjectIdsByContainer ()
	Creates a GetObjectIdsByContainer Frame.
virtual ObjectIdsList *	createObjectIdsList ()
	Creates an ObjectIdsList Frame.
virtual GetOrderDescription *	createGetOrderDescription ()
	Creates a GetOrderDescription Frame.
virtual OrderDescription *	createOrderDescription ()
	Creates an OrderDescription Frame.
virtual GetOrderTypesList *	createGetOrderTypesList ()
	Creates a GetOrderTypesList Frame.
virtual OrderTypesList *	createOrderTypesList ()
	Creates an OrderTypesList Frame.
virtual GetOrder *	createGetOrder ()
	Creates a GetOrder Frame.
virtual Order *	createOrder ()
	Creates an Order Frame.
virtual Order *	createInsertOrder ()
	Creates an InsertOrder Frame.
virtual RemoveOrder *	createRemoveOrder ()
	Creates a RemoveOrder Frame.
virtual ProbeOrder *	createProbeOrder ()
	Creates a ProbeOrder Frame.
virtual GetTime *	createGetTimeRemaining ()
	Creates a GetTimeRemaining Frame.
virtual TimeRemaining *	createTimeRemaining ()
	Creates a TimeRemaining Frame.
virtual GetBoard *	createGetBoard ()
	Creates a GetBoard Frame.
virtual Board *	createBoard ()
	Creates a Board Frame.
virtual GetBoardIdsList *	createGetBoardIdsList ()
	Creates a GetBoardIdsList Frame.
virtual BoardIdsList *	createBoardIdsList ()
	Creates a BoardIdsList Frame.
virtual GetMessage *	createGetMessage ()
	Creates a GetMessage Frame.
virtual Message *	createMessage ()
	Creates a Message Frame.
virtual Message *	createPostMessage ()
	Creates a PostMessage Frame.
virtual RemoveMessage *	createRemoveMessage ()
	Creates a RemoveMessage Frame.
virtual GetResourceDescription *	createGetResourceDescription ()
	Creates a GetResoureceDescription Frame.
virtual ResourceDescription *	createResourceDescription ()
	Creates a ResourceDescription Frame.
virtual GetResourceTypesList *	createGetResourceTypesList ()
	Creates a GetResourceTypesList Frame.
virtual ResourceTypesList *	createResourceTypesList ()
	Creates a ResourceTypesList Frame.
virtual GetPlayer *	createGetPlayer ()
	Creates a GetPlayer Frame.
virtual Player *	createPlayer ()
	Creates a Player Frame.
virtual GetCategory *	createGetCategory ()
	Creates a GetCategory Frame.
virtual Category *	createCategory ()
	Creates a Category Frame.
virtual AddCategory *	createAddCategory ()
	Creates an AddCategory Frame.
virtual RemoveCategory *	createRemoveCategory ()
	Creates a RemoveCategory Frame.
virtual GetCategoryIdsList *	createGetCategoryIdsList ()
	Creates a GetCategoryIdsList Frame.
virtual CategoryIdsList *	createCategoryIdsList ()
	Creates a CategoryIdsList Frame.
virtual GetDesign *	createGetDesign ()
	Creates a GetDesign Frame.
virtual Design *	createDesign ()
	Creates a Design Frame.
virtual AddDesign *	createAddDesign ()
	Creates an AddDesign Frame.
virtual ModifyDesign *	createModifyDesign ()
	Creates a ModifyDesign Frame.
virtual RemoveDesign *	createRemoveDesign ()
	Creates a RemoveDesign Frame.
virtual GetDesignIdsList *	createGetDesignIdsList ()
	Creates a GetDesignIdsList Frame.
virtual DesignIdsList *	createDesignIdsList ()
	Creates a DesignIdsList Frame.
virtual GetComponent *	createGetComponent ()
	Creates a GetComponent Frame.
virtual Component *	createComponent ()
	Creates a Component Frame.
virtual GetComponentIdsList *	createGetComponentIdsList ()
	Creates a GetComponentIdsList Frame.
virtual ComponentIdsList *	createComponentIdsList ()
	Creates a ComponentIdsList Frame.
virtual GetProperty *	createGetProperty ()
	Creates a GetProperty Frame.
virtual Property *	createProperty ()
	Creates a Property Frame.
virtual GetPropertyIdsList *	createGetPropertyIdsList ()
	Creates a GetPropertyIdsList Frame.
virtual PropertyIdsList *	createPropertyIdsList ()
	Creates a PropertyIdsList Frame.
virtual LogMessage *	createLogMessage ()
	Creates a LogMessage Frame.
virtual GetCommandDescription *	createGetCommandDescription ()
	Creates a GetCommandDescription Frame.
virtual CommandDescription *	createCommandDescription ()
	Creates a CommandDescription Frame.
virtual GetCommandTypesList *	createGetCommandTypesList ()
	Creates a GetCommandTypesList Frame.
virtual CommandTypesList *	createCommandTypesList ()
	Creates a CommandTypesList Frame.
virtual Command *	createCommand ()
	Creates a Command Frame.
virtual CommandResult *	createCommandResult ()
	Creates a CommandResult Frame.
Protected Attributes
int	pver
	The Protocol Version to make frames for.
ProtocolLayer *	layer
	The ProtocolLayer this FrameFactory is part of.

---

Detailed Description

FrameFactory baseclass.

The FrameFactory creates frames of different types according to the parameters and the method called. Subclass this class if you want to create driviates of the various types of frames.

---

Constructor & Destructor Documentation

TPProto::FrameFactory::FrameFactory

(

)

Constructs object and sets up defaults.

Defaults are

• version 4 of the protocol

---

Member Function Documentation

void TPProto::FrameFactory::setProtocolVersion

(

int

pv

)

Sets the protocol version the frames should have.

Parameters:

pv

The protocol version number.

int TPProto::FrameFactory::getProtocolVersion

(

)

const

Gets the protocol version.

Returns:

The protocol version number.

void TPProto::FrameFactory::setProtocolLayer

(

ProtocolLayer *

pl

)

Sets the ProtocolLayer.

This method sets the ProtocolLayer.

Parameters:

pl

The ProtocolLayer to use.

OkFrame * TPProto::FrameFactory::createOk

(

)

[virtual]

Creates an OkFrame.

Returns:

A new OkFrame.

FailFrame * TPProto::FrameFactory::createFail

(

)

[virtual]

Creates a FailFrame.

Returns:

A new FailFrame.

Sequence * TPProto::FrameFactory::createSequence

(

)

[virtual]

Creates a Sequence Frame.

Returns:

A new Sequence Frame.

Connect * TPProto::FrameFactory::createConnect

(

)

[virtual]

Creates a Connect Frame.

Returns:

A new Connect Frame.

AccountCreate * TPProto::FrameFactory::createAccountCreate

(

)

[virtual]

Creates an AccountCreate Frame.

Returns:

A new AccountCreate Frame.

Login * TPProto::FrameFactory::createLogin

(

)

[virtual]

Creates a Login Frame.

Returns:

A new Login Frame.

Redirect * TPProto::FrameFactory::createRedirect

(

)

[virtual]

Creates a Redirect Frame.

Returns:

A new Redirect Frame.

GetFeatures * TPProto::FrameFactory::createGetFeatures

(

)

[virtual]

Creates a GetFeatures Frame.

Returns:

A new GetFeatures Frame.

Features * TPProto::FrameFactory::createFeatures

(

)

[virtual]

Creates a Features Frame.

Returns:

A new Features Frame.

SetFilters * TPProto::FrameFactory::createSetFilters

(

)

[virtual]

Creates a Set Filters Frame.

Returns:

A new Set Filters Frame.

GetGameInfo * TPProto::FrameFactory::createGetGameInfo

(

)

[virtual]

Creates a Get Game Info Frame.

Returns:

A new Get Game Info Frame.

GameInfo * TPProto::FrameFactory::createGameInfo

(

)

[virtual]

Creates a Game Info Frame.

Returns:

A new Game Info Frame.

Ping * TPProto::FrameFactory::createPing

(

)

[virtual]

Creates a Ping Frame.

Returns:

A new Ping Frame.

FinishedFrame * TPProto::FrameFactory::createFinished

(

)

[virtual]

Creates a Finished Turn Frame.

Returns:

A new Finished Turn Frame.

GetObjectTypesList * TPProto::FrameFactory::createGetObjectTypesList

(

)

[virtual]

Creates a Get Object Types List Frame.

Returns:

A new Get Object Types List Frame.

ObjectTypesList * TPProto::FrameFactory::createObjectTypesList

(

)

[virtual]

Creates an Object Types List Frame.

Returns:

A new Object Types List Frame.

GetObjectDescription * TPProto::FrameFactory::createGetObjectDescription

(

)

[virtual]

Creates a Get Object Description Frame.

Returns:

A new Get Object Description Frame.

ObjectDescription * TPProto::FrameFactory::createObjectDescription

(

)

[virtual]

Creates an Object Description Frame.

Returns:

A new Object Description Frame.

Object * TPProto::FrameFactory::createObject

(

)

[virtual]

Creates an Object Frame.

Returns:

A new Object Frame.

GetObjectById * TPProto::FrameFactory::createGetObjectById

(

)

[virtual]

Creates a GetObjectById Frame.

Returns:

A new GetObjectById Frame.

GetObjectByPos * TPProto::FrameFactory::createGetObjectByPos

(

)

[virtual]

Creates a GetObjectByPos Frame.

Returns:

A new GetObjectByPos Frame.

GetObjectIdsList * TPProto::FrameFactory::createGetObjectIdsList

(

)

[virtual]

Creates a GetObjectIdsList Frame.

Returns:

A new GetObjectIdsList Frame.

GetObjectIdsByPos * TPProto::FrameFactory::createGetObjectIdsByPos

(

)

[virtual]

Creates a GetObjectIdsByPos Frame.

Returns:

A new GetObjectIdsByPos Frame.

GetObjectIdsByContainer * TPProto::FrameFactory::createGetObjectIdsByContainer

(

)

[virtual]

Creates a GetObjectIdsByContainer Frame.

Returns:

A new GetObjectIdsByContainer Frame.

ObjectIdsList * TPProto::FrameFactory::createObjectIdsList

(

)

[virtual]

Creates an ObjectIdsList Frame.

Returns:

A new ObjectIdsList Frame.

GetOrderDescription * TPProto::FrameFactory::createGetOrderDescription

(

)

[virtual]

Creates a GetOrderDescription Frame.

Returns:

A new GetOrderDescription Frame.

OrderDescription * TPProto::FrameFactory::createOrderDescription

(

)

[virtual]

Creates an OrderDescription Frame.

Returns:

A new OrderDescription Frame.

GetOrderTypesList * TPProto::FrameFactory::createGetOrderTypesList

(

)

[virtual]

Creates a GetOrderTypesList Frame.

Returns:

A new GetOrderTypesList Frame.

OrderTypesList * TPProto::FrameFactory::createOrderTypesList

(

)

[virtual]

Creates an OrderTypesList Frame.

Returns:

A new OrderTypesList Frame.

GetOrder * TPProto::FrameFactory::createGetOrder

(

)

[virtual]

Creates a GetOrder Frame.

Returns:

A new GetOrder Frame.

Order * TPProto::FrameFactory::createOrder

(

)

[virtual]

Creates an Order Frame.

Returns:

A new Order Frame.

Order * TPProto::FrameFactory::createInsertOrder

(

)

[virtual]

Creates an InsertOrder Frame.

Returns:

A new InsertOrder Frame.

RemoveOrder * TPProto::FrameFactory::createRemoveOrder

(

)

[virtual]

Creates a RemoveOrder Frame.

Returns:

A new RemoveOrder Frame.

ProbeOrder * TPProto::FrameFactory::createProbeOrder

(

)

[virtual]

Creates a ProbeOrder Frame.

Returns:

A new ProbeOrder Frame.

GetTime * TPProto::FrameFactory::createGetTimeRemaining

(

)

[virtual]

Creates a GetTimeRemaining Frame.

Returns:

A new GetTimeRemaining Frame.

TimeRemaining * TPProto::FrameFactory::createTimeRemaining

(

)

[virtual]

Creates a TimeRemaining Frame.

Returns:

A new TimeRemaining Frame.

GetBoard * TPProto::FrameFactory::createGetBoard

(

)

[virtual]

Creates a GetBoard Frame.

Returns:

A new GetBoard Frame.

Board * TPProto::FrameFactory::createBoard

(

)

[virtual]

Creates a Board Frame.

Returns:

A new Board Frame.

GetBoardIdsList * TPProto::FrameFactory::createGetBoardIdsList

(

)

[virtual]

Creates a GetBoardIdsList Frame.

Returns:

A new GetBoardIdsList Frame.

BoardIdsList * TPProto::FrameFactory::createBoardIdsList

(

)

[virtual]

Creates a BoardIdsList Frame.

Returns:

A new BoardIdsList Frame.

GetMessage * TPProto::FrameFactory::createGetMessage

(

)

[virtual]

Creates a GetMessage Frame.

Returns:

A new GetMessage Frame.

Message * TPProto::FrameFactory::createMessage

(

)

[virtual]

Creates a Message Frame.

Returns:

A new Message Frame.

Message * TPProto::FrameFactory::createPostMessage

(

)

[virtual]

Creates a PostMessage Frame.

Returns:

A new PostMessage Frame.

RemoveMessage * TPProto::FrameFactory::createRemoveMessage

(

)

[virtual]

Creates a RemoveMessage Frame.

Returns:

A new RemoveMessage Frame.

GetResourceDescription * TPProto::FrameFactory::createGetResourceDescription

(

)

[virtual]

Creates a GetResoureceDescription Frame.

Returns:

A new GetResourceDescription Frame.

ResourceDescription * TPProto::FrameFactory::createResourceDescription

(

)

[virtual]

Creates a ResourceDescription Frame.

Returns:

A new ResourceDescription Frame.

GetResourceTypesList * TPProto::FrameFactory::createGetResourceTypesList

(

)

[virtual]

Creates a GetResourceTypesList Frame.

Returns:

A new GetResourceTypesList Frame.

ResourceTypesList * TPProto::FrameFactory::createResourceTypesList

(

)

[virtual]

Creates a ResourceTypesList Frame.

Returns:

A new ResourceTypesList Frame.

GetPlayer * TPProto::FrameFactory::createGetPlayer

(

)

[virtual]

Creates a GetPlayer Frame.

Returns:

A new GetPlayer Frame.

Player * TPProto::FrameFactory::createPlayer

(

)

[virtual]

Creates a Player Frame.

Returns:

A new Player Frame.

GetCategory * TPProto::FrameFactory::createGetCategory

(

)

[virtual]

Creates a GetCategory Frame.

Returns:

A new GetCategory Frame.

Category * TPProto::FrameFactory::createCategory

(

)

[virtual]

Creates a Category Frame.

Returns:

A new Category Frame.

AddCategory * TPProto::FrameFactory::createAddCategory

(

)

[virtual]

Creates an AddCategory Frame.

Returns:

A new AddCategory Frame.

RemoveCategory * TPProto::FrameFactory::createRemoveCategory

(

)

[virtual]

Creates a RemoveCategory Frame.

Returns:

A new RemoveCategory Frame.

GetCategoryIdsList * TPProto::FrameFactory::createGetCategoryIdsList

(

)

[virtual]

Creates a GetCategoryIdsList Frame.

Returns:

A new GetCategoryIdsList Frame.

CategoryIdsList * TPProto::FrameFactory::createCategoryIdsList

(

)

[virtual]

Creates a CategoryIdsList Frame.

Returns:

A new CategoryIdsList Frame.

GetDesign * TPProto::FrameFactory::createGetDesign

(

)

[virtual]

Creates a GetDesign Frame.

Returns:

A new GetDesign Frame.

Design * TPProto::FrameFactory::createDesign

(

)

[virtual]

Creates a Design Frame.

Returns:

A new Design Frame.

AddDesign * TPProto::FrameFactory::createAddDesign

(

)

[virtual]

Creates an AddDesign Frame.

Returns:

A new AddDesign Frame.

ModifyDesign * TPProto::FrameFactory::createModifyDesign

(

)

[virtual]

Creates a ModifyDesign Frame.

Returns:

A new ModifyDesign Frame.

RemoveDesign * TPProto::FrameFactory::createRemoveDesign

(

)

[virtual]

Creates a RemoveDesign Frame.

Returns:

A new RemoveDesign Frame.

GetDesignIdsList * TPProto::FrameFactory::createGetDesignIdsList

(

)

[virtual]

Creates a GetDesignIdsList Frame.

Returns:

A new GetDesignIdsList Frame.

DesignIdsList * TPProto::FrameFactory::createDesignIdsList

(

)

[virtual]

Creates a DesignIdsList Frame.

Returns:

A new DesignIdsList Frame.

GetComponent * TPProto::FrameFactory::createGetComponent

(

)

[virtual]

Creates a GetComponent Frame.

Returns:

A new GetComponent Frame.

Component * TPProto::FrameFactory::createComponent

(

)

[virtual]

Creates a Component Frame.

Returns:

A new Component Frame.

GetComponentIdsList * TPProto::FrameFactory::createGetComponentIdsList

(

)

[virtual]

Creates a GetComponentIdsList Frame.

Returns:

A new GetCompenentIdsList Frame.

ComponentIdsList * TPProto::FrameFactory::createComponentIdsList

(

)

[virtual]

Creates a ComponentIdsList Frame.

Returns:

A new ComponentIdsList Frame.

GetProperty * TPProto::FrameFactory::createGetProperty

(

)

[virtual]

Creates a GetProperty Frame.

Returns:

A new GetProperty Frame.

Property * TPProto::FrameFactory::createProperty

(

)

[virtual]

Creates a Property Frame.

Returns:

A new Property Frame.

GetPropertyIdsList * TPProto::FrameFactory::createGetPropertyIdsList

(

)

[virtual]

Creates a GetPropertyIdsList Frame.

Returns:

A new GetPropertyIdsList Frame.

PropertyIdsList * TPProto::FrameFactory::createPropertyIdsList

(

)

[virtual]

Creates a PropertyIdsList Frame.

Returns:

A new PropertyIdsList Frame.

LogMessage * TPProto::FrameFactory::createLogMessage

(

)

[virtual]

Creates a LogMessage Frame.

Returns:

A new LogMessage Frame.

GetCommandDescription * TPProto::FrameFactory::createGetCommandDescription

(

)

[virtual]

Creates a GetCommandDescription Frame.

Returns:

A new GetCommandDescription Frame.

CommandDescription * TPProto::FrameFactory::createCommandDescription

(

)

[virtual]

Creates a CommandDescription Frame.

Returns:

A new CommandDescription Frame.

GetCommandTypesList * TPProto::FrameFactory::createGetCommandTypesList

(

)

[virtual]

Creates a GetCommandTypesList Frame.

Returns:

A new GetCommandTypesList Frame.

CommandTypesList * TPProto::FrameFactory::createCommandTypesList

(

)

[virtual]

Creates a CommandTypesList Frame.

Returns:

A new CommandTypesList Frame.

Comm