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 | List of all members
rcsc::TrainerConfig Class Reference

trainer configuration parameters More...

#include <trainer_config.h>

Public Member Functions

 TrainerConfig ()
 init variables by default value. create ParamMap instance
 
 ~TrainerConfig ()
 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 intervalMSec () const
 get the interrupt interval for decision making More...
 
int serverWaitSeconds () const
 get the maximum seconds to wait server response. More...
 
const std::string & host () const
 get the server host name string More...
 
int port () const
 get the connection port number More...
 
int compression () const
 get the message compression level More...
 
bool useEye () const
 get the eye mode status More...
 
bool useEar () const
 get the ear mode status More...
 
bool debug () const
 get the debug flag More...
 
const std::string & logDir () const
 get the debug log directory string. 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...
 
bool offlineClientMode () const
 get the offline client mode switch. 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...
 

Detailed Description

trainer configuration parameters

Member Function Documentation

◆ compression()

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

get the message compression level

Returns
message compression level

◆ debug()

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

get the debug flag

Returns
debug flag

◆ debugAction()

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

get the debug flag

Returns
debug flag

◆ debugActionChain()

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

get the debug flag

Returns
debug flag

◆ debugAnalyzer()

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

get the debug flag

Returns
debug flag

◆ debugBlock()

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

get the debug flag

Returns
debug flag

◆ debugClear()

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

get the debug flag

Returns
debug flag

◆ debugCommunication()

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

get the debug flag

Returns
debug flag

◆ debugCross()

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

get the debug flag

Returns
debug flag

◆ debugDribble()

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

get the debug flag

Returns
debug flag

◆ debugHold()

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

get the debug flag

Returns
debug flag

◆ debugIntercept()

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

get the debug flag

Returns
debug flag

◆ debugKick()

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

get the debug flag

Returns
debug flag

◆ debugLogExt()

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

get the debug log file extention string.

Returns
the debug log file extention string.

◆ debugMark()

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

get the debug flag

Returns
debug flag

◆ debugPass()

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

get the debug flag

Returns
debug flag

◆ debugPlan()

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

get the debug flag

Returns
debug flag

◆ debugPositioning()

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

get the debug flag

Returns
debug flag

◆ debugRole()

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

get the debug flag

Returns
debug flag

◆ debugSensor()

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

get the debug flag

Returns
debug flag

◆ debugShoot()

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

get the debug flag

Returns
debug flag

◆ debugSystem()

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

get the debug flag

Returns
debug flag

◆ debugTeam()

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

get the debug flag

Returns
debug flag

◆ debugWorld()

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

get the debug flag

Returns
debug flag

◆ host()

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

get the server host name string

Returns
server host name string

◆ intervalMSec()

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

get the interrupt interval for decision making

Returns
interval milli-seconds

◆ logDir()

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

get the debug log directory string.

Returns
the debug log directory string.

◆ offlineClientMode()

bool rcsc::TrainerConfig::offlineClientMode ( ) const
inline

get the offline client mode switch.

Returns
offline client mode switch.

◆ offlineLogExt()

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

get the offline client log file extention string.

Returns
the offline client log file extention string.

◆ offlineLogging()

bool rcsc::TrainerConfig::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::TrainerConfig::parse ( ParamParser parser)

set parameter values using param parser instance

Parameters
parserparam parser instance

◆ port()

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

get the connection port number

Returns
connection port number

◆ printHelp()

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

print help message to the output stream

Parameters
osoutput stream
Returns
output stream

◆ serverWaitSeconds()

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

get the maximum seconds to wait server response.

Returns
the maximum seconds to wait server response.

◆ teamName()

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

get the team name string

Returns
team name string

◆ useEar()

bool rcsc::TrainerConfig::useEar ( ) const
inline

get the ear mode status

Returns
true if ear mode is on, othewise false

◆ useEye()

bool rcsc::TrainerConfig::useEye ( ) const
inline

get the eye mode status

Returns
true if eye mode is on, othewise false

◆ version()

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

get the client version

Returns
client version

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