Nektar::LibUtilities::H5::DataSpace Class Reference

HDF5 DataSpace wrapper. More...

#include <H5.h>

Inheritance diagram for Nektar::LibUtilities::H5::DataSpace:

Public Member Functions
	DataSpace ()
	DataSpace (hsize_t size, hsize_t max=H5S_UNLIMITED - 1)
	DataSpace (const std::vector< hsize_t > &dims)
	DataSpace (const std::vector< hsize_t > &dims, const std::vector< hsize_t > &max_dims)
	~DataSpace () override
void	SelectRange (const hsize_t start, const hsize_t count)
void	AppendRange (const hsize_t start, const hsize_t count)
void	SelectRange (const std::vector< hsize_t > start, const std::vector< hsize_t > count)
void	AppendRange (const std::vector< hsize_t > start, const std::vector< hsize_t > count)
void	SetSelection (const hsize_t num_elmt, const std::vector< hsize_t > &coords)
void	ClearRange ()
hsize_t	GetSize ()
std::vector< hsize_t >	GetDims ()
Public Member Functions inherited from Nektar::LibUtilities::H5::Object
void	Close ()
hid_t	GetId () const
	operator hid_t () const

Static Public Member Functions
static DataSpaceSharedPtr	Null ()
static DataSpaceSharedPtr	Scalar ()
static DataSpaceSharedPtr	OneD (hsize_t size)

Protected Member Functions
void	v_Close () override
Protected Member Functions inherited from Nektar::LibUtilities::H5::Object
	Object ()
	Object (hid_t id)
virtual	~Object ()
virtual void	v_Close ()=0

Private Member Functions
	DataSpace (hid_t id)

Friends
class	Attribute
class	DataSet

Additional Inherited Members
Protected Attributes inherited from Nektar::LibUtilities::H5::Object
hid_t	m_Id

Detailed Description

HDF5 DataSpace wrapper.

Definition at line 308 of file H5.h.

Constructor & Destructor Documentation

DataSpace() [1/5]

Nektar::LibUtilities::H5::DataSpace::DataSpace

(

)

Definition at line 418 of file H5.cpp.

                     : Object()
{
}

DataSpace() [2/5]

Nektar::LibUtilities::H5::DataSpace::DataSpace	(	hsize_t	size,
		hsize_t	max = H5S_UNLIMITED - 1
	)

Definition at line 432 of file H5.cpp.

                                                          : Object()
{
    const hsize_t *max_p = nullptr;
    if (max != (H5S_UNLIMITED - 1))
    {
        max_p = &max;
    }
    H5_CONSTRUCT(m_Id, H5Screate_simple, (1, &size, max_p));
}

References H5_CONSTRUCT, and Nektar::LibUtilities::H5::Object::m_Id.

DataSpace() [3/5]

Nektar::LibUtilities::H5::DataSpace::DataSpace

(

const std::vector< hsize_t > &

dims

)

Definition at line 426 of file H5.cpp.

                                                   : Object()
{
    int rank = dims.size();
    H5_CONSTRUCT(m_Id, H5Screate_simple, (rank, &dims[0], nullptr));
}

References H5_CONSTRUCT, and Nektar::LibUtilities::H5::Object::m_Id.

DataSpace() [4/5]

Nektar::LibUtilities::H5::DataSpace::DataSpace	(	const std::vector< hsize_t > &	dims,
		const std::vector< hsize_t > &	max_dims
	)

Definition at line 442 of file H5.cpp.

    : Object()
{
    int rank = dims.size();
    H5_CONSTRUCT(m_Id, H5Screate_simple, (rank, &dims[0], &max_dims[0]));
}

References H5_CONSTRUCT, and Nektar::LibUtilities::H5::Object::m_Id.

~DataSpace()

Nektar::LibUtilities::H5::DataSpace::~DataSpace ( )

override

Definition at line 450 of file H5.cpp.

{
    Close();
}

References Nektar::LibUtilities::H5::Object::Close().

DataSpace() [5/5]

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

private

Definition at line 422 of file H5.cpp.

                             : Object(id)
{
}

Member Function Documentation

AppendRange() [1/2]

void Nektar::LibUtilities::H5::DataSpace::AppendRange	(	const hsize_t	start,
		const hsize_t	count
	)

Definition at line 465 of file H5.cpp.

{
    H5_CALL(H5Sselect_hyperslab,
            (m_Id, H5S_SELECT_OR, &start, nullptr, &count, nullptr));
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

AppendRange() [2/2]

void Nektar::LibUtilities::H5::DataSpace::AppendRange	(	const std::vector< hsize_t >	start,
		const std::vector< hsize_t >	count
	)

Definition at line 476 of file H5.cpp.

{
    H5_CALL(H5Sselect_hyperslab,
            (m_Id, H5S_SELECT_OR, &start[0], nullptr, &count[0], nullptr));
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

ClearRange()

void Nektar::LibUtilities::H5::DataSpace::ClearRange

(

)

Definition at line 496 of file H5.cpp.

{
    H5_CALL(H5Sselect_none, (m_Id));
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

GetDims()

std::vector< hsize_t > Nektar::LibUtilities::H5::DataSpace::GetDims

(

)

Definition at line 506 of file H5.cpp.

{
    int ndims = H5Sget_simple_extent_ndims(m_Id);
    std::vector<hsize_t> ret(ndims, 0);
    H5Sget_simple_extent_dims(m_Id, &ret[0], nullptr);
    return ret;
}

References Nektar::LibUtilities::H5::Object::m_Id.

GetSize()

hsize_t Nektar::LibUtilities::H5::DataSpace::GetSize

(

)

Definition at line 501 of file H5.cpp.

{
    return H5Sget_simple_extent_npoints(m_Id);
}

References Nektar::LibUtilities::H5::Object::m_Id.

Null()

DataSpaceSharedPtr Nektar::LibUtilities::H5::DataSpace::Null ( )

static

Definition at line 398 of file H5.cpp.

{
    DataSpaceSharedPtr ans(new DataSpace);
    H5_CONSTRUCT(ans->m_Id, H5Screate, (H5S_NULL));
    return ans;
}

References H5_CONSTRUCT.

OneD()

DataSpaceSharedPtr Nektar::LibUtilities::H5::DataSpace::OneD ( hsize_t  size )

static

Definition at line 411 of file H5.cpp.

{
    DataSpaceSharedPtr ans(new DataSpace);
    H5_CONSTRUCT(ans->m_Id, H5Screate_simple, (1, &size, nullptr));
    return ans;
}

References H5_CONSTRUCT.

Referenced by Nektar::LibUtilities::H5::CanHaveGroupsDataSets::CreateWriteDataSet(), Nektar::LibUtilities::H5::DataSet::Read(), Nektar::LibUtilities::H5::CanHaveAttributes::SetAttribute(), Nektar::LibUtilities::FieldIOHdf5::v_Write(), and Nektar::LibUtilities::H5::DataSet::Write().

Scalar()

DataSpaceSharedPtr Nektar::LibUtilities::H5::DataSpace::Scalar ( )

static

Definition at line 405 of file H5.cpp.

{
    DataSpaceSharedPtr ans(new DataSpace);
    H5_CONSTRUCT(ans->m_Id, H5Screate, (H5S_SCALAR));
    return ans;
}

References H5_CONSTRUCT.

Referenced by Nektar::LibUtilities::H5::CanHaveAttributes::GetAttribute(), and Nektar::LibUtilities::H5::CanHaveAttributes::SetAttribute().

SelectRange() [1/2]

void Nektar::LibUtilities::H5::DataSpace::SelectRange	(	const hsize_t	start,
		const hsize_t	count
	)

Definition at line 460 of file H5.cpp.

{
    H5_CALL(H5Sselect_hyperslab,
            (m_Id, H5S_SELECT_SET, &start, nullptr, &count, nullptr));
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

SelectRange() [2/2]

void Nektar::LibUtilities::H5::DataSpace::SelectRange	(	const std::vector< hsize_t >	start,
		const std::vector< hsize_t >	count
	)

Definition at line 470 of file H5.cpp.

{
    H5_CALL(H5Sselect_hyperslab,
            (m_Id, H5S_SELECT_SET, &start[0], nullptr, &count[0], nullptr));
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

SetSelection()

void Nektar::LibUtilities::H5::DataSpace::SetSelection	(	const hsize_t	num_elmt,
		const std::vector< hsize_t > &	coords
	)

Definition at line 482 of file H5.cpp.

{
    if (num_elmt == 0)
    {
        H5_CALL(H5Sselect_none, (m_Id));
    }
    else
    {
        H5_CALL(H5Sselect_elements,
                (m_Id, H5S_SELECT_SET, num_elmt, &coords[0]));
    }
}

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

v_Close()

void Nektar::LibUtilities::H5::DataSpace::v_Close ( )

overrideprotectedvirtual

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

Definition at line 455 of file H5.cpp.

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

References H5_CALL, and Nektar::LibUtilities::H5::Object::m_Id.

Friends And Related Function Documentation

Attribute

friend class Attribute

friend

Definition at line 343 of file H5.h.

DataSet

friend class DataSet

friend

Definition at line 344 of file H5.h.