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::ConfFileParser Class Reference

config file parser More...

#include <conf_file_parser.h>

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

Public Member Functions

 ConfFileParser (const std::string &file_path, const std::string &delim=":=", const std::string &realm="")
 construct with file path and delimiters More...
 
bool parse (ParamMap &param_map) override
 analyze file content and results are stored to parameter map More...
 
- Public Member Functions inherited from rcsc::ParamParser
virtual ~ParamParser ()
 virtual destructor
 
virtual bool parse (ParamMap &param_map)=0
 interface method More...
 

Additional Inherited Members

- Protected Member Functions inherited from rcsc::ParamParser
 ParamParser ()=default
 protected access
 

Detailed Description

config file parser

Constructor & Destructor Documentation

◆ ConfFileParser()

rcsc::ConfFileParser::ConfFileParser ( const std::string &  file_path,
const std::string &  delim = ":=",
const std::string &  realm = "" 
)
explicit

construct with file path and delimiters

Parameters
file_pathpath string to the config file to be parsed
delimdelimiter character set
realmrealm string

Member Function Documentation

◆ parse()

bool rcsc::ConfFileParser::parse ( ParamMap param_map)
overridevirtual

analyze file content and results are stored to parameter map

Parameters
param_mapreference to the parameter container
Returns
true if successfully parserd

Implements rcsc::ParamParser.


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