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

freeform message command More...

#include <coach_command.h>

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

Public Member Functions

 CoachFreeformCommand (const double &version, const std::string &message)
 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::CoachCommand
virtual ~CoachCommand ()
 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::CoachCommand
enum  Type {
  INIT , BYE , CHECK_BALL , LOOK ,
  TEAM_NAMES , EYE , CHANGE_PLAYER_TYPE , CHANGE_PLAYER_TYPES ,
  CLANG_FREEFORM , TEAM_GRAPHIC , COMPRESSION , DONE ,
  ILLEGAL
}
 online coach command type Id
 
- Protected Member Functions inherited from rcsc::CoachCommand
 CoachCommand ()
 constructor is protected because this is abstract class.
 

Detailed Description

freeform message command

Old version:

Format:
<- (say <msg>)
Response:
-> (ok say)
-> (error could_not_parse_say)
-> (error said_too_many_****_messages)
-> (warning cannot_say_while_playon) [only v7-]

New version:

Format:
<- (say (freeform "<msg>"))

Constructor & Destructor Documentation

◆ CoachFreeformCommand()

rcsc::CoachFreeformCommand::CoachFreeformCommand ( const double &  version,
const std::string &  message 
)
inline

construct with message string.

Parameters
clang_msgreference to the clang message instance

Member Function Documentation

◆ name()

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

get command name

Returns
command name string

Implements rcsc::CoachCommand.

◆ toCommandString()

std::ostream & rcsc::CoachFreeformCommand::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::CoachCommand.

◆ type()

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

get command type

Returns
command type Id

Implements rcsc::CoachCommand.


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