Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AMP::IO::HDF5data Class Referenceabstract

Class to wrap HDF5 data. More...

#include <HDF5_Class.h>

Inherits std::enable_shared_from_this< HDF5data >.

Public Member Functions

template<class TYPE >
void getData (AMP::Array< TYPE > &data) const
 Get the data.
 
std::shared_ptr< const HDF5datagetData (size_t i, const std::string_view &name) const
 Get the data ith block and jth child.
 
virtual std::shared_ptr< HDF5datagetData (size_t i, const std::string_view &name)=0
 Get the data ith block and jth child.
 
virtual AMP::ArraySize getDataSize () const =0
 Get the data.
 
virtual std::vector< std::string > getNames () const =0
 Get the variable names.
 
const std::string & name () const
 Return the name of the variable.
 
bool operator!= (const HDF5data &rhs) const
 Check if two objects are not equal.
 
virtual bool operator== (const HDF5data &rhs) const =0
 Check if two objects are equal.
 
virtual void print (int level=1, const std::string_view &prefix="") const =0
 Print information about the data.
 
virtual size_t size () const =0
 Number of entries.
 
virtual std::string type () const =0
 Return a string identifying the class.
 
virtual ~HDF5data ()
 Virtual destructor.
 

Protected Member Functions

 HDF5data (hid_t fid, const std::string_view &name)
 

Protected Attributes

hid_t d_fid
 
std::string d_name
 

Detailed Description

Class to wrap HDF5 data.

Definition at line 19 of file HDF5_Class.h.

Constructor & Destructor Documentation

◆ ~HDF5data()

virtual AMP::IO::HDF5data::~HDF5data ( )
inlinevirtual

Virtual destructor.

Definition at line 23 of file HDF5_Class.h.

◆ HDF5data()

AMP::IO::HDF5data::HDF5data ( hid_t  fid,
const std::string_view &  name 
)
inlineprotected

Definition at line 61 of file HDF5_Class.h.

Member Function Documentation

◆ getData() [1/3]

template<class TYPE >
void AMP::IO::HDF5data::getData ( AMP::Array< TYPE > &  data) const

Get the data.

◆ getData() [2/3]

std::shared_ptr< const HDF5data > AMP::IO::HDF5data::getData ( size_t  i,
const std::string_view &  name 
) const

Get the data ith block and jth child.

◆ getData() [3/3]

virtual std::shared_ptr< HDF5data > AMP::IO::HDF5data::getData ( size_t  i,
const std::string_view &  name 
)
pure virtual

Get the data ith block and jth child.

◆ getDataSize()

virtual AMP::ArraySize AMP::IO::HDF5data::getDataSize ( ) const
pure virtual

Get the data.

◆ getNames()

virtual std::vector< std::string > AMP::IO::HDF5data::getNames ( ) const
pure virtual

Get the variable names.

◆ name()

const std::string & AMP::IO::HDF5data::name ( ) const
inline

Return the name of the variable.

Definition at line 51 of file HDF5_Class.h.

References d_name.

◆ operator!=()

bool AMP::IO::HDF5data::operator!= ( const HDF5data rhs) const
inline

Check if two objects are not equal.

Definition at line 57 of file HDF5_Class.h.

References operator==().

◆ operator==()

virtual bool AMP::IO::HDF5data::operator== ( const HDF5data rhs) const
pure virtual

Check if two objects are equal.

Referenced by operator!=().

◆ print()

virtual void AMP::IO::HDF5data::print ( int  level = 1,
const std::string_view &  prefix = "" 
) const
pure virtual

Print information about the data.

◆ size()

virtual size_t AMP::IO::HDF5data::size ( ) const
pure virtual

Number of entries.

◆ type()

virtual std::string AMP::IO::HDF5data::type ( ) const
pure virtual

Return a string identifying the class.

Member Data Documentation

◆ d_fid

hid_t AMP::IO::HDF5data::d_fid
protected

Definition at line 63 of file HDF5_Class.h.

◆ d_name

std::string AMP::IO::HDF5data::d_name
protected

Definition at line 64 of file HDF5_Class.h.

Referenced by name().


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



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:42.
Comments on this page