add a parser to read the UID per user

This commit is contained in:
Sven Czarnian
2021-08-10 08:42:00 +02:00
parent 163786698c
commit 81edcdcea2
3 changed files with 148 additions and 0 deletions

View File

@@ -0,0 +1,51 @@
/*
* @brief Defines the communication file format
* @file aman/config/CommunicationFileFormat.h
* @author Sven Czarnian <devel@svcz.de>
* @copyright Copyright 2021 Sven Czarnian
* @license This project is published under the GNU General Public License v3 (GPLv3)
*/
#pragma once
#include <aman/config/FileFormat.h>
#include <aman/types/Communication.h>
namespace aman {
/**
* @brief Defines the parser of communication configurations
* @ingroup format
*
* All configuration entries need to be stored in 'AmanCommunication.txt'.
*
* The following entries of the configuration exist:
* <table>
* <caption id="multi_row">Setting entries</caption>
* <tr>
* <th>Name</th><th>Description</th><th>Default value</th><th>Unit</th>
* </tr>
* <tr>
* <td>UID</td>
* <td>Defines the identifier to access the backend.</td>
* <td></td><td></td>
* </tr>
* </table>
*/
class IdentifierFileFormat : public FileFormat {
#ifndef DOXYGEN_IGNORE
public:
/**
* @brief Initializes the identifier file format
*/
IdentifierFileFormat();
/**
* @brief Parses the set configuration file
* @param[in] filename The path to the configuration file
* @param[out] config The resulting configuration
* @return True if the configuration file was valid, else false
*/
bool parse(const std::string& filename, Communication& config);
#endif
};
}