/*
 * @project      The CERN Tape Archive (CTA)
 * @copyright    Copyright © 2021-2022 CERN
 * @license      This program is free software, distributed under the terms of the GNU General Public
 *               Licence version 3 (GPL Version 3), copied verbatim in the file "COPYING". You can
 *               redistribute it and/or modify it under the terms of the GPL Version 3, 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.
 *
 *               In applying this licence, CERN does not waive the privileges and immunities
 *               granted to it by virtue of its status as an Intergovernmental Organization or
 *               submit itself to any jurisdiction.
 */

#pragma once

#include <list>
#include <map>
#include <stdint.h>
#include <string>

#include "common/dataStructures/EntryLog.hpp"

namespace cta::common::dataStructures {

/**
 * The archive route specifies which tape pool will be used as a destination of 
 * a specific copy of a storage class 
 */
struct ArchiveRoute {

  ArchiveRoute();

  bool operator==(const ArchiveRoute &rhs) const;

  bool operator!=(const ArchiveRoute &rhs) const;

  /**
   * The name of the storage class which is only guranateed to be unique within
   * its disk instance.
   */
  std::string storageClassName;

  /**
   * The cipy number of the tape file.
   */
  uint8_t copyNb;

  std::string tapePoolName;
  EntryLog creationLog;
  EntryLog lastModificationLog;
  std::string comment;
  
  typedef std::map<uint32_t, ArchiveRoute> StorageClassMap;
  typedef std::map<std::string /*storage class*/, StorageClassMap> FullMap;

}; // struct ArchiveRoute

std::ostream &operator<<(std::ostream &os, const ArchiveRoute &obj);

} // namespace cta::common::dataStructures