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

player's change focus command More...

#include <player_command.h>

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

Public Member Functions

 PlayerChangeFocusCommand (const double moment_dist, const double moment_dir)
 construct with command 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 thencommand name More...
 
double momentDist () const
 get the command parameter More...
 
double momentDir () const
 get the command parameter More...
 
- Public Member Functions inherited from rcsc::PlayerSupportCommand
virtual ~PlayerSupportCommand ()
 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...
 
- 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::PlayerSupportCommand
 PlayerSupportCommand ()
 constructor is protected because this is abstract class.
 
- Protected Member Functions inherited from rcsc::PlayerCommand
 PlayerCommand ()
 constructor is protected because this is abstract class.
 

Detailed Description

player's change focus command

Format:
<- (change_focus <moment_dist> <moment_dir>)

Constructor & Destructor Documentation

◆ PlayerChangeFocusCommand()

rcsc::PlayerChangeFocusCommand::PlayerChangeFocusCommand ( const double  moment_dist,
const double  moment_dir 
)
inline

construct with command parameters

Parameters
moment_distmoment for the distance
moment_dirmoment for the direction

Member Function Documentation

◆ momentDir()

double rcsc::PlayerChangeFocusCommand::momentDir ( ) const
inline

get the command parameter

Returns
the value of moment direction

◆ momentDist()

double rcsc::PlayerChangeFocusCommand::momentDist ( ) const
inline

get the command parameter

Returns
the value of moment distance

◆ name()

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

get thencommand name

Returns
command name string

Implements rcsc::PlayerSupportCommand.

◆ toCommandString()

std::ostream & rcsc::PlayerChangeFocusCommand::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::PlayerSupportCommand.

◆ type()

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

get command type

Returns
command type Id

Implements rcsc::PlayerSupportCommand.


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