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

player's turn neck command More...

#include <player_command.h>

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

Public Member Functions

 PlayerPointtoCommand ()
 target angle relative to body angle More...
 
 PlayerPointtoCommand (const double &dist, const double &rel_dir)
 construct on type pointto command with point target 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 paramter More...
 
bool pointtoOn () const
 get pointto command switch More...
 
const double & pointtoDist () const
 get pointto command parameter More...
 
const double & pointtoDir () const
 get pointto 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 turn neck command

Format:
<- (pointto <dist> <dir>)
<- (pointto off)

Constructor & Destructor Documentation

◆ PlayerPointtoCommand() [1/2]

rcsc::PlayerPointtoCommand::PlayerPointtoCommand ( )
inline

target angle relative to body angle

construct off type pointto command

◆ PlayerPointtoCommand() [2/2]

rcsc::PlayerPointtoCommand::PlayerPointtoCommand ( const double &  dist,
const double &  rel_dir 
)
inline

construct on type pointto command with point target

Parameters
distpoint target distance
rel_dirpoint target angle relative to body angle

Member Function Documentation

◆ name()

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

get command paramter

Returns
turn neck moment of this command

Implements rcsc::PlayerSupportCommand.

◆ pointtoDir()

const double & rcsc::PlayerPointtoCommand::pointtoDir ( ) const
inline

get pointto command parameter

Returns
pointto dir

◆ pointtoDist()

const double & rcsc::PlayerPointtoCommand::pointtoDist ( ) const
inline

get pointto command parameter

Returns
pointto distance

◆ pointtoOn()

bool rcsc::PlayerPointtoCommand::pointtoOn ( ) const
inline

get pointto command switch

Returns
true if pointo is on

◆ toCommandString()

std::ostream & rcsc::PlayerPointtoCommand::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::PlayerPointtoCommand::type ( ) const
inlinevirtual

get command type

Returns
command type Id

Implements rcsc::PlayerSupportCommand.


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