iv::logic::files::PlFileCoder Class Reference

Class to encode and decode PL files. More...

#include <PlFileCoder.hpp>

Classes
struct	Keys
struct	Sections

Static Public Member Functions
static iv::logic::files::PlFile	readPlFile (std::string_view plFilePath)
	Read a PL file.
static iv::logic::files::PlFile	readPlFileFromXml (std::string_view plFilePath)
static bool	writePlFile (const iv::logic::files::PlFile &plFile, std::string_view plFilePath)
	Write a PL file.
static bool	writeXmlPlFile (const iv::logic::files::PlFile &plFile, std::string_view xmlPlFilePath)

Detailed Description

Class to encode and decode PL files.

Note

This class is in charge of writing the correct data structure in the PL file and reading it.

Member Function Documentation

readPlFile()

iv::logic::files::PlFile iv::logic::files::PlFileCoder::readPlFile ( std::string_view plFilePath )

static

Read a PL file.

Parameters

plFilePath

Path to the PL file.

Returns

Read PlFile.

readPlFileFromXml()

iv::logic::files::PlFile iv::logic::files::PlFileCoder::readPlFileFromXml ( std::string_view plFilePath )

static

writePlFile()

bool iv::logic::files::PlFileCoder::writePlFile ( const iv::logic::files::PlFile & plFile, std::string_view plFilePath )

static

Write a PL file.

Parameters

plFile	PlFile to write.
plFilePath	Path to write the PL file.

Returns

True if the file was written successfully, false otherwise.

writeXmlPlFile()

bool iv::logic::files::PlFileCoder::writeXmlPlFile ( const iv::logic::files::PlFile & plFile, std::string_view xmlPlFilePath )

static

---

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

• src/logic/files/PlFileCoder.hpp
• src/logic/files/PlFileCoder.cpp