/*
 * @project        The CERN Tape Archive (CTA)
 * @copyright      Copyright(C) 2003-2021 CERN
 * @license        This program is free software: you can redistribute it and/or modify
 *                 it under the terms of the GNU General Public License as published by
 *                 the Free Software Foundation, either version 3 of the License, or
 *                 (at your option) any later version.
 *
 *                 This program is distributed in the hope that it will be useful,
 *                 but WITHOUT ANY WARRANTY; without even the implied warranty of
 *                 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *                 GNU General Public License for more details.
 *
 *                 You should have received a copy of the GNU General Public License
 *                 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once
#include <string>
#include "tapeserver/castor/tape/tapeserver/daemon/DataTransferConfig.hpp"
#include "tapeserver/castor/tape/tapeserver/SCSI/Structures.hpp"
#include <memory>
#include <common/log/LogContext.hpp>
#include <vector>
#include "catalogue/Catalogue.hpp"
#include "RAOOptions.hpp"

namespace castor { namespace tape { namespace tapeserver { namespace rao {
  
  /**
   * This class contains the configuration of the CTA RAO Algorithm
   */
  class RAOParams{
  public:
    /**
     * This enum represent the RAO algorithm type implemented
     * by CTA
     */
    enum RAOAlgorithmType {
      linear,
      random,
      //Short Locate Time First
      sltf
    };
    
    /**
     * Default constructor, sets useRAO to false
     */
    RAOParams();
    
    /**
     * Construct an RAOParams object
     * @param useRAO if set to true, the RAO will be enabled. If false, not enabled.
     * @param raoAlgorithmName the RAO algorithm that will be executed when called
     * @param raoAlgorithmOptions the options that could be passed to the RAO algorithm
     * @param vid the vid of the tape that is currently mounted for retrieval
     */
    RAOParams(const bool useRAO, const std::string & raoAlgorithmName, const std::string & raoAlgorithmOptions, const std::string & vid);
    
    /**
     * Copy constructor
     */
    RAOParams(const RAOParams & other);
    
    /**
     * Operator =
     */
    RAOParams & operator=(const RAOParams & other);
    
    /**
     * Returns true if RAO has to be used, false otherwise
     */
    bool useRAO() const;
    
    /**
     * Returns the RAO algorithm name of this RAO data instance
     */
    std::string getRAOAlgorithmName() const;
    
    /**
     * Returns the RAO algorithm options of this RAO data instance
     */
    RAOOptions getRAOAlgorithmOptions() const;
    
    /**
     * Disable RAO of this configuration
     */
    void disableRAO();
    
    /**
     * Returns RAOAlgorithmType object corresopnding to this configration's raoAlgorithmName
     * @return the RAOAlgorithmType object corresopnding to this configration raoAlgorithmName
     * @throws cta::exception::Exception in case the algorithm name does not match any RAOAlgorithmType
     */
    RAOAlgorithmType getAlgorithmType() const;
    
    /**
     * Returns the CTA RAO algorithm names that can be used
     */
    std::string getCTARAOAlgorithmNameAvailable() const;
    
    /**
     * Returns the vid of the tape that is mounted for retrieval
     */
    std::string getMountedVid() const;
    
  private:
    bool m_useRAO = false;
    std::string m_raoAlgorithmName;
    RAOOptions m_raoAlgorithmOptions;
    std::string m_vid;
    
    
    /**
     * Static map in order to match the string representing an algorithm name and its enum type
     */
    static const std::map<std::string, RAOAlgorithmType> c_raoAlgoStringTypeMap;
  };
  
  
}}}}