class for a dataset transfer property list

#include <dataset_transfer.hpp>

Inheritance diagram for hdf5::property::DatasetTransferList:

Collaboration diagram for hdf5::property::DatasetTransferList:

Public Member Functions
	DatasetTransferList ()
	constructor More...

	~DatasetTransferList () override
	destructor More...

	DatasetTransferList (ObjectHandle &&handle, bool do_check=true)
	constructor More...

void	mpi_transfer_mode (MPITransferMode mode) const
	set mpi transfer mode (for hdf5 compiled with MPI) More...

MPITransferMode	mpi_transfer_mode () const
	get mpi transfer mode (for hdf5 compiled with MPI) More...

void	mpi_chunk_option (MPIChunkOption option) const
	set mpi chunk option (for hdf5 compiled with MPI) More...

MPIChunkOption	mpi_chunk_option () const
	get mpi chunk option (for hdf5 compiled with MPI) More...

Public Member Functions inherited from hdf5::property::List
	List (const Class &plist_class)
	constructor More...

	List (const List &plist)
	copy constructor More...

	List (ObjectHandle &&handle)
	constructor More...

List &	operator= (const List &type)
	copy assignment More...

virtual	~List ()
	destructor More...

List &	operator= (List &&type)=default

	List (List &&type)=default

Class	get_class () const
	return property list class More...

	operator hid_t () const
	conversion operator More...

Static Public Member Functions
static const DatasetTransferList &	get ()
	reference to const static DatasetTransferList object More...

Constructor & Destructor Documentation

◆ DatasetTransferList() [1/2]

hdf5::property::DatasetTransferList::DatasetTransferList ( )

◆ ~DatasetTransferList()

hdf5::property::DatasetTransferList::~DatasetTransferList ( )

override

◆ DatasetTransferList() [2/2]

hdf5::property::DatasetTransferList::DatasetTransferList	(	ObjectHandle &&	handle,
		bool	do_check = `true`
	)

explicit

Construct a property list from a handler object. This constructor is particularly useful in situations where we retrieve the handler of a property list from a C-API function.

Exceptions

std::runtime_error in case of a failure

Parameters

handle	r-value reference to the handle object
do_check	perform the object handle class type check

Member Function Documentation

◆ get()

static const DatasetTransferList& hdf5::property::DatasetTransferList::get ( )

inlinestatic

Return a reference to const static DatasetTransferList object. The object has to be constructed directly with H5P_DATASET_XFER because during the construction kDatasetXfer does not exist.

◆ mpi_chunk_option() [1/2]

MPIChunkOption hdf5::property::DatasetTransferList::mpi_chunk_option ( ) const

◆ mpi_chunk_option() [2/2]

void hdf5::property::DatasetTransferList::mpi_chunk_option ( MPIChunkOption option ) const

◆ mpi_transfer_mode() [1/2]

MPITransferMode hdf5::property::DatasetTransferList::mpi_transfer_mode ( ) const

◆ mpi_transfer_mode() [2/2]

void hdf5::property::DatasetTransferList::mpi_transfer_mode ( MPITransferMode mode ) const

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

/home/jenkins/h5cpp/src/h5cpp/property/dataset_transfer.hpp

Public Member Functions

Static Public Member Functions