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::PlayerConfig Class Reference

player configuration variable set More...

#include <player_config.h>

Public Member Functions

 PlayerConfig ()
 init variables by default value. create ParamMap instance
 
 ~PlayerConfig ()
 delete ParamMap instance
 
void parse (ParamParser &parser)
 set parameter values using param parser instance More...
 
std::ostream & printHelp (std::ostream &os) const
 print help message to the output stream More...
 
const std::string & teamName () const
 get the team name string More...
 
double version () const
 get the client version More...
 
int reconnectNumber () const
 get the uniform numver for a reconnect command More...
 
bool goalie () const
 get the goalie flag More...
 
int intervalMSec () const
 get the interrupt interval for decision making More...
 
int serverWaitSeconds () const
 get the maximum time to wait server response More...
 
int waitTimeThrSynchView () const
 get the maximum time to wait see message for synch view mode More...
 
int waitTimeThrNoSynchView () const
 get the maximum time to wait see message for asynch view mode More...
 
int normalViewTimeThr () const
 get the threshold time to change to normal view width for old timer synch view mode More...
 
const std::string & host () const
 get the server host name string More...
 
int port () const
 get the server port number More...
 
int compression () const
 get the server message compression level More...
 
int clangMin () const
 get the minimum clang version to be sent More...
 
int clangMax () const
 get the maximum clang version to be sent More...
 
bool useCommunication () const
 get the communication mode flag More...
 
bool hearOpponentAudio () const
 get the auditory sensor mode flag for opponent More...
 
int audioShift () const
 
bool useFullstate () const
 get the fullstate mode flag that determines whether the world model is updated by fullstate information More...
 
bool debugFullstate () const
 get the switch variable thate determines whether a fullstate world model for debugging is used or not. More...
 
bool synchSee () const
 get the synch_see mode flag More...
 
int selfPosCountThr () const
 get the self position accuracy count threshold More...
 
int selfVelCountThr () const
 get the self velocity accuracy count threshold More...
 
int selfFaceCountThr () const
 get the self face angle accuracy count threshold More...
 
int ballPosCountThr () const
 get the ball position accuracy count threshold More...
 
int ballRPosCountThr () const
 get the ball relative position accuracy count threshold More...
 
int ballVelCountThr () const
 get the ball velocity accuracy count threshold More...
 
int playerPosCountThr () const
 get the other player position accuracy count threshold More...
 
int playerVelCountThr () const
 get the other player position accuracy count threshold More...
 
int playerFaceCountThr () const
 get the other player face angle accuracy count threshold More...
 
int playerNumber () const
 get the player number (not a uniform number) More...
 
void setPlayerNumber (const int num)
 set a player number (not a uniform number) More...
 
const std::string & configDir () const
 get the configulation directory path More...
 
bool debug () const
 get the debug flag More...
 
const std::string & logDir () const
 get the debug log directory path string. More...
 
bool debugServerConnect () const
 get the debug flag whether debug information is sent to a debug server More...
 
bool debugServerLogging () const
 get the debug flag whether debug information is written to files More...
 
const std::string & debugServerHost () const
 get the debug server host name string More...
 
int debugServerPort () const
 get the debug server port number More...
 
bool offlineLogging () const
 get the switch for offline logging. this value is ignored if client runs in offline clinet mode. More...
 
const std::string & offlineLogExt () const
 get the offline client log file extention string. More...
 
int offlineClientNumber () const
 get the uniform number for offline client mode. 1-11 means offline mode, other values mean online mode. More...
 
int debugStartTime () const
 get the start time for receoding the debug log More...
 
int debugEndTime () const
 get the end time for receoding the debug log More...
 
const std::string & debugLogExt () const
 get the debug log file extention string. More...
 
bool debugSystem () const
 get the debug flag More...
 
bool debugSensor () const
 get the debug flag More...
 
bool debugWorld () const
 get the debug flag More...
 
bool debugAction () const
 get the debug flag More...
 
bool debugIntercept () const
 get the debug flag More...
 
bool debugKick () const
 get the debug flag More...
 
bool debugHold () const
 get the debug flag More...
 
bool debugDribble () const
 get the debug flag More...
 
bool debugPass () const
 get the debug flag More...
 
bool debugCross () const
 get the debug flag More...
 
bool debugShoot () const
 get the debug flag More...
 
bool debugClear () const
 get the debug flag More...
 
bool debugBlock () const
 get the debug flag More...
 
bool debugMark () const
 get the debug flag More...
 
bool debugPositioning () const
 get the debug flag More...
 
bool debugRole () const
 get the debug flag More...
 
bool debugPlan () const
 get the debug flag More...
 
bool debugTeam () const
 get the debug flag More...
 
bool debugCommunication () const
 get the debug flag More...
 
bool debugAnalyzer () const
 get the debug flag More...
 
bool debugActionChain () const
 get the debug flag More...
 
bool debugTraining () const
 get the debug flag More...
 

Protected Member Functions

void setDefaultParam ()
 set default value
 
void createParamMap ()
 set parameter entries
 

Detailed Description

player configuration variable set

Member Function Documentation

◆ ballPosCountThr()

int rcsc::PlayerConfig::ballPosCountThr ( ) const
inline

get the ball position accuracy count threshold

Returns
ball position accuracy count threshold

◆ ballRPosCountThr()

int rcsc::PlayerConfig::ballRPosCountThr ( ) const
inline

get the ball relative position accuracy count threshold

Returns
ball relative position accuracy count threshold

◆ ballVelCountThr()

int rcsc::PlayerConfig::ballVelCountThr ( ) const
inline

get the ball velocity accuracy count threshold

Returns
ball velocity accuracy count threshold

◆ clangMax()

int rcsc::PlayerConfig::clangMax ( ) const
inline

get the maximum clang version to be sent

Returns
maximum clang version to be sent

◆ clangMin()

int rcsc::PlayerConfig::clangMin ( ) const
inline

get the minimum clang version to be sent

Returns
minimum clang version to be sent

◆ compression()

int rcsc::PlayerConfig::compression ( ) const
inline

get the server message compression level

Returns
server message compression level

◆ configDir()

const std::string & rcsc::PlayerConfig::configDir ( ) const
inline

get the configulation directory path

Returns
configulation directory path

◆ debug()

bool rcsc::PlayerConfig::debug ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugAction()

bool rcsc::PlayerConfig::debugAction ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugActionChain()

bool rcsc::PlayerConfig::debugActionChain ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugAnalyzer()

bool rcsc::PlayerConfig::debugAnalyzer ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugBlock()

bool rcsc::PlayerConfig::debugBlock ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugClear()

bool rcsc::PlayerConfig::debugClear ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugCommunication()

bool rcsc::PlayerConfig::debugCommunication ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugCross()

bool rcsc::PlayerConfig::debugCross ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugDribble()

bool rcsc::PlayerConfig::debugDribble ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugEndTime()

int rcsc::PlayerConfig::debugEndTime ( ) const
inline

get the end time for receoding the debug log

Returns
the end time for receoding the debug log

◆ debugFullstate()

bool rcsc::PlayerConfig::debugFullstate ( ) const
inline

get the switch variable thate determines whether a fullstate world model for debugging is used or not.

Returns
debugging fullstate world model switch

◆ debugHold()

bool rcsc::PlayerConfig::debugHold ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugIntercept()

bool rcsc::PlayerConfig::debugIntercept ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugKick()

bool rcsc::PlayerConfig::debugKick ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugLogExt()

const std::string & rcsc::PlayerConfig::debugLogExt ( ) const
inline

get the debug log file extention string.

Returns
the debug log file extention string.

◆ debugMark()

bool rcsc::PlayerConfig::debugMark ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugPass()

bool rcsc::PlayerConfig::debugPass ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugPlan()

bool rcsc::PlayerConfig::debugPlan ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugPositioning()

bool rcsc::PlayerConfig::debugPositioning ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugRole()

bool rcsc::PlayerConfig::debugRole ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugSensor()

bool rcsc::PlayerConfig::debugSensor ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugServerConnect()

bool rcsc::PlayerConfig::debugServerConnect ( ) const
inline

get the debug flag whether debug information is sent to a debug server

Returns
debug flag whether debug information is sent to a debug server

◆ debugServerHost()

const std::string & rcsc::PlayerConfig::debugServerHost ( ) const
inline

get the debug server host name string

Returns
debug server host name string

◆ debugServerLogging()

bool rcsc::PlayerConfig::debugServerLogging ( ) const
inline

get the debug flag whether debug information is written to files

Returns
debug flag whether debug information is written to files

◆ debugServerPort()

int rcsc::PlayerConfig::debugServerPort ( ) const
inline

get the debug server port number

Returns
debug server port number

◆ debugShoot()

bool rcsc::PlayerConfig::debugShoot ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugStartTime()

int rcsc::PlayerConfig::debugStartTime ( ) const
inline

get the start time for receoding the debug log

Returns
the start time for receoding the debug log

◆ debugSystem()

bool rcsc::PlayerConfig::debugSystem ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugTeam()

bool rcsc::PlayerConfig::debugTeam ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugTraining()

bool rcsc::PlayerConfig::debugTraining ( ) const
inline

get the debug flag

Returns
debug flag

◆ debugWorld()

bool rcsc::PlayerConfig::debugWorld ( ) const
inline

get the debug flag

Returns
debug flag

◆ goalie()

bool rcsc::PlayerConfig::goalie ( ) const
inline

get the goalie flag

Returns
goalie flag

◆ hearOpponentAudio()

bool rcsc::PlayerConfig::hearOpponentAudio ( ) const
inline

get the auditory sensor mode flag for opponent

Returns
auditory sensor mode flag for opponent

◆ host()

const std::string & rcsc::PlayerConfig::host ( ) const
inline

get the server host name string

Returns
server host name string

◆ intervalMSec()

int rcsc::PlayerConfig::intervalMSec ( ) const
inline

get the interrupt interval for decision making

Returns
interrupt interval in milli-seconds

◆ logDir()

const std::string & rcsc::PlayerConfig::logDir ( ) const
inline

get the debug log directory path string.

Returns
the debug log directory string.

◆ normalViewTimeThr()

int rcsc::PlayerConfig::normalViewTimeThr ( ) const
inline

get the threshold time to change to normal view width for old timer synch view mode

Returns
the threshold time to change to normal view width

◆ offlineClientNumber()

int rcsc::PlayerConfig::offlineClientNumber ( ) const
inline

get the uniform number for offline client mode. 1-11 means offline mode, other values mean online mode.

Returns
the uniform number for offline client mode.

◆ offlineLogExt()

const std::string & rcsc::PlayerConfig::offlineLogExt ( ) const
inline

get the offline client log file extention string.

Returns
the offline client log file extention string.

◆ offlineLogging()

bool rcsc::PlayerConfig::offlineLogging ( ) const
inline

get the switch for offline logging. this value is ignored if client runs in offline clinet mode.

Returns
switch value for offline logging.

◆ parse()

void rcsc::PlayerConfig::parse ( ParamParser parser)

set parameter values using param parser instance

Parameters
parserparam parser instance

◆ playerFaceCountThr()

int rcsc::PlayerConfig::playerFaceCountThr ( ) const
inline

get the other player face angle accuracy count threshold

Returns
other player face angle accuracy count threshold

◆ playerNumber()

int rcsc::PlayerConfig::playerNumber ( ) const
inline

get the player number (not a uniform number)

Returns
player number

◆ playerPosCountThr()

int rcsc::PlayerConfig::playerPosCountThr ( ) const
inline

get the other player position accuracy count threshold

Returns
other player position accuracy count threshold

◆ playerVelCountThr()

int rcsc::PlayerConfig::playerVelCountThr ( ) const
inline

get the other player position accuracy count threshold

Returns
other player velocity accuracy count threshold

◆ port()

int rcsc::PlayerConfig::port ( ) const
inline

get the server port number

Returns
server port number

◆ printHelp()

std::ostream & rcsc::PlayerConfig::printHelp ( std::ostream &  os) const

print help message to the output stream

Parameters
osoutput stream
Returns
output stream

◆ reconnectNumber()

int rcsc::PlayerConfig::reconnectNumber ( ) const
inline

get the uniform numver for a reconnect command

Returns
the uniform numver for a reconnect command

◆ selfFaceCountThr()

int rcsc::PlayerConfig::selfFaceCountThr ( ) const
inline

get the self face angle accuracy count threshold

Returns
self face angle accuracy count threshold

◆ selfPosCountThr()

int rcsc::PlayerConfig::selfPosCountThr ( ) const
inline

get the self position accuracy count threshold

Returns
self position accuracy count threshold

◆ selfVelCountThr()

int rcsc::PlayerConfig::selfVelCountThr ( ) const
inline

get the self velocity accuracy count threshold

Returns
self velocity accuracy count threshold

◆ serverWaitSeconds()

int rcsc::PlayerConfig::serverWaitSeconds ( ) const
inline

get the maximum time to wait server response

Returns
wait time in seconds.

◆ setPlayerNumber()

void rcsc::PlayerConfig::setPlayerNumber ( const int  num)
inline

set a player number (not a uniform number)

Parameters
numplayer number

◆ synchSee()

bool rcsc::PlayerConfig::synchSee ( ) const
inline

get the synch_see mode flag

Returns
synch_see mode flag

◆ teamName()

const std::string & rcsc::PlayerConfig::teamName ( ) const
inline

get the team name string

Returns
team name string

◆ useCommunication()

bool rcsc::PlayerConfig::useCommunication ( ) const
inline

get the communication mode flag

Returns
communication mode flag

◆ useFullstate()

bool rcsc::PlayerConfig::useFullstate ( ) const
inline

get the fullstate mode flag that determines whether the world model is updated by fullstate information

Returns
fullstate mode flag

◆ version()

double rcsc::PlayerConfig::version ( ) const
inline

get the client version

Returns
client version

◆ waitTimeThrNoSynchView()

int rcsc::PlayerConfig::waitTimeThrNoSynchView ( ) const
inline

get the maximum time to wait see message for asynch view mode

Returns
wait time in milli-seconds

◆ waitTimeThrSynchView()

int rcsc::PlayerConfig::waitTimeThrSynchView ( ) const
inline

get the maximum time to wait see message for synch view mode

Returns
wait time in milli-seconds

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