sensor_data_source_configuration.h

Go to the documentation of this file.

/*!
 * \file sensor_data_source_configuration.h
 * \brief
 * \author Victor Castillo, 2024. victorcastilloaguero(at)gmail.com
 *
 * -----------------------------------------------------------------------------
 *
 * GNSS-SDR is a Global Navigation Satellite System software-defined receiver.
 * This file is part of GNSS-SDR.
 *
 * Copyright (C) 2024-2025  (see AUTHORS file for a list of contributors)
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * -----------------------------------------------------------------------------
 */


#ifndef GNSS_SDR_SENSOR_DATA_SOURCE_CONFIGURATION_H
#define GNSS_SDR_SENSOR_DATA_SOURCE_CONFIGURATION_H

#include "configuration_interface.h"
#include "sensor_data_type.h"
#include "sensor_identifier.h"
#include <string>
#include <unordered_map>

/** \addtogroup Algorithms_Library
 * \{ */
/** \addtogroup Algorithm_libs algorithms_libs
 * \{ */

class ConfigurationInterface;

struct SensorDataFileConfiguration
{
    uint64_t id;
    uint64_t chunk_size;
    uint64_t file_offset;
    uint64_t sample_offset;
    uint64_t sample_period;
    std::string filename;
    bool repeat;
};


struct SensorDataConfiguration
{
    uint64_t id;
    uint64_t file_id;
    uint64_t offset;
    SensorIdentifier::value_type identifier;
    SensorDataType::value_type type;
    pmt::pmt_t tag_key;
};


class SensorDataSourceConfiguration
{
public:
    explicit SensorDataSourceConfiguration(const ConfigurationInterface* configuration);

    bool validate() const;

    bool is_enabled() const;

    bool is_sensor_provided(SensorIdentifier::value_type sensor_id) const;

    const std::unordered_map<uint64_t, SensorDataFileConfiguration>& files() const;

    const std::vector<SensorDataConfiguration>& sensors() const;

    void set_items_per_sample(uint64_t items_per_sample);

    uint64_t get_items_per_sample() const;

private:
    void configure_files(const ConfigurationInterface* configuration);

    void configure_sensors(const ConfigurationInterface* configuration);

    bool validate_files() const;

    bool validate_sensors() const;

    bool enabled_;
    std::unordered_map<uint64_t, SensorDataFileConfiguration> files_;
    std::vector<SensorDataConfiguration> sensors_;
    uint64_t items_per_sample_;
};

/** \} */
/** \} */
#endif  // GNSS_SDR_SENSOR_DATA_SOURCE_CONFIGURATION_H