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::FreeMessageParser< LEN > Class Template Reference

player's freeform say message parser More...

#include <free_message_parser.h>

Inheritance diagram for rcsc::FreeMessageParser< LEN >:
Inheritance graph
[legend]
Collaboration diagram for rcsc::FreeMessageParser< LEN >:
Collaboration graph
[legend]

Public Member Functions

 FreeMessageParser (std::shared_ptr< AudioMemory > memory)
 construct with audio memory More...
 
char header () const
 get the header character. More...
 
int parse (const int unum, const double &, const char *msg, const GameTime &current)
 virtual method which analyzes audio messages. More...
 
- Public Member Functions inherited from rcsc::SayMessageParser
virtual ~SayMessageParser ()=default
 virtual destruct. do nothing.
 
virtual char header () const =0
 pure virtual method that returns header character. More...
 
virtual int parse (const int sender, const double &dir, const char *msg, const GameTime &current)=0
 virtual method which analyzes audio messages. More...
 

Additional Inherited Members

- Public Types inherited from rcsc::SayMessageParser
typedef std::shared_ptr< SayMessageParserPtr
 pointer type alias
 
- Protected Member Functions inherited from rcsc::SayMessageParser
 SayMessageParser ()=default
 protected constructer
 

Detailed Description

template<std::size_t LEN>
class rcsc::FreeMessageParser< LEN >

player's freeform say message parser

Constructor & Destructor Documentation

◆ FreeMessageParser()

template<std::size_t LEN>
rcsc::FreeMessageParser< LEN >::FreeMessageParser ( std::shared_ptr< AudioMemory memory)
inlineexplicit

construct with audio memory

Parameters
memorypointer to the memory

Member Function Documentation

◆ header()

template<std::size_t LEN>
char rcsc::FreeMessageParser< LEN >::header ( ) const
inlinevirtual

get the header character.

Returns
header character.

Implements rcsc::SayMessageParser.

◆ parse()

template<std::size_t LEN>
int rcsc::FreeMessageParser< LEN >::parse ( const int  unum,
const double &  ,
const char *  msg,
const GameTime current 
)
inlinevirtual

virtual method which analyzes audio messages.

Parameters
unumsender's uniform number
msgraw audio message
currentcurrent game time
Return values
bytesread if success
0message ID is not match. other parser should be tried.
-1failed to parse

Implements rcsc::SayMessageParser.


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