geos::HDFFile Class Reference

#include <HDFFile.hpp>

Public Member Functions
	HDFFile (string const &fnm, bool deleteExisting, bool parallelAccess, MPI_Comm comm)
	Constructor – this creates/opens the target file for read/write. More...
	~HDFFile ()
	Closes the file and accessors.
bool	hasDataset (const string &name) const
	Whether a dataset/group with the specified name exists in the target. More...
	operator int64_t () const
	Get the HDF hid_t file identifier. More...

Detailed Description

A class used to control access to an HDF file target.

Definition at line 27 of file HDFFile.hpp.

Constructor & Destructor Documentation

HDFFile()

geos::HDFFile::HDFFile	(	string const &	fnm,
		bool	deleteExisting,
		bool	parallelAccess,
		MPI_Comm	comm
	)

Constructor – this creates/opens the target file for read/write.

Parameters

[in]	fnm	The filename.
[in]	deleteExisting	Whether to remove/recreate if a file with the same name exists.
[in]	parallelAccess	Whether to access one file in parallel or one file per rank in the comm.
[in]	comm	An MPI communicator where each rank in the communicator will be accessing the target file.

Member Function Documentation

hasDataset()

bool geos::HDFFile::hasDataset

(

const string &

name

)

const

Whether a dataset/group with the specified name exists in the target.

Parameters

[in]

name

The dataset/group name to check for.

Returns

Whether the dataset/group exists in the target.

operator int64_t()

geos::HDFFile::operator int64_t ( ) const

inline

Get the HDF hid_t file identifier.

Returns

the HDF hid_t file id.

Definition at line 55 of file HDFFile.hpp.

---

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

• coreComponents/fileIO/timeHistory/HDFFile.hpp