LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | List of all members
rcsc::PlayerAttentiontoCommand Class Reference

player's attentionto command More...

#include <player_command.h>

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

Public Types

enum  SideType { OUR , OPP , NONE }
 target player's side type
 
- 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...
 

Public Member Functions

 PlayerAttentiontoCommand ()
 construct off type attentionto command
 
 PlayerAttentiontoCommand (const SideType side, const int unum)
 construct on type attentionto command 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 isOn () const
 get on/off flag More...
 
SideType side () const
 get target player's side type More...
 
int number () const
 get target player's uniform number 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

- 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 attentionto command

Format:
<- (attentionto <side> <unum>)
<- (attentionto off)

side :- our | opp | l | left | r | right | TEAMNAME

Constructor & Destructor Documentation

◆ PlayerAttentiontoCommand()

rcsc::PlayerAttentiontoCommand::PlayerAttentiontoCommand ( const SideType  side,
const int  unum 
)
inline

construct on type attentionto command

Parameters
sidetarget player's side
unumtarget player's uniform number

Member Function Documentation

◆ isOn()

bool rcsc::PlayerAttentiontoCommand::isOn ( ) const
inline

get on/off flag

Returns
true if this command is on type

◆ name()

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

get command paramter

Returns
turn neck moment of this command

Implements rcsc::PlayerSupportCommand.

◆ number()

int rcsc::PlayerAttentiontoCommand::number ( ) const
inline

get target player's uniform number

Returns
target player's uniform number

◆ side()

SideType rcsc::PlayerAttentiontoCommand::side ( ) const
inline

get target player's side type

Returns
target player's side type

◆ toCommandString()

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

get command type

Returns
command type Id

Implements rcsc::PlayerSupportCommand.


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