Nektar::LibUtilities::H5::File Class Reference

HDF5 file wrapper. More...

#include <H5.h>

Inheritance diagram for Nektar::LibUtilities::H5::File:

Collaboration diagram for Nektar::LibUtilities::H5::File:

Public Member Functions
	~File ()
void	Close ()
virtual hsize_t	GetNumElements ()
Public Member Functions inherited from Nektar::LibUtilities::H5::CanHaveGroupsDataSets
GroupSharedPtr	CreateGroup (const std::string &name, PListSharedPtr createPL=PList::Default(), PListSharedPtr accessPL=PList::Default())
DataSetSharedPtr	CreateDataSet (const std::string &name, DataTypeSharedPtr type, DataSpaceSharedPtr space, PListSharedPtr createPL=PList::Default(), PListSharedPtr accessPL=PList::Default())
template<class T >
DataSetSharedPtr	CreateWriteDataSet (const std::string &name, const std::vector< T > &data, PListSharedPtr createPL=PList::Default(), PListSharedPtr accessPL=PList::Default())
GroupSharedPtr	OpenGroup (const std::string &name, PListSharedPtr accessPL=PList::Default()) const
DataSetSharedPtr	OpenDataSet (const std::string &name, PListSharedPtr accessPL=PList::Default()) const
LinkIterator	begin ()
LinkIterator	end ()
Public Member Functions inherited from Nektar::LibUtilities::H5::Object
hid_t	GetId () const
	operator hid_t () const

Static Public Member Functions
static FileSharedPtr	Create (const std::string &filename, unsigned mode, PListSharedPtr createPL=PList::Default(), PListSharedPtr accessPL=PList::Default())
static FileSharedPtr	Open (const std::string &filename, unsigned mode, PListSharedPtr accessPL=PList::Default())

Private Member Functions
	File (hid_t id)

Additional Inherited Members
Protected Member Functions inherited from Nektar::LibUtilities::H5::Object
	Object ()
	Object (hid_t id)
virtual	~Object ()
Protected Attributes inherited from Nektar::LibUtilities::H5::Object
hid_t	m_Id

Detailed Description

HDF5 file wrapper.

Definition at line 422 of file H5.h.

Constructor & Destructor Documentation

Nektar::LibUtilities::H5::File::~File

(

)

Definition at line 571 of file H5.cpp.

References Close().

{
    Close();
}

Nektar::LibUtilities::H5::File::File ( hid_t  id )

private

Definition at line 552 of file H5.cpp.

Referenced by Create(), and Open().

                   : Object(id)
{
}

Member Function Documentation

void Nektar::LibUtilities::H5::File::Close ( )

virtual

Implements Nektar::LibUtilities::H5::Object.

Definition at line 576 of file H5.cpp.

References H5_CALL.

Referenced by ~File().

{
    H5_CALL(H5Fclose, (m_Id));
    m_Id = H5I_INVALID_HID;
}

FileSharedPtr Nektar::LibUtilities::H5::File::Create ( const std::string &  filename, unsigned  mode, PListSharedPtr  createPL = PList::Default(), PListSharedPtr  accessPL = PList::Default()  )

static

Definition at line 555 of file H5.cpp.

References File(), and H5_CONSTRUCT.

Referenced by Nektar::LibUtilities::FieldIOHdf5::v_Write().

{
    hid_t id;
    H5_CONSTRUCT(id, H5Fcreate, (filename.c_str(), mode, createPL->GetId(),
                                 accessPL->GetId()));
    return FileSharedPtr(new File(id));
}

hsize_t Nektar::LibUtilities::H5::File::GetNumElements ( )

virtual

Implements Nektar::LibUtilities::H5::CanHaveGroupsDataSets.

Definition at line 581 of file H5.cpp.

References Nektar::LibUtilities::H5::CanHaveGroupsDataSets::OpenGroup().

{
    GroupSharedPtr root = OpenGroup("/");
    return root->GetNumElements();
}

FileSharedPtr Nektar::LibUtilities::H5::File::Open ( const std::string &  filename, unsigned  mode, PListSharedPtr  accessPL = PList::Default()  )

static

Definition at line 563 of file H5.cpp.

References File(), and H5_CONSTRUCT.

Referenced by Nektar::LibUtilities::FieldIOHdf5::v_Write().

{
    hid_t id;
    H5_CONSTRUCT(id, H5Fopen, (filename.c_str(), mode, accessPL->GetId()));
    return FileSharedPtr(new File(id));
}