view OrthancServer/Plugins/Engine/OrthancPluginDatabaseV4.h @ 5873:c8788f8f5322

todo
author Alain Mazy <am@orthanc.team>
date Mon, 18 Nov 2024 15:16:16 +0100
parents f7adfb22e20e
children 3f13db27b399 8279eaab0d1d
line wrap: on
line source

/**
 * Orthanc - A Lightweight, RESTful DICOM Store
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2023 Osimis S.A., Belgium
 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, 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.
 * 
 * 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

#if ORTHANC_ENABLE_PLUGINS == 1

#include "../../../OrthancFramework/Sources/SharedLibrary.h"
#include "../../Sources/Database/IDatabaseWrapper.h"
#include "../Include/orthanc/OrthancCPlugin.h"
#include "PluginsErrorDictionary.h"

namespace Orthanc
{
  class OrthancPluginDatabaseV4 : public IDatabaseWrapper
  {
  private:
    class Transaction;

    SharedLibrary&                          library_;
    PluginsErrorDictionary&                 errorDictionary_;
    _OrthancPluginRegisterDatabaseBackendV4 definition_;
    std::string                             serverIdentifier_;
    bool                                    open_;
    unsigned int                            databaseVersion_;
    IDatabaseWrapper::Capabilities          dbCapabilities_;

    void CheckSuccess(OrthancPluginErrorCode code) const;

  public:
    OrthancPluginDatabaseV4(SharedLibrary& library,
                            PluginsErrorDictionary& errorDictionary,
                            const _OrthancPluginRegisterDatabaseBackendV4& database,
                            const std::string& serverIdentifier);

    virtual ~OrthancPluginDatabaseV4();

    const _OrthancPluginRegisterDatabaseBackendV4& GetDefinition() const
    {
      return definition_;
    }

    PluginsErrorDictionary& GetErrorDictionary() const
    {
      return errorDictionary_;
    }

    const std::string& GetServerIdentifier() const
    {
      return serverIdentifier_;
    }
    
    virtual void Open() ORTHANC_OVERRIDE;

    virtual void Close() ORTHANC_OVERRIDE;

    const SharedLibrary& GetSharedLibrary() const
    {
      return library_;
    }

    virtual void FlushToDisk() ORTHANC_OVERRIDE;

    virtual IDatabaseWrapper::ITransaction* StartTransaction(TransactionType type,
                                                             IDatabaseListener& listener)
      ORTHANC_OVERRIDE;

    virtual unsigned int GetDatabaseVersion() ORTHANC_OVERRIDE;

    virtual void Upgrade(unsigned int targetVersion,
                         IStorageArea& storageArea) ORTHANC_OVERRIDE;    

    virtual uint64_t MeasureLatency() ORTHANC_OVERRIDE;

    virtual const Capabilities GetDatabaseCapabilities() const ORTHANC_OVERRIDE;
  };
}

#endif