クラス rcsc::PlayerEarCommand

command to specify player's ear mode [詳細]

#include <player_command.h>

rcsc::PlayerEarCommandに対する継承グラフ

rcsc::PlayerSupportCommand rcsc::PlayerCommand すべてのメンバ一覧

Public 型

enum  OnOffType { ON, OFF }
 on/off types
enum  SideType {
  SIDE = -1, SYNMETRY = 1, CENTER = 0, OUR,
  OPP, NONE, OUR, OPP
}
 side types [詳細]
enum  ModeType { COMPLETE, PARTIAL, ALL }
 ear mode types that specifies enabled hear message type

Public メソッド

 PlayerEarCommand (const OnOffType onoff, const SideType side)
 constcust command for all type message
 PlayerEarCommand (const OnOffType onoff, const SideType side, const ModeType mode)
 constcust command for specified type message
Type type () const
 get command type
std::ostream & toStr (std::ostream &to) const
 put command string to ostream
std::string name () const
 get command paramter
OnOffType onOff () const
 get ear command parameter
SideType side () const
 get ear command parameter
ModeType mode () const
 get ear command parameter

説明

command to specify player's ear mode

  Format:
  <- (ear (<onoff> <side> <mode>)) : change only team (our or opp)
  <- (ear (<onoff> <mode>))        : change all players (our & opp)
  <- (ear (<onoff> <side>))        : change team (our or opp) & turn on/off all (complete & partial)
  <- (ear (<onoff>))               : change all players (our & opp) & turn on/off all (complete & partial)

  <onoff> :- on | off
  <side> :- our | opp | left | l | right | r | TEAMNAME
  <mode> :- partial | p | complete | c

  Response:
  -> (error no team with name <teanmane>) : case illegal team name

  if you do NOT want to hear any opponent message,
  you should to send next command
  <- (ear (off opp complete))  : partial mode was set to off by default.
  or,
  <- (ear (off opp))
  


列挙型

enum rcsc::PlayerEarCommand::SideType

side types

列挙型の値:
SIDE  original type, consider all region
SYNMETRY  synmetry type, this type refers SIDE
CENTER  original type, consider half region


コンストラクタとデストラクタ

rcsc::PlayerEarCommand::PlayerEarCommand ( const OnOffType  onoff,
const SideType  side 
) [inline]

constcust command for all type message

引数:
onoff on/off switch
side side type

rcsc::PlayerEarCommand::PlayerEarCommand ( const OnOffType  onoff,
const SideType  side,
const ModeType  mode 
) [inline]

constcust command for specified type message

引数:
onoff on/off switch
side side type
mode ear mode type


関数

Type rcsc::PlayerEarCommand::type (  )  const [inline, virtual]

get command type

戻り値:
command type Id

rcsc::PlayerSupportCommandを実装しています。

std::ostream & rcsc::PlayerEarCommand::toStr ( std::ostream &  to  )  const [virtual]

put command string to ostream

引数:
to reference to the output stream
戻り値:
reference to the output stream

rcsc::PlayerSupportCommandを実装しています。

std::string rcsc::PlayerEarCommand::name (  )  const [inline, virtual]

get command paramter

戻り値:
turn neck moment of this command

rcsc::PlayerSupportCommandを実装しています。

OnOffType rcsc::PlayerEarCommand::onOff (  )  const [inline]

get ear command parameter

戻り値:
on/off type

SideType rcsc::PlayerEarCommand::side (  )  const [inline]

get ear command parameter

戻り値:
side type

ModeType rcsc::PlayerEarCommand::mode (  )  const [inline]

get ear command parameter

戻り値:
mode type


このクラスの説明は次のファイルから生成されました:
librcscに対してThu May 1 15:41:27 2008に生成されました。  doxygen 1.5.0