file_configuration.h

Go to the documentation of this file.

/*!
 * \file file_configuration.h
 * \brief A ConfigurationInterface that reads the configuration from a file.
 * \author Carlos Aviles, 2010. carlos.avilesr(at)googlemail.com
 *
 * This implementation has a text file as the source for the values of the parameters.
 * The file is in the INI format, containing sections and pairs of names and values.
 * For more information about the INI format, see https://en.wikipedia.org/wiki/INI_file
 *
 * -----------------------------------------------------------------------------
 *
 * GNSS-SDR is a Global Navigation Satellite System software-defined receiver.
 * This file is part of GNSS-SDR.
 *
 * Copyright (C) 2010-2020  (see AUTHORS file for a list of contributors)
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * -----------------------------------------------------------------------------
 */


#ifndef GNSS_SDR_FILE_CONFIGURATION_H
#define GNSS_SDR_FILE_CONFIGURATION_H

#include "INIReader.h"
#include "configuration_interface.h"
#include "in_memory_configuration.h"
#include "string_converter.h"
#include <cstdint>
#include <memory>
#include <string>

/** \addtogroup Core
 * \{ */
/** \addtogroup Core_Receiver
 * \{ */


/*!
 * \brief This class is an implementation of the interface ConfigurationInterface
 *
 * Derived from ConfigurationInterface, this class implements an interface
 * to a configuration file. This implementation has a text file as the source
 * for the values of the parameters.
 * The file is in the INI format, containing sections and pairs of names and values.
 * For more information about the INI format, see https://en.wikipedia.org/wiki/INI_file
 */
class FileConfiguration : public ConfigurationInterface
{
public:
    explicit FileConfiguration(std::string filename);
    FileConfiguration();
    ~FileConfiguration() = default;
    std::string property(std::string property_name, std::string default_value) const override;
    bool property(std::string property_name, bool default_value) const override;
    int64_t property(std::string property_name, int64_t default_value) const override;
    uint64_t property(std::string property_name, uint64_t default_value) const override;
    int32_t property(std::string property_name, int32_t default_value) const override;
    uint32_t property(std::string property_name, uint32_t default_value) const override;
    int16_t property(std::string property_name, int16_t default_value) const override;
    uint16_t property(std::string property_name, uint16_t default_value) const override;
    float property(std::string property_name, float default_value) const override;
    double property(std::string property_name, double default_value) const override;
    void set_property(std::string property_name, std::string value) override;
    bool is_present(const std::string& property_name) const;
    bool has_section() const;

private:
    void init();
    std::string filename_;
    std::unique_ptr<INIReader> ini_reader_;
    std::unique_ptr<InMemoryConfiguration> overrided_;
    std::unique_ptr<StringConverter> converter_;
    int error_{};
};


/** \} */
/** \} */
#endif  // GNSS_SDR_FILE_CONFIGURATION_H