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::rcg::ParserV3 Class Reference

rcg v3 parser class More...

#include <parser_v3.h>

Inheritance diagram for rcsc::rcg::ParserV3:
Inheritance graph
[legend]
Collaboration diagram for rcsc::rcg::ParserV3:
Collaboration graph
[legend]

Public Member Functions

int version () const override
 get supported rcg version More...
 
bool parse (std::istream &is, Handler &handler) const override
 parse input stream More...
 
- Public Member Functions inherited from rcsc::rcg::Parser
virtual ~Parser ()
 virtual destructor
 
virtual int version () const =0
 (pure virtual) get log version More...
 
virtual bool parse (std::istream &is, Handler &handler) const =0
 (pure virtual) analyze log data from input stream More...
 

Additional Inherited Members

- Public Types inherited from rcsc::rcg::Parser
typedef std::shared_ptr< ParserPtr
 rcg parser pointer type
 
typedef Ptr(* Creator) ()
 rcg parser creator function
 
typedef rcss::Factory< Creator, int > Creators
 creator function holder
 
- Static Public Member Functions inherited from rcsc::rcg::Parser
static Creatorscreators ()
 factory holder singleton More...
 
static Ptr create (std::istream &is)
 create a suitable version parser instance depending on the input stream. More...
 
- Protected Member Functions inherited from rcsc::rcg::Parser
 Parser ()=default
 constructor is accessible only from the derived classes.
 

Detailed Description

rcg v3 parser class

Member Function Documentation

◆ parse()

bool rcsc::rcg::ParserV3::parse ( std::istream &  is,
Handler handler 
) const
overridevirtual

parse input stream

Parameters
isreference to the imput stream (usually ifstream/gzifstream).
handlerreference to the rcg data handler.
Return values
true,ifsuccessfuly parsed.
false,ifincorrect format is detected.

Implements rcsc::rcg::Parser.

◆ version()

int rcsc::rcg::ParserV3::version ( ) const
inlineoverridevirtual

get supported rcg version

Returns
version number

Implements rcsc::rcg::Parser.


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