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

trainer's say command More...

#include <trainer_command.h>

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

Public Member Functions

 TrainerSayCommand (const std::string &msg)
 construct with message string 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::TrainerCommand
virtual ~TrainerCommand ()
 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::TrainerCommand
enum  Type {
  INIT , CHECK_BALL , LOOK , TEAM_NAMES ,
  EAR , EYE , START , CHANGE_MODE ,
  MOVE , RECOVER , CHANGE_PLAYER_TYPE , SAY ,
  COMPRESSION , DONE , ILLEGAL
}
 trainer command type Id More...
 
- Protected Member Functions inherited from rcsc::TrainerCommand
 TrainerCommand ()
 constructor is protected because this is abstract class.
 

Detailed Description

trainer's say command

Format:
<- (say <message>)
Response:
-> (ok say)

Constructor & Destructor Documentation

◆ TrainerSayCommand()

rcsc::TrainerSayCommand::TrainerSayCommand ( const std::string &  msg)
inlineexplicit

construct with message string

Parameters
msgmessage to be sent

Member Function Documentation

◆ name()

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

get command name

Returns
command name string

Implements rcsc::TrainerCommand.

◆ toCommandString()

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

put command string to ostream

Parameters
toreferent to the output stream
Returns
referenct to the output stream

Implements rcsc::TrainerCommand.

◆ type()

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

get command type

Returns
command type Id

Implements rcsc::TrainerCommand.


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