idatasource.h

Go to the documentation of this file.

/*! @brief This file have the interface for the IDataSource class.
    @file idatasource.h
    @author Alvaro Denis <denisacostaq@gmail.com>
    @date 6/19/2019

    @copyright
    @attention <h1><center><strong>COPYRIGHT &copy; 2019 </strong>
    [<strong>denisacostaq</strong>][denisacostaq-URL].
    All rights reserved.</center></h1>
    @attention This file is part of [<strong>DAQs</strong>][DAQs-URL].

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    - 1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    - 2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    - 3. Neither the name of the University nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

    THIS PRODUCT IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    THIS PRODUCT, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    [denisacostaq-URL]: https://about.me/denisacostaq "Alvaro Denis Acosta"
    [DAQs-URL]: https://github.com/denisacostaq/DAQs "DAQs"
 */
#ifndef DATABASE_SERVER_IDATASOURCE_H
#define DATABASE_SERVER_IDATASOURCE_H

#include <chrono>
#include <functional>
#include <string>

#include "src/database-server/data-model/variable.h"
#include "src/database-server/data-model/varvalue.h"

/**
 * @brief The IDataSource class is an interface for the physycal storage.
 * @details A variable is related for example with sensors, like temperature,
 * luminosity, ... A value is for example the numerica value for a
 * temperature sensor.
 * @sa add_variable_value, add_variable_value
 */
class IDataSource {
 public:
  enum class Err { Ok, Failed };

  IDataSource() = default;
  virtual ~IDataSource() = default;
  IDataSource(const IDataSource&) = delete;
  IDataSource& operator=(const IDataSource&) = delete;
  IDataSource(IDataSource&&) = default;
  IDataSource& operator=(IDataSource&&) = default;

  /**
   * @brief create_scheme create data storage persistence, e.g. schema for a
   * relational database
   * @return Err::Ok on succes
   */
  virtual Err create_scheme() noexcept = 0;

  /**
   * @brief add_variable add a variable to be tracket for the system (by default
   * the only supported variabe value type is double).
   * @param variable to be created in the physical storage.
   * @return Err::Ok on succes.
   * @sa add_variable_value
   */
  virtual Err add_variable(const Variable& variable) noexcept = 0;

  /**
   * @brief add_variable_value add a new value for the variable.
   * @param var_value variable value to be inserted in the storage.
   * @return Err::Ok on succes
   * @sa add_variable
   */
  virtual Err add_variable_value(const VarValue& var_value) noexcept = 0;

  /**
   * @brief fetch_variables get all variables
   * @param send_vale the variables will be send in this callback, one at a
   * time, index is the current value index.
   * @return Err::Ok on succes
   */
  virtual Err fetch_variables(
      const std::function<void(const Variable& var, size_t index)>&
          send_vale) noexcept = 0;

  /**
   * @brief fetch_variable_values get all values of a given variable
   * @param var_name variable name to get the values from
   * @param send_vale the values will be send in this callback, one at a time,
   * index is the current value index.
   * @return Err::Ok on succes
   */
  virtual Err fetch_variable_values(
      const std::string& var_name,
      const std::function<void(const VarValue& val, size_t index)>&
          send_vale) noexcept = 0;

  /**
   * @brief count_variable_values count all values of a given variable
   * @param var_name variable name to count the values from
   * @param send_count in this callack you can receive the number of values for
   * the given variable
   * @return Err::Ok on success
   */
  virtual Err count_variable_values(
      const std::string& var_name,
      const std::function<void(size_t count)>& send_count) noexcept = 0;

  /**
   * @brief fetch_variable_values get all values of a given variables in a date
   * range
   * @param var_name variable name to get the values from
   * @param start_date begin of the date range
   * @param end_date end of the date range
   * @param send_vale the values will be send in this callback, one at a time,
   * index is the current value index.
   * @return Err::Ok on succes
   */
  virtual Err fetch_variable_values(
      const std::string& var_name,
      const std::chrono::system_clock::time_point& start_date,
      const std::chrono::system_clock::time_point& end_date,
      const std::function<void(const VarValue& val, size_t index)>&
          send_vale) noexcept = 0;

  /**
   * @brief count_variable_values count all values of a given variable
   * @param var_name variable name to count the values from
   * @param start_date begin of the date range
   * @param end_date end of the date range
   * @param send_count in this callack you can receive the number of values for
   * the given variable
   * @return Err::Ok on success.
   */
  virtual Err count_variable_values(
      const std::string& var_name,
      const std::chrono::system_clock::time_point& start_date,
      const std::chrono::system_clock::time_point& end_date,
      const std::function<void(size_t count)>& send_count) noexcept = 0;
};

#endif  //  DATABASE_SERVER_IDATASOURCE_H