rcsc::AudioSensor Class Reference

processor for players' communication More...

#include <audio_sensor.h>

Public Member Functions
	AudioSensor ()
	init member variables by default value
void	addSayMessageParser (SayMessageParser::Ptr parser)
	add new player message parer. More...
void	removeSayMessageParser (const char header)
	remove registered parser object More...
void	addFreeformMessageParser (FreeformMessageParser::Ptr parser)
	set new freeform message parer. More...
void	removeFreeformMessageParser (const std::string &type)
	remove registerd freeform parser object More...
void	parsePlayerMessage (const char *msg, const GameTime &current)
	analyze other player's audio message More...
void	parseCoachMessage (const char *msg, const GameTime &current)
	analyze message from online coach More...
void	parseTrainerMessage (const char *msg, const GameTime &current)
	analyze trainer's audio message More...
const GameTime &	teammateMessageTime () const
	get time when teammate message is received More...
const std::list< HearMessage > &	teammateMessages () const
	get the last received teammate messages More...
const GameTime &	opponentMessageTime () const
	get time when opponent message is received More...
const std::list< HearMessage > &	opponentMessages () const
	get the last received opponent messages More...
const GameTime &	freeformMessageTime () const
	get the time when last freeform message is received More...
const std::string &	freeformMessage () const
	get the last received freeform message More...
const GameTime &	trainerMessageTime () const
	get the time when last freeform message is received More...
const std::string &	trainerMessage () const
	get the last received trainer message info More...
const GameTime &	clangTime () const
	get the time when last clang is received. More...
const std::string &	clangMessage () const
	get the last clang message More...
const CLangParser &	clangParser () const
	get the clang parser object More...

Detailed Description

processor for players' communication

Member Function Documentation

addFreeformMessageParser()

void rcsc::AudioSensor::addFreeformMessageParser

(

FreeformMessageParser::Ptr

parser

)

set new freeform message parer.

Parameters

parser

shared_ptr of player message parser instance

addSayMessageParser()

void rcsc::AudioSensor::addSayMessageParser

(

SayMessageParser::Ptr

parser

)

add new player message parer.

Parameters

parser

shared_ptr of player message parser instance

clangMessage()

const std::string & rcsc::AudioSensor::clangMessage ( ) const

inline

get the last clang message

Returns

message string

clangParser()

const CLangParser & rcsc::AudioSensor::clangParser ( ) const

inline

get the clang parser object

Returns

const reference to the clang parser object;

clangTime()

const GameTime & rcsc::AudioSensor::clangTime ( ) const

inline

get the time when last clang is received.

Returns

game time

freeformMessage()

const std::string & rcsc::AudioSensor::freeformMessage ( ) const

inline

get the last received freeform message

Returns

const reference to the message object instance

freeformMessageTime()

const GameTime & rcsc::AudioSensor::freeformMessageTime ( ) const

inline

get the time when last freeform message is received

Returns

game time variable

opponentMessages()

const std::list< HearMessage > & rcsc::AudioSensor::opponentMessages ( ) const

inline

get the last received opponent messages

Returns

const reference to the message object container

opponentMessageTime()

const GameTime & rcsc::AudioSensor::opponentMessageTime ( ) const

inline

get time when opponent message is received

Returns

const referncd to the game time

parseCoachMessage()

void rcsc::AudioSensor::parseCoachMessage	(	const char *	msg,
		const GameTime &	current
	)

analyze message from online coach

Parameters

msg	raw server message
current	game time when message is received

parsePlayerMessage()

void rcsc::AudioSensor::parsePlayerMessage	(	const char *	msg,
		const GameTime &	current
	)

analyze other player's audio message

Parameters

msg	raw server message
current	game time when message is received

parseTrainerMessage()

void rcsc::AudioSensor::parseTrainerMessage	(	const char *	msg,
		const GameTime &	current
	)

analyze trainer's audio message

Parameters

msg	raw server message
current	game time when message is received

removeFreeformMessageParser()

void rcsc::AudioSensor::removeFreeformMessageParser

(

const std::string &

type

)

remove registerd freeform parser object

Parameters

type

removeSayMessageParser()

void rcsc::AudioSensor::removeSayMessageParser

(

const char

header

)

remove registered parser object

Parameters

header

say message header character

teammateMessages()

const std::list< HearMessage > & rcsc::AudioSensor::teammateMessages ( ) const

inline

get the last received teammate messages

Returns

const reference to the message object container

teammateMessageTime()

const GameTime & rcsc::AudioSensor::teammateMessageTime ( ) const

inline

get time when teammate message is received

Returns

const referncd to the game time

trainerMessage()

const std::string & rcsc::AudioSensor::trainerMessage ( ) const

inline

get the last received trainer message info

Returns

const reference to the message object instance

trainerMessageTime()

const GameTime & rcsc::AudioSensor::trainerMessageTime ( ) const

inline

get the time when last freeform message is received

Returns

game time variable

---

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

• /home/kali/rc/tools/include/rcsc/player/audio_sensor.h