view OrthancServer/DicomProtocol/IFindRequestHandler.h @ 1764:9ead18ef460a

escape
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 29 Oct 2015 16:08:59 +0100
parents 3309878b3e16
children 164d78911382
line wrap: on
line source

/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
 * Department, University Hospital 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 "DicomFindAnswers.h"

#include <vector>
#include <string>


namespace Orthanc
{
  class IFindRequestHandler
  {
  public:
    virtual ~IFindRequestHandler()
    {
    }

    /**
     * Can throw exceptions. Returns "false" iff too many results have
     * to be returned. In such a case, a "Matching terminated due to
     * Cancel request" DIMSE code would be returned.
     * https://www.dabsoft.ch/dicom/4/V.4.1/
     **/
    virtual bool Handle(DicomFindAnswers& answers,
                        const DicomMap& input,
                        const std::string& remoteIp,
                        const std::string& remoteAet) = 0;
  };
}