Reader Class Reference

The Reader class. More...

#include <RobotAPI/libraries/aron/codegeneration/typereader/xml/Reader.h>

+ Inheritance diagram for Reader:

Public Member Functions

void parseFile (const std::filesystem::path &file, const std::vector< std::filesystem::path > &includePaths={}) override
 path a file given by std::filesystem More...
 
void parseFile (const std::string &filename, const std::vector< std::filesystem::path > &includePaths={}) override
 parse a filename More...
 
 Reader ()=default
 
- Public Member Functions inherited from Reader< std::string >
std::vector< std::string > getAronIncludes () const
 
std::vector< std::string > getCodeIncludes () const
 
std::vector< typereader::GenerateIntEnumInfogetGenerateIntEnums () const
 
std::vector< typereader::GenerateObjectInfogetGenerateObjects () const
 
std::vector< codegenerator::ReaderInfogetReaders () const
 
std::vector< codegenerator::WriterInfogetWriters () const
 
 Reader ()=default
 

Static Public Attributes

static const constexpr char * ARON_FILE_SUFFIX = ".xml"
 
static const constexpr char * CODE_FILE_SUFFIX = ".aron.generated.codesuffix"
 

Additional Inherited Members

- Protected Attributes inherited from Reader< std::string >
std::vector< std::string > alreadyParsedXMLFiles
 
std::vector< std::string > aronIncludes
 
std::vector< typereader::GenerateIntEnumInfogenerateIntEnums
 
std::vector< typereader::GenerateObjectInfogenerateObjects
 
std::vector< codegenerator::ReaderInforeaders
 
std::vector< std::string > systemIncludes
 
std::vector< codegenerator::WriterInfowriters
 

Detailed Description

The Reader class.

It reads a xml-file and returns a type object and codegeneration information (such as additional includes etc)

Definition at line 47 of file Reader.h.

Constructor & Destructor Documentation

◆ Reader()

Reader ( )
default

Member Function Documentation

◆ parseFile() [1/2]

void parseFile ( const std::filesystem::path &  file,
const std::vector< std::filesystem::path > &  includePaths = {} 
)
overridevirtual

path a file given by std::filesystem

Implements Reader< std::string >.

Definition at line 155 of file Reader.cpp.

+ Here is the call graph for this function:

◆ parseFile() [2/2]

void parseFile ( const std::string &  filename,
const std::vector< std::filesystem::path > &  includePaths = {} 
)
overridevirtual

parse a filename

Implements Reader< std::string >.

Definition at line 141 of file Reader.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ ARON_FILE_SUFFIX

const constexpr char* ARON_FILE_SUFFIX = ".xml"
staticconstexpr

Definition at line 76 of file Reader.h.

◆ CODE_FILE_SUFFIX

const constexpr char* CODE_FILE_SUFFIX = ".aron.generated.codesuffix"
staticconstexpr

Definition at line 75 of file Reader.h.


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