FichierHDF.h

/****************************************************************************
* Copyright (c) 2022, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
#ifndef FichierHDF_included
#define FichierHDF_included
 
 
#include <Entree_Brute.h>
#include <Sortie_Brute.h>
#include <Nom.h>
#include <Noms.h>
#include <SChaine.h>
 
#include <med.h>
#ifdef MED_H
#ifndef MED_
#define MED_
#endif
#else
#undef MED_
#endif
 
#ifdef MED_
#include <hdf5.h>
#endif
 
 
/*! @brief This abstract class provides all the functionalities to open and manipulate HDF files and related concepts (datasets, groups, etc .
 *
 * ..)
 *    It intentionally does not place itself in the Sortie_Fichier_base or Entree_Fichier_base hierarchy
 *    since it is rather the datasets inside the HDF file that are regarded as TRUST Fichier objects.
 *
 */
class FichierHDF
{
public:
  FichierHDF();
  virtual ~FichierHDF();
 
  // Creates (and open) the HDF file.
  virtual void create(Nom filename);
  virtual void open(Nom filename, bool readOnly);
  virtual void close();
 
  // Multiple Writer methods:
  // every processor writes their own dataset into the file
  virtual void create_and_fill_dataset_MW(Nom dataset_basename, Sortie_Brute& sortie);
  virtual void create_and_fill_dataset_MW(Nom dataset_basename, SChaine& sortie);
 
  // Method to write the dataset owned by proc #proc_rank in the given file
  // (to use when a single proc writes all the datasets for example)
  virtual void create_and_fill_dataset_SW(Nom datasetname, Sortie_Brute& sortie);
 
  // Method to read the dataset owned by proc #proc_rank in the given file
  virtual void read_dataset(Nom dataset_basename, int proc_rank, Entree_Brute& entree);
 
  // Method to create datasets of size length and whose names are given by dataset_names
  // to use when a process has multiple datasets to write
#ifdef MED_
  void create_datasets(Noms dataset_names, hsize_t length);
#else
  void create_datasets(Noms dataset_names, long length) { throw; }
#endif
 
  // Method to write sortie into the specified dataset
  void fill_dataset(Nom dataset_name, Sortie_Brute& sortie);
 
  // checks if a dataset named dataset_name exists in the file
  virtual bool exists(const char* dataset_name);
  //check if the file file_name is in the HDF5 format
  static bool is_hdf5(const char *file_name);
  // Checks if HDF file was written in int32 or int64, and sets 'is_different_int_size_' accordingly
  void  check_int_size(Nom filename);
  void  set_int_size();
 
protected:
  virtual void prepare_file_props();
  virtual void prepare_dataset_props();
#ifdef MED_
  void create_and_fill_dataset_MW(Nom dataset_basename, const char* data, hsize_t lenData, hid_t datatype);
 
  hid_t file_id_;
  hid_t file_access_plst_;
  hid_t dataset_transfer_plst_;
  bool is_different_int_size_=false; // File with int32 (or int64) whereas version is int64 (or int32)
#endif
 
private:
  // Forbid copy:
  FichierHDF& operator=(const FichierHDF&);
  FichierHDF(const FichierHDF&);
 
};
#endif