sierra::nalu::HDF5FilePtr Class Reference

Provides a HDF5 formatted file pointer. More...

#include <HDF5FilePtr.h>

Public Member Functions
	HDF5FilePtr (const std::string &fileName="")
	Construct an empty HDF5FilePtr. More...
	~HDF5FilePtr ()
bool	has_entry (const std::string &name) const
	Query if the given property exists in the library. More...
std::vector< std::string >	property_names () const
	Get a list of all contained properties. More...
const std::string &	filename ()
void	read_hdf5 ()
	Read the entire library from an HDF5 file with the name set in the constructor. More...
H5IO *	get_H5IO ()
	returns the pointer to an opened HDF5 file More...

Private Member Functions
	HDF5FilePtr (const HDF5FilePtr &)
	Don't need to print summary in Nalu Print a summary of the contained data, including independent variable mesh points, clipping values, and the contained properties. More...
HDF5FilePtr	operator= (const HDF5FilePtr &)

Private Attributes
std::vector< std::string >	propertyNames_
	list of properties contained in the file More...
std::string	fileName_
	Name of the file that the library is tied to. More...
int	exportFileVersion_
	File version to write. More...
H5IO *	fileIO_
	Pointer to table of properties. More...

Detailed Description

Provides a HDF5 formatted file pointer.

Given a filename pertaining to an HDF5 formatted file, this file will be opened, the names of properties tabulatedin that file is read and the file pointer can be returned.

Constructor & Destructor Documentation

sierra::nalu::HDF5FilePtr::HDF5FilePtr ( const std::string &  fileName = "" )

explicit

Construct an empty HDF5FilePtr.

It should then be filled with Property objects by making repeated calls to add_entry().

References exportFileVersion_, fileIO_, and read_hdf5().

Referenced by filename().

sierra::nalu::HDF5FilePtr::~HDF5FilePtr

(

)

References sierra::nalu::H5IO::close_file(), and fileIO_.

sierra::nalu::HDF5FilePtr::HDF5FilePtr ( const HDF5FilePtr &  )

private

Don't need to print summary in Nalu Print a summary of the contained data, including independent variable mesh points, clipping values, and the contained properties.

void print_summary() const;

Member Function Documentation

const std::string& sierra::nalu::HDF5FilePtr::filename ( )

inline

References fileName_, get_H5IO(), HDF5FilePtr(), operator=(), and read_hdf5().

H5IO * sierra::nalu::HDF5FilePtr::get_H5IO

(

)

returns the pointer to an opened HDF5 file

References fileIO_.

Referenced by filename(), and sierra::nalu::Realm::setup_property().

bool sierra::nalu::HDF5FilePtr::has_entry

(

const std::string &

name

)

const

Query if the given property exists in the library.

References propertyNames_.

HDF5FilePtr sierra::nalu::HDF5FilePtr::operator= ( const HDF5FilePtr &  )

private

Referenced by filename().

std::vector< std::string > sierra::nalu::HDF5FilePtr::property_names

(

)

const

Get a list of all contained properties.

References propertyNames_.

void sierra::nalu::HDF5FilePtr::read_hdf5

(

)

Read the entire library from an HDF5 file with the name set in the constructor.

References fileIO_, fileName_, sierra::nalu::H5IO::open_file(), propertyNames_, and sierra::nalu::H5IO::read_attribute().

Referenced by filename(), and HDF5FilePtr().

Member Data Documentation

int sierra::nalu::HDF5FilePtr::exportFileVersion_

private

File version to write.

Referenced by HDF5FilePtr().

H5IO* sierra::nalu::HDF5FilePtr::fileIO_

private

Pointer to table of properties.

Referenced by get_H5IO(), HDF5FilePtr(), read_hdf5(), and ~HDF5FilePtr().

std::string sierra::nalu::HDF5FilePtr::fileName_

private

Name of the file that the library is tied to.

Referenced by filename(), and read_hdf5().

std::vector<std::string> sierra::nalu::HDF5FilePtr::propertyNames_

private

list of properties contained in the file

Referenced by has_entry(), property_names(), and read_hdf5().

---

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

• HDF5FilePtr.h
• HDF5FilePtr.C