Phoenix Core Objects

Phoenix2D Core Objects
The following namespace contains the following objects
More...

Classes
class	Phoenix::Commands
	Commands The Commans lorem Ipsum More...
class	Phoenix::Connect
class	Phoenix::Controller
	Controller The Controller is the Main Manager of the Phoenix2D Player. It is composed of references to the Main Objects in the Library. The Controller is in charge of instantiation of the rest of the inner objects using the user's parameters. More...
class	Phoenix::Parser
	Parser The Parser lorem Ipsum More...
class	Phoenix::Reader
	Reader The Reader lorem Ipsum More...
class	Phoenix::Self
	Self The Self lorem Ipsum More...
class	Phoenix::Server
	Server The Server lorem Ipsum More...
class	Phoenix::World
	World The World lorem Ipsum More...

Functions
	Phoenix::Controller::Controller (const char *teamName, char agentType, const char *hostname)
	Default Constructor. More...
	Phoenix::Controller::~Controller ()
	Default Destructor. More...
void	Phoenix::Controller::connect ()
	The main connection, should be called before anything else in Phoenix2D. More...
bool	Phoenix::Controller::isConnected ()
void	Phoenix::Controller::reconnect ()
	Reconnection Logic. More...
void	Phoenix::Controller::disconnect ()
	Disconnect service. More...
Commands *	Phoenix::Controller::getCommands ()
	Commands getter. More...
World *	Phoenix::Controller::getWorld ()
	World getter. More...
Self *	Phoenix::Controller::getSelf ()
	Self getter. More...

Variables
static char	Phoenix::Controller::AGENT_TYPE = 'p'
	p = Player, t = Trainer More...
Parser *	Phoenix::Controller::parser
	Pointer to inner Parser Object. More...
Connect *	Phoenix::Controller::c
	Pointer to inner Connect Object. More...
Reader *	Phoenix::Controller::reader
	Pointer to inner Reader Object. More...
Server *	Phoenix::Controller::server
	Pointer to inner Server Object. More...
Commands *	Phoenix::Controller::commands
	Pointer to inner Commans Object. More...
World *	Phoenix::Controller::world
	Pointer to inner World Object. More...
Self *	Phoenix::Controller::self
	Pointer to inner Self Object. More...
bool	Phoenix::Controller::connected
	Connection status. More...
std::string	Phoenix::Controller::team_name
std::string	Phoenix::Controller::hostname

Detailed Description

Phoenix2D Core Objects
The following namespace contains the following objects

• Controller
• Connect
• Reader
• Server
• Parser
• Commands
• World
• Self

Function Documentation

void Phoenix::Controller::connect

(

)

The main connection, should be called before anything else in Phoenix2D.

Definition at line 60 of file Controller.cpp.

References Phoenix::Controller::AGENT_TYPE, Phoenix::Controller::c, Phoenix::Controller::connected, Phoenix::Controller::hostname, Phoenix::Controller::parser, Phoenix::Self::PLAYER_TYPES, Phoenix::Controller::reader, Phoenix::Connect::receiveMessage(), Phoenix::Connect::sendMessage(), Phoenix::Controller::server, Phoenix::Reader::start(), Phoenix::Controller::team_name, and Phoenix::Controller::world.

Here is the call graph for this function:

Phoenix::Controller::Controller	(	const char *	teamName,
		char	agentType,
		const char *	hostname
	)

Default Constructor.

Parameters

teamName	User Defined Team Name
agentType	see AGENT_TYPE
hostname	ip address or host

Definition at line 36 of file Controller.cpp.

References Phoenix::Controller::AGENT_TYPE, Phoenix::Controller::c, Phoenix::Controller::commands, Phoenix::Controller::connected, Phoenix::Controller::parser, Phoenix::Controller::reader, Phoenix::Controller::server, Phoenix::Controller::team_name, and Phoenix::Controller::world.

void Phoenix::Controller::disconnect

(

)

Disconnect service.

Definition at line 154 of file Controller.cpp.

References Phoenix::Controller::connected, Phoenix::Controller::isConnected(), Phoenix::Controller::reader, and Phoenix::Reader::stop().

Here is the call graph for this function:

Commands * Phoenix::Controller::getCommands

(

)

Commands getter.

Definition at line 161 of file Controller.cpp.

References Phoenix::Controller::c, and Phoenix::Controller::commands.

Self * Phoenix::Controller::getSelf

(

)

Self getter.

Definition at line 172 of file Controller.cpp.

World * Phoenix::Controller::getWorld

(

)

World getter.

Definition at line 168 of file Controller.cpp.

References Phoenix::Controller::world.

bool Phoenix::Controller::isConnected

(

)

Returns

Connection Status Getter

Definition at line 146 of file Controller.cpp.

References Phoenix::Controller::connected.

Referenced by Phoenix::Controller::disconnect().

void Phoenix::Controller::reconnect

(

)

Reconnection Logic.

Todo:

Define Method

Definition at line 150 of file Controller.cpp.

Phoenix::Controller::~Controller

(

)

Default Destructor.

Definition at line 50 of file Controller.cpp.

References Phoenix::Controller::c, Phoenix::Controller::commands, Phoenix::Controller::parser, Phoenix::Controller::reader, Phoenix::Controller::server, and Phoenix::Controller::world.

Variable Documentation

char Phoenix::Controller::AGENT_TYPE = 'p'

static

p = Player, t = Trainer

Definition at line 78 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), Phoenix::Logger::log(), and Phoenix::Player::Player().

Connect* Phoenix::Controller::c

private

Pointer to inner Connect Object.

Definition at line 112 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), Phoenix::Controller::getCommands(), and Phoenix::Controller::~Controller().

Commands* Phoenix::Controller::commands

private

Pointer to inner Commans Object.

Definition at line 115 of file Controller.h.

Referenced by Phoenix::Controller::Controller(), Phoenix::Controller::getCommands(), and Phoenix::Controller::~Controller().

bool Phoenix::Controller::connected

private

Connection status.

Definition at line 118 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), Phoenix::Controller::disconnect(), and Phoenix::Controller::isConnected().

std::string Phoenix::Controller::hostname

private

Definition at line 120 of file Controller.h.

Referenced by Phoenix::Controller::connect().

Parser* Phoenix::Controller::parser

private

Pointer to inner Parser Object.

Definition at line 111 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), and Phoenix::Controller::~Controller().

Reader* Phoenix::Controller::reader

private

Pointer to inner Reader Object.

Definition at line 113 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), Phoenix::Controller::disconnect(), and Phoenix::Controller::~Controller().

Self* Phoenix::Controller::self

private

Pointer to inner Self Object.

Definition at line 117 of file Controller.h.

Server* Phoenix::Controller::server

private

Pointer to inner Server Object.

Definition at line 114 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), and Phoenix::Controller::~Controller().

std::string Phoenix::Controller::team_name

private

Definition at line 119 of file Controller.h.

Referenced by Phoenix::Controller::connect(), and Phoenix::Controller::Controller().

World* Phoenix::Controller::world

private

Pointer to inner World Object.

Definition at line 116 of file Controller.h.

Referenced by Phoenix::Controller::connect(), Phoenix::Controller::Controller(), Phoenix::Controller::getWorld(), and Phoenix::Controller::~Controller().