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 | Protected Member Functions | List of all members
rcsc::FormationParserV3 Class Reference

v3 formation parser interface More...

#include <formation_parser_v3.h>

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

Public Member Functions

 FormationParserV3 ()=default
 default constructor
 
 ~FormationParserV3 () override
 virtual default destructor
 
virtual std::string name () const override
 get the parser name More...
 
- Public Member Functions inherited from rcsc::FormationParser
virtual ~FormationParser ()=default
 virtual default destructor
 
virtual std::string name () const =0
 get the parser name More...
 

Protected Member Functions

Formation::Ptr parseImpl (std::istream &is) override
 parse the input stream More...
 
- Protected Member Functions inherited from rcsc::FormationParser
 FormationParser ()=default
 default constructor
 
virtual Formation::Ptr parseImpl (std::istream &is)=0
 parse the input stream More...
 
bool checkRoleNames (const Formation::ConstPtr ptr)
 check the consistency of role names More...
 
bool checkPositionPair (const Formation::ConstPtr ptr)
 check the consistency of position pairs More...
 

Additional Inherited Members

- Public Types inherited from rcsc::FormationParser
typedef std::shared_ptr< FormationParserPtr
 smart pointer type
 
- Static Public Member Functions inherited from rcsc::FormationParser
static Formation::Ptr parse (const std::string &filepath)
 parse the given file More...
 

Detailed Description

v3 formation parser interface

Member Function Documentation

◆ name()

virtual std::string rcsc::FormationParserV3::name ( ) const
inlineoverridevirtual

get the parser name

Returns
parser name

Implements rcsc::FormationParser.

◆ parseImpl()

Formation::Ptr rcsc::FormationParserV3::parseImpl ( std::istream &  is)
overrideprotectedvirtual

parse the input stream

Parameters
isreference to the input stream to be parsed
Returns
formation instance

Implements rcsc::FormationParser.


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