rcsc::DebugClient Class Reference

Debug Server Interface class. More...

#include <debug_client.h>

Public Member Functions
	DebugClient ()
	init and/or reserve member variables
	~DebugClient ()
	close connection and files.
void	connect (const std::string &hostname, const int port)
	connect to the debug server More...
bool	open (const std::string &log_dir, const std::string &teamname, const int unum)
	open debug server message log file. More...
void	writeAll (const WorldModel &world, const ActionEffector &effector)
	output to stream or socket More...
void	clear ()
	clear all data
void	addMessage (const char *msg,...)
	add formatted string to buffer More...
void	addMessage (const std::string &msg)
	add message string to buffer More...
void	addSelfComment (const char *msg,...)
	add formatred message for self More...
void	addComment (const PlayerObject *player, const char *msg,...)
	add formatred message for the player More...
void	setTarget (const int unum)
	set target player More...
void	setTarget (const Vector2D &p)
	set target point More...
void	addLine (const Vector2D &from, const Vector2D &to, const char *color="")
	set line info to be drawn More...
void	addTriangle (const Vector2D &v1, const Vector2D &v2, const Vector2D &v3, const char *color="")
	set triangle info to be drawn More...
void	addTriangle (const Triangle2D &tri, const char *color="")
	set triangle info to be drawn More...
void	addRectangle (const Rect2D &rect, const char *color="")
	set rectangle info to be drawn More...
void	addCircle (const Vector2D &center, const double &radius, const char *color="")
	set circle info to be drawn More...
void	addCircle (const Circle2D &circle, const char *color="")
	set circle info to be drawn More...

Static Public Attributes
static const std::size_t	MAX_LINE = 50
	maximum number of lines in one message.
static const std::size_t	MAX_TRIANGLE = 50
	maximum number of triangles in one message.
static const std::size_t	MAX_RECT = 50
	maximum number of rectangles in one message.
static const std::size_t	MAX_CIRCLE = 50
	maximum number of circles in one message.

Detailed Description

Debug Server Interface class.

Current supported debug servers:

• Soccer_Viewer
• soccerwindow2.

Member Function Documentation

addCircle() [1/2]

void rcsc::DebugClient::addCircle	(	const Circle2D &	circle,
		const char *	color = ""
	)

set circle info to be drawn

Parameters

circle

circle object

addCircle() [2/2]

void rcsc::DebugClient::addCircle ( const Vector2D &  center, const double &  radius, const char *  color = ""  )

inline

set circle info to be drawn

Parameters

center	center coordinate
radius	radius value

addComment()

void rcsc::DebugClient::addComment	(	const PlayerObject *	player,
		const char *	msg,
			...
	)

add formatred message for the player

Parameters

player	pointer to the target player
msg	formatted text

addLine()

void rcsc::DebugClient::addLine	(	const Vector2D &	from,
		const Vector2D &	to,
		const char *	color = ""
	)

set line info to be drawn

Parameters

from	line start point
to	line end point

addMessage() [1/2]

void rcsc::DebugClient::addMessage	(	const char *	msg,
			...
	)

add formatted string to buffer

Parameters

msg	formatted text

addMessage() [2/2]

void rcsc::DebugClient::addMessage

(

const std::string &

msg

)

add message string to buffer

Parameters

msg	message string

addRectangle()

void rcsc::DebugClient::addRectangle	(	const Rect2D &	rect,
		const char *	color = ""
	)

set rectangle info to be drawn

Parameters

rect	rectanble object

addSelfComment()

void rcsc::DebugClient::addSelfComment	(	const char *	msg,
			...
	)

add formatred message for self

Parameters

msg	formatted text

addTriangle() [1/2]

void rcsc::DebugClient::addTriangle	(	const Triangle2D &	tri,
		const char *	color = ""
	)

set triangle info to be drawn

Parameters

tri	triangle object

addTriangle() [2/2]

void rcsc::DebugClient::addTriangle ( const Vector2D &  v1, const Vector2D &  v2, const Vector2D &  v3, const char *  color = ""  )

inline

set triangle info to be drawn

Parameters

v1	vertex 1
v2	vertex 2
v3	vertex 3

connect()

void rcsc::DebugClient::connect	(	const std::string &	hostname,
		const int	port
	)

connect to the debug server

Parameters

hostname	host name string thatdebug server is running
port	port number for debug server connection

open()

bool rcsc::DebugClient::open	(	const std::string &	log_dir,
		const std::string &	teamname,
		const int	unum
	)

open debug server message log file.

Parameters

log_dir	directry path name.
teamname	team name.
unum	player's uniform number.

setTarget() [1/2]

void rcsc::DebugClient::setTarget ( const int  unum )

inline

set target player

Parameters

unum	target player's uniform number

setTarget() [2/2]

void rcsc::DebugClient::setTarget ( const Vector2D &  p )

inline

set target point

Parameters

p	target point

writeAll()

void rcsc::DebugClient::writeAll	(	const WorldModel &	world,
		const ActionEffector &	effector
	)

output to stream or socket

Parameters

world	const reference to the world model object
effector	const reference to the action effector object

---

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

• /home/kali/rc/tools/include/rcsc/player/debug_client.h