List of all members | Public Member Functions | Protected Attributes
Reader< Input > Class Template Referenceabstract

The basic reader class, defining methods for reading an aron description file and returning an aron type object, representing the description It contains basic functions, to read in arbitrary files and to store the type generation information. More...

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

Public Member Functions

std::vector< std::string > getAronIncludes () const
 
std::vector< std::string > getCodeIncludes () const
 
std::vector< typereader::GenerateIntEnumInfo > getGenerateIntEnums () const
 
std::vector< typereader::GenerateObjectInfo > getGenerateObjects () const
 
std::vector< codegenerator::ReaderInfo > getReaders () const
 
std::vector< codegenerator::WriterInfo > getWriters () const
 
virtual void parseFile (const std::filesystem::path &file, const std::vector< std::filesystem::path > &includePaths)=0
 path a file given by std::filesystem More...
 
virtual void parseFile (const std::string &filename, const std::vector< std::filesystem::path > &includePaths)=0
 parse a filename More...
 
 Reader ()=default
 

Protected Attributes

std::vector< std::string > alreadyParsedXMLFiles
 
std::vector< std::string > aronIncludes
 
std::vector< typereader::GenerateIntEnumInfo > generateIntEnums
 
std::vector< typereader::GenerateObjectInfo > generateObjects
 
std::vector< codegenerator::ReaderInfo > readers
 
std::vector< std::string > systemIncludes
 
std::vector< codegenerator::WriterInfo > writers
 

Detailed Description

template<typename Input>
class armarx::aron::typereader::Reader< Input >

The basic reader class, defining methods for reading an aron description file and returning an aron type object, representing the description It contains basic functions, to read in arbitrary files and to store the type generation information.

Definition at line 44 of file Reader.h.

Constructor & Destructor Documentation

◆ Reader()

Reader ( )
default

Member Function Documentation

◆ getAronIncludes()

std::vector<std::string> getAronIncludes ( ) const
inline

Definition at line 59 of file Reader.h.

◆ getCodeIncludes()

std::vector<std::string> getCodeIncludes ( ) const
inline

Definition at line 55 of file Reader.h.

+ Here is the caller graph for this function:

◆ getGenerateIntEnums()

std::vector<typereader::GenerateIntEnumInfo> getGenerateIntEnums ( ) const
inline

Definition at line 75 of file Reader.h.

+ Here is the caller graph for this function:

◆ getGenerateObjects()

std::vector<typereader::GenerateObjectInfo> getGenerateObjects ( ) const
inline

Definition at line 71 of file Reader.h.

+ Here is the caller graph for this function:

◆ getReaders()

std::vector<codegenerator::ReaderInfo> getReaders ( ) const
inline

Definition at line 67 of file Reader.h.

◆ getWriters()

std::vector<codegenerator::WriterInfo> getWriters ( ) const
inline

Definition at line 63 of file Reader.h.

◆ parseFile() [1/2]

virtual void parseFile ( const std::filesystem::path &  file,
const std::vector< std::filesystem::path > &  includePaths 
)
pure virtual

path a file given by std::filesystem

Implemented in Reader.

◆ parseFile() [2/2]

virtual void parseFile ( const std::string &  filename,
const std::vector< std::filesystem::path > &  includePaths 
)
pure virtual

parse a filename

Implemented in Reader.

Member Data Documentation

◆ alreadyParsedXMLFiles

std::vector<std::string> alreadyParsedXMLFiles
protected

Definition at line 81 of file Reader.h.

◆ aronIncludes

std::vector<std::string> aronIncludes
protected

Definition at line 84 of file Reader.h.

◆ generateIntEnums

std::vector<typereader::GenerateIntEnumInfo> generateIntEnums
protected

Definition at line 89 of file Reader.h.

◆ generateObjects

std::vector<typereader::GenerateObjectInfo> generateObjects
protected

Definition at line 90 of file Reader.h.

◆ readers

std::vector<codegenerator::ReaderInfo> readers
protected

Definition at line 86 of file Reader.h.

◆ systemIncludes

std::vector<std::string> systemIncludes
protected

Definition at line 83 of file Reader.h.

◆ writers

std::vector<codegenerator::WriterInfo> writers
protected

Definition at line 87 of file Reader.h.

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