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

player's init command More...

#include <player_command.h>

Inheritance diagram for rcsc::PlayerInitCommand:
Inheritance graph
[legend]
Collaboration diagram for rcsc::PlayerInitCommand:
Collaboration graph
[legend]

Public Member Functions

 PlayerInitCommand (const std::string &team_name, const double &version=3.0, const bool goalie=false)
 construct with init parameters More...
 
Type type () const
 get command type More...
 
std::ostream & toCommandString (std::ostream &to) const
 put command string to ostream More...
 
std::string name () const
 get command name More...
 
- Public Member Functions inherited from rcsc::PlayerCommand
virtual ~PlayerCommand ()
 virtual destructor, but nothing to do
 
virtual Type type () const =0
 get command type (pure virtual) More...
 
virtual std::ostream & toCommandString (std::ostream &to) const =0
 put command string to ostream (pure virtual) More...
 
virtual std::string name () const =0
 get command name (pure virtual) More...
 

Additional Inherited Members

- Public Types inherited from rcsc::PlayerCommand
enum  Type {
  INIT , RECONNECT , BYE , MOVE ,
  DASH , TURN , KICK , CATCH ,
  TACKLE , TURN_NECK , CHANGE_VIEW , CHANGE_FOCUS ,
  SAY , POINTTO , ATTENTIONTO , CLANG ,
  EAR , SENSE_BODY , SCORE , COMPRESSION ,
  DONE , ILLEGAL
}
 player client command Id More...
 
- Protected Member Functions inherited from rcsc::PlayerCommand
 PlayerCommand ()
 constructor is protected because this is abstract class.
 

Detailed Description

player's init command

Format:
<- (init <teamname>[ (version <ver>)[ (goalie)]])
Response:
-> (init <side> <unum> <playmode>)

Constructor & Destructor Documentation

◆ PlayerInitCommand()

rcsc::PlayerInitCommand::PlayerInitCommand ( const std::string &  team_name,
const double &  version = 3.0,
const bool  goalie = false 
)
explicit

construct with init parameters

Parameters
team_nameplayer's team name
versionplayer's client version (default: 3.0)
goalieif true, player start as goalie

Member Function Documentation

◆ name()

std::string rcsc::PlayerInitCommand::name ( ) const
inlinevirtual

get command name

Returns
command name string

Implements rcsc::PlayerCommand.

◆ toCommandString()

std::ostream & rcsc::PlayerInitCommand::toCommandString ( std::ostream &  to) const
virtual

put command string to ostream

Parameters
toreference to the output stream
Returns
reference to the output stream

Implements rcsc::PlayerCommand.

◆ type()

Type rcsc::PlayerInitCommand::type ( ) const
inlinevirtual

get command type

Returns
command type Id

Implements rcsc::PlayerCommand.


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