FichierHDF

FichierHDF#

#include <FichierHDF.h>
Brief description

This abstract class provides all the functionalities to open and manipulate HDF files and related concepts (datasets, groups, etc .

How to reference this class#

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`FichierHDF <class-fichierhdf>`

[FichierHDF](#class-fichierhdf)

Detailed description#

..) 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.

Inherited by#

Inheritance graph#

If the image is too small, right-click and open in new tab

../../../../../_images/classFichierHDF__inherit__graph.png

List of Public Methods#

List of Public Static Methods#

List of Protected Methods#

List of Private Methods#

Complete Member Function Documentation#

check_int_size#

Definition
void FichierHDF::check_int_size(Nom filename)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::check_int_size(Nom filename) <fichierhdf-public-void-fichierhdf-check-int-size-nom-filename>`

[void FichierHDF::check_int_size(Nom filename)](#fichierhdf-public-void-fichierhdf-check-int-size-nom-filename)

close#

Definition
void FichierHDF::close()
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::close() <fichierhdf-public-void-fichierhdf-close>`

[void FichierHDF::close()](#fichierhdf-public-void-fichierhdf-close)

create#

Definition
void FichierHDF::create(Nom filename)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::create(Nom filename) <fichierhdf-public-void-fichierhdf-create-nom-filename>`

[void FichierHDF::create(Nom filename)](#fichierhdf-public-void-fichierhdf-create-nom-filename)

create_and_fill_dataset_MW#

Definition
void FichierHDF::create_and_fill_dataset_MW(Nom dataset_basename, SChaine &sortie)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::create_and_fill_dataset_MW(Nom dataset_basename, SChaine &sortie) <fichierhdf-public-void-fichierhdf-create-and-fill-dataset-mw-nom-dataset-basename-schaine-ref-sortie>`

[void FichierHDF::create_and_fill_dataset_MW(Nom dataset_basename, SChaine &sortie)](#fichierhdf-public-void-fichierhdf-create-and-fill-dataset-mw-nom-dataset-basename-schaine-ref-sortie)

create_and_fill_dataset_MW#

Definition
void FichierHDF::create_and_fill_dataset_MW(Nom dataset_basename, Sortie_Brute &sortie)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::create_and_fill_dataset_MW(Nom dataset_basename, Sortie_Brute &sortie) <fichierhdf-public-void-fichierhdf-create-and-fill-dataset-mw-nom-dataset-basename-sortie-brute-ref-sortie>`

[void FichierHDF::create_and_fill_dataset_MW(Nom dataset_basename, Sortie_Brute &sortie)](#fichierhdf-public-void-fichierhdf-create-and-fill-dataset-mw-nom-dataset-basename-sortie-brute-ref-sortie)

create_and_fill_dataset_SW#

Definition
void FichierHDF::create_and_fill_dataset_SW(Nom datasetname, Sortie_Brute &sortie)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::create_and_fill_dataset_SW(Nom datasetname, Sortie_Brute &sortie) <fichierhdf-public-void-fichierhdf-create-and-fill-dataset-sw-nom-datasetname-sortie-brute-ref-sortie>`

[void FichierHDF::create_and_fill_dataset_SW(Nom datasetname, Sortie_Brute &sortie)](#fichierhdf-public-void-fichierhdf-create-and-fill-dataset-sw-nom-datasetname-sortie-brute-ref-sortie)

create_datasets#

Definition
void FichierHDF::create_datasets(Noms dataset_names, long length)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::create_datasets(Noms dataset_names, long length) <fichierhdf-public-void-fichierhdf-create-datasets-noms-dataset-names-long-length>`

[void FichierHDF::create_datasets(Noms dataset_names, long length)](#fichierhdf-public-void-fichierhdf-create-datasets-noms-dataset-names-long-length)

exists#

Definition
bool FichierHDF::exists(const char *dataset_name)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`bool FichierHDF::exists(const char *dataset_name) <fichierhdf-public-bool-fichierhdf-exists-const-char-ptr-dataset-name>`

[bool FichierHDF::exists(const char *dataset_name)](#fichierhdf-public-bool-fichierhdf-exists-const-char-ptr-dataset-name)

FichierHDF#

Definition
FichierHDF::FichierHDF()
Brief description
Detailed description
References
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`FichierHDF::FichierHDF() <fichierhdf-public-fichierhdf-fichierhdf>`

[FichierHDF::FichierHDF()](#fichierhdf-public-fichierhdf-fichierhdf)

fill_dataset#

Definition
void FichierHDF::fill_dataset(Nom dataset_name, Sortie_Brute &sortie)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::fill_dataset(Nom dataset_name, Sortie_Brute &sortie) <fichierhdf-public-void-fichierhdf-fill-dataset-nom-dataset-name-sortie-brute-ref-sortie>`

[void FichierHDF::fill_dataset(Nom dataset_name, Sortie_Brute &sortie)](#fichierhdf-public-void-fichierhdf-fill-dataset-nom-dataset-name-sortie-brute-ref-sortie)

open#

Definition
void FichierHDF::open(Nom filename, bool readOnly)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::open(Nom filename, bool readOnly) <fichierhdf-public-void-fichierhdf-open-nom-filename-bool-readonly>`

[void FichierHDF::open(Nom filename, bool readOnly)](#fichierhdf-public-void-fichierhdf-open-nom-filename-bool-readonly)

read_dataset#

Definition
void FichierHDF::read_dataset(Nom dataset_basename, int proc_rank, Entree_Brute &entree)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::read_dataset(Nom dataset_basename, int proc_rank, Entree_Brute &entree) <fichierhdf-public-void-fichierhdf-read-dataset-nom-dataset-basename-int-proc-rank-entree-brute-ref-entree>`

[void FichierHDF::read_dataset(Nom dataset_basename, int proc_rank, Entree_Brute &entree)](#fichierhdf-public-void-fichierhdf-read-dataset-nom-dataset-basename-int-proc-rank-entree-brute-ref-entree)

set_int_size#

Definition
void FichierHDF::set_int_size()
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::set_int_size() <fichierhdf-public-void-fichierhdf-set-int-size>`

[void FichierHDF::set_int_size()](#fichierhdf-public-void-fichierhdf-set-int-size)

~FichierHDF#

Definition
FichierHDF::~FichierHDF()
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`FichierHDF::~FichierHDF() <fichierhdf-public-fichierhdf-dtor-fichierhdf>`

[FichierHDF::~FichierHDF()](#fichierhdf-public-fichierhdf-dtor-fichierhdf)

is_hdf5#

Definition
bool FichierHDF::is_hdf5(const char *file_name)
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`bool FichierHDF::is_hdf5(const char *file_name) <fichierhdf-public-static-bool-fichierhdf-is-hdf5-const-char-ptr-file-name>`

[bool FichierHDF::is_hdf5(const char *file_name)](#fichierhdf-public-static-bool-fichierhdf-is-hdf5-const-char-ptr-file-name)

prepare_dataset_props#

Definition
void FichierHDF::prepare_dataset_props()
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::prepare_dataset_props() <fichierhdf-protected-void-fichierhdf-prepare-dataset-props>`

[void FichierHDF::prepare_dataset_props()](#fichierhdf-protected-void-fichierhdf-prepare-dataset-props)

prepare_file_props#

Definition
void FichierHDF::prepare_file_props()
Brief description
Detailed description
Referenced By
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`void FichierHDF::prepare_file_props() <fichierhdf-protected-void-fichierhdf-prepare-file-props>`

[void FichierHDF::prepare_file_props()](#fichierhdf-protected-void-fichierhdf-prepare-file-props)

FichierHDF#

Definition
FichierHDF::FichierHDF(const FichierHDF &)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`FichierHDF::FichierHDF(const FichierHDF &) <fichierhdf-private-fichierhdf-fichierhdf-const-fichierhdf-ref>`

[FichierHDF::FichierHDF(const FichierHDF &)](#fichierhdf-private-fichierhdf-fichierhdf-const-fichierhdf-ref)

operator =#

Definition
FichierHDF & FichierHDF::operator=(const FichierHDF &)
Brief description
Detailed description
How to reference this method:

Copy the following pieces of RST/Markdown code to cite this element in other parts of the sphinx documentation (there is a copy button on the top-right when hovering the code block):

:ref:`FichierHDF & FichierHDF::operator=(const FichierHDF &) <fichierhdf-private-fichierhdf-ref-fichierhdf-operator-equal-const-fichierhdf-ref>`

[FichierHDF & FichierHDF::operator=(const FichierHDF &)](#fichierhdf-private-fichierhdf-ref-fichierhdf-operator-equal-const-fichierhdf-ref)

Attributes Documentation#

Contents