Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::Hdf5Utils::HProperty Class Reference

Encapsulates a hid_t for a property (H5P*). More...

#include <arcane/hdf5/Hdf5Utils.h>

Public Member Functions

 HProperty (HProperty &&rhs)
HProperty & operator= (HProperty &&rhs)
 HProperty (const HProperty &v)=delete
HProperty & operator= (const HProperty &hid)=delete
void close ()
void create (hid_t cls_id)
void setId (hid_t new_id)
void createFilePropertyMPIIO (IParallelMng *pm)
 Creates a file property for MPIIO.
void createDatasetTransfertCollectiveMPIIO ()
 Creates a dataset property for MPIIO.
void createDatasetTransfertIndependentMPIIO ()
 Creates a dataset property for MPIIO.
Public Member Functions inherited from Arcane::Hdf5Utils::Hid
 Hid (hid_t id)
hid_t id () const
bool isBad () const

Additional Inherited Members

Protected Member Functions inherited from Arcane::Hdf5Utils::Hid
 Hid (const Hid &hid)
void _setId (hid_t id)
void _setNullId ()

Detailed Description

Encapsulates a hid_t for a property (H5P*).

Definition at line 188 of file Hdf5Utils.h.

Constructor & Destructor Documentation

◆ HProperty() [1/2]

Arcane::Hdf5Utils::HProperty::HProperty ( )
inline

Definition at line 193 of file Hdf5Utils.h.

◆ ~HProperty()

Arcane::Hdf5Utils::HProperty::~HProperty ( )
inline

Definition at line 194 of file Hdf5Utils.h.

◆ HProperty() [2/2]

Arcane::Hdf5Utils::HProperty::HProperty ( HProperty && rhs)
inline

Definition at line 198 of file Hdf5Utils.h.

Member Function Documentation

◆ close()

void Arcane::Hdf5Utils::HProperty::close ( )

Definition at line 850 of file Hdf5Utils.cc.

◆ create()

void Arcane::Hdf5Utils::HProperty::create ( hid_t cls_id)

Definition at line 863 of file Hdf5Utils.cc.

◆ createDatasetTransfertCollectiveMPIIO()

void Arcane::Hdf5Utils::HProperty::createDatasetTransfertCollectiveMPIIO ( )

Creates a dataset property for MPIIO.

Only works if HDF5 is compiled with MPI. Otherwise, it throws an exception. Calling this method creates a property as follows:

create(H5P_DATASET_XFER);
H5Pset_dxpl_mpio(id(), H5FD_MPIO_COLLECTIVE);
H5Pset_selection_io(id(), H5D_SELECTION_IO_MODE_OFF);

Definition at line 895 of file Hdf5Utils.cc.

References ARCANE_THROW.

◆ createDatasetTransfertIndependentMPIIO()

void Arcane::Hdf5Utils::HProperty::createDatasetTransfertIndependentMPIIO ( )

Creates a dataset property for MPIIO.

Only works if HDF5 is compiled with MPI. Otherwise, it throws an exception. Calling this method creates a property as follows:

create(H5P_DATASET_XFER);
H5Pset_dxpl_mpio(id(), H5FD_MPIO_INDEPENDENT);
H5Pset_selection_io(id(), H5D_SELECTION_IO_MODE_OFF);

Definition at line 914 of file Hdf5Utils.cc.

References ARCANE_THROW.

◆ createFilePropertyMPIIO()

void Arcane::Hdf5Utils::HProperty::createFilePropertyMPIIO ( IParallelMng * pm)

Creates a file property for MPIIO.

Only works if HDF5 is compiled with MPI. Otherwise, it throws an exception. If mpi_comm is the MPI communicator associated with pm, calling this method creates a property as follows:

create(H5P_FILE_ACCESS);
H5Pset_fapl_mpio(id(), mpi_comm, MPI_INFO_NULL);

Definition at line 874 of file Hdf5Utils.cc.

References ARCANE_FATAL, ARCANE_THROW, and Arcane::IParallelMng::getMPICommunicator().

◆ operator=()

HProperty & Arcane::Hdf5Utils::HProperty::operator= ( HProperty && rhs)
inline

Definition at line 203 of file Hdf5Utils.h.

◆ setId()

void Arcane::Hdf5Utils::HProperty::setId ( hid_t new_id)
inline

Definition at line 220 of file Hdf5Utils.h.

The documentation for this class was generated from the following files: