otbGDALDriverManagerWrapper.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbGDALDriverManagerWrapper_h
#define otbGDALDriverManagerWrapper_h
 
 
#include "itkLightObject.h"
#include "itkProcessObject.h"
#include "otbConfigure.h"
 
class GDALDataset;
class GDALDriver;
 
/* GDAL Libraries */
#include "gdal.h"
#include "gdaljp2metadata.h"
#include "gdal_priv.h"
#include "gdal_alg.h"
 
#include "otbGDALDatasetWrapper.h"
// otb::GDALOverviewsBuilder moved to self header & body files.
// Including its header file here for compile time compatibility.
#include "otbGDALOverviewsBuilder.h"
 
namespace otb
{
 
// Wraps the GdalDriverManager so that GDALAllRegister is called automatically
class GDALDriverManagerWrapper
{
public:
  // GetInstance returns a reference to a GDALDriverManagerWrapper
  // This is the only entry point to interact with this class
  static GDALDriverManagerWrapper& GetInstance()
  {
 
    // Declare a static method variable of type GDALDriverManagerWrapper
    // so that it is constructed and initialized only on the first call
    // to GetInstance(), and so try to avoid static initialization order problems
 
    static GDALDriverManagerWrapper theUniqueInstance;
    return theUniqueInstance;
  }
 
  // Open the file for reading and returns a smart dataset pointer
  GDALDatasetWrapper::Pointer Open(std::string filename) const;
 
  // Open the new  file for writing and returns a smart dataset pointer
  GDALDatasetWrapper::Pointer Create(std::string& driverShortName, std::string filename, int nXSize, int nYSize, int nBands, GDALDataType eType,
                                     char** papszOptions) const;
 
  GDALDatasetWrapper::Pointer OpenFromMemory(
                                void* mem_ptr,
                                const uint64_t& width,
                                const uint64_t& height,
                                const GDALDataType pix_type,
                                const uint32_t byte_per_pixel,
                                const uint16_t nb_bands = 1,
                                const uint64_t& band_offset = 1) const;
 
  GDALDriver* GetDriverByName(std::string driverShortName) const;
 
private:
  // private constructor so that this class is allocated only inside GetInstance
  GDALDriverManagerWrapper();
 
  ~GDALDriverManagerWrapper();
}; // end of GDALDriverManagerWrapper
 
 
} // end namespace otb
 
 
#endif // otbGDALDriverManagerWrapper_h