/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
 * Belgium
 *
 * 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.
 *
 * In addition, as a special exception, the copyright holders of this
 * program give permission to link the code of its release with the
 * OpenSSL project's "OpenSSL" library (or with modified versions of it
 * that use the same license as the "OpenSSL" library), and distribute
 * the linked executables. You must obey the GNU General Public License
 * in all respects for all of the code used other than "OpenSSL". If you
 * modify file(s) with this exception, you may extend this exception to
 * your version of the file(s), but you are not obligated to do so. If
 * you do not wish to do so, delete this exception statement from your
 * version. If you delete this exception statement from all source files
 * in the program, then also delete it here.
 * 
 * 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 "Series.h"

namespace OrthancClient
{
  /**
   * {summary}{Connection to a study stored in %Orthanc.}
   * {description}{This class encapsulates a connection to a study
   * from a remote instance of %Orthanc.}
   **/
  class LAAW_API Study : 
    public Orthanc::IDynamicObject, 
    private Orthanc::ArrayFilledByThreads::IFiller
  {
  private:
    const OrthancConnection& connection_;
    std::string id_;
    Json::Value study_;
    Orthanc::ArrayFilledByThreads  series_;

    void ReadStudy();

    virtual size_t GetFillerSize()
    {
      return study_["Series"].size();
    }

    virtual Orthanc::IDynamicObject* GetFillerItem(size_t index);

  public:
    /**
     * {summary}{Create a connection to some study.}
     * {param}{connection The remote instance of %Orthanc.}
     * {param}{id The %Orthanc identifier of the study.}
     **/
    Study(const OrthancConnection& connection,
          const char* id);

    /**
     * {summary}{Reload the series of this study.}
     * {description}{This method will reload the list of the series of this study. Pay attention to the fact that the series that have been previously returned by GetSeries() will be invalidated.}
     **/
    void Reload()
    {
      series_.Reload();
    }

    /**
     * {summary}{Return the number of series for this study.}
     * {returns}{The number of series.}
     **/
    uint32_t GetSeriesCount()
    {
      return series_.GetSize();
    }

    /**
     * {summary}{Get some series of this study.}
     * {description}{This method will return an object that contains information about some series. The series are indexed by a number between 0 (inclusive) and the result of GetSeriesCount() (exclusive).}
     * {param}{index The index of the series of interest.}
     * {returns}{The series.}
     **/
    Series& GetSeries(uint32_t index)
    {
      return dynamic_cast<Series&>(series_.GetItem(index));
    }
    
    /**
     * {summary}{Get the %Orthanc identifier of this study.}
     * {returns}{The identifier.}
     **/
    const char* GetId() const
    {
      return id_.c_str();
    }

    /**
     * {summary}{Get the value of one of the main DICOM tags for this study.}
     * {param}{tag The name of the tag of interest ("StudyDate", "StudyDescription", "StudyInstanceUID" or "StudyTime").}
     * {param}{defaultValue The default value to be returned if this tag does not exist.}
     * {returns}{The value of the tag.}
     **/
    const char* GetMainDicomTag(const char* tag, 
                                const char* defaultValue) const;
  };
}