LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Protected Member Functions | List of all members
rcsc::rcg::Handler Class Referenceabstract

abstract rcg data handler class. More...

#include <handler.h>

Public Member Functions

virtual ~Handler ()
 virtual destructor
 
virtual bool handleLogVersion (const int ver)
 records rcg version More...
 
virtual int logVersion () const
 returns rcg version number More...
 
bool handleDispInfo (const dispinfo_t &info)
 handle dispinfo_t. More...
 
bool handleDispInfo2 (const dispinfo_t2 &info)
 handle dispinfo_t2. More...
 
bool handleShowInfo (const showinfo_t &info)
 handle showinfo_t More...
 
bool handleShowInfo2 (const showinfo_t2 &info)
 handle showinfo_t2 More...
 
bool handleShortShowInfo2 (const short_showinfo_t2 &info)
 handle short_showinfo_t. More...
 
bool handleMsgInfo (const Int16 board, const std::string &msg)
 handle msginfo_t More...
 
bool handleDrawInfo (const drawinfo_t &draw)
 handle drawinfo_t More...
 
bool handlePlayMode (char playmode)
 handle playmode More...
 
bool handleTeamInfo (const team_t &team_l, const team_t &team_r)
 handle team data More...
 
bool handlePlayerType (const player_type_t &type)
 handle player_type_t More...
 
bool handleServerParam (const server_params_t &param)
 handle server_params_t More...
 
bool handlePlayerParam (const player_params_t &param)
 handle player_params_t More...
 
virtual bool handleEOF ()=0
 (pure virtual) handle end of file More...
 
virtual bool handleShow (const ShowInfoT &show)=0
 (pure virtual) handle the start of show info v4 More...
 
virtual bool handleMsg (const int time, const int board, const std::string &msg)=0
 (pure virtual) handle msg info More...
 
virtual bool handleDraw (const int time, const drawinfo_t &draw)=0
 (pure virtual) handle draw info More...
 
virtual bool handlePlayMode (const int time, const PlayMode pm)=0
 handle playmode More...
 
virtual bool handleTeam (const int time, const TeamT &team_l, const TeamT &team_r)=0
 handle team info More...
 
virtual bool handleServerParam (const std::string &msg)=0
 handle server_param message More...
 
virtual bool handlePlayerParam (const std::string &msg)=0
 handle player_param message More...
 
virtual bool handlePlayerType (const std::string &msg)=0
 handle player_type message More...
 

Protected Member Functions

 Handler ()
 default constructor. log version and time are set to zero.
 

Detailed Description

abstract rcg data handler class.

This is an interface class, all member methods are virtual.

Member Function Documentation

◆ handleDispInfo()

bool rcsc::rcg::Handler::handleDispInfo ( const dispinfo_t info)

handle dispinfo_t.

Parameters
infonew data
Returns
result status

◆ handleDispInfo2()

bool rcsc::rcg::Handler::handleDispInfo2 ( const dispinfo_t2 info)

handle dispinfo_t2.

Parameters
infonew data
Returns
result status

◆ handleDraw()

virtual bool rcsc::rcg::Handler::handleDraw ( const int  time,
const drawinfo_t draw 
)
pure virtual

(pure virtual) handle draw info

Parameters
timegame time of handled data
drawnew data
Returns
result status

◆ handleDrawInfo()

bool rcsc::rcg::Handler::handleDrawInfo ( const drawinfo_t draw)

handle drawinfo_t

Parameters
drawnew data
Returns
result status

◆ handleEOF()

virtual bool rcsc::rcg::Handler::handleEOF ( )
pure virtual

(pure virtual) handle end of file

Returns
result status

◆ handleLogVersion()

virtual bool rcsc::rcg::Handler::handleLogVersion ( const int  ver)
inlinevirtual

records rcg version

Parameters
verlog version.
Returns
always true.

This method is virtual. You can override this.

◆ handleMsg()

virtual bool rcsc::rcg::Handler::handleMsg ( const int  time,
const int  board,
const std::string &  msg 
)
pure virtual

(pure virtual) handle msg info

Parameters
timegame time of handled msg info
boardmessage board type
msgnew data
Returns
result status

◆ handleMsgInfo()

bool rcsc::rcg::Handler::handleMsgInfo ( const Int16  board,
const std::string &  msg 
)

handle msginfo_t

Parameters
boardhandled message type
msghandled message data
Returns
result status

◆ handlePlayerParam() [1/2]

bool rcsc::rcg::Handler::handlePlayerParam ( const player_params_t param)

handle player_params_t

Parameters
paramhandled data
Returns
result status

◆ handlePlayerParam() [2/2]

virtual bool rcsc::rcg::Handler::handlePlayerParam ( const std::string &  msg)
pure virtual

handle player_param message

Parameters
msgraw message string
Returns
result status

◆ handlePlayerType() [1/2]

bool rcsc::rcg::Handler::handlePlayerType ( const player_type_t type)

handle player_type_t

Parameters
typehandled data
Returns
result status

◆ handlePlayerType() [2/2]

virtual bool rcsc::rcg::Handler::handlePlayerType ( const std::string &  msg)
pure virtual

handle player_type message

Parameters
msgraw message string
Returns
result status

◆ handlePlayMode() [1/2]

bool rcsc::rcg::Handler::handlePlayMode ( char  playmode)

handle playmode

Parameters
playmodehandled playmode character
Returns
result status

◆ handlePlayMode() [2/2]

virtual bool rcsc::rcg::Handler::handlePlayMode ( const int  time,
const PlayMode  pm 
)
pure virtual

handle playmode

Parameters
timegame time of handled playmode info
pmplaymode id
Returns
result status

◆ handleServerParam() [1/2]

bool rcsc::rcg::Handler::handleServerParam ( const server_params_t param)

handle server_params_t

Parameters
paramhandled data
Returns
result status

◆ handleServerParam() [2/2]

virtual bool rcsc::rcg::Handler::handleServerParam ( const std::string &  msg)
pure virtual

handle server_param message

Parameters
msgraw message string
Returns
result status

◆ handleShortShowInfo2()

bool rcsc::rcg::Handler::handleShortShowInfo2 ( const short_showinfo_t2 info)

handle short_showinfo_t.

Parameters
infohandled data
Returns
result status

◆ handleShow()

virtual bool rcsc::rcg::Handler::handleShow ( const ShowInfoT show)
pure virtual

(pure virtual) handle the start of show info v4

Parameters
timegame time of handled show info
showread data
Returns
result status

◆ handleShowInfo()

bool rcsc::rcg::Handler::handleShowInfo ( const showinfo_t info)

handle showinfo_t

Parameters
infohandled data
Returns
result status

◆ handleShowInfo2()

bool rcsc::rcg::Handler::handleShowInfo2 ( const showinfo_t2 info)

handle showinfo_t2

Parameters
infohandled data
Returns
result status

◆ handleTeam()

virtual bool rcsc::rcg::Handler::handleTeam ( const int  time,
const TeamT team_l,
const TeamT team_r 
)
pure virtual

handle team info

Parameters
timegame time of handled team info
team_lleft team info
team_rright team info
Returns
result status

◆ handleTeamInfo()

bool rcsc::rcg::Handler::handleTeamInfo ( const team_t team_l,
const team_t team_r 
)

handle team data

Parameters
team_lleft team data
team_rright team data
Returns
result status

◆ logVersion()

virtual int rcsc::rcg::Handler::logVersion ( ) const
inlinevirtual

returns rcg version number

Returns
rcg version number

This method is virtual. You can override this.


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