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

HDF5 DataSpace wrapper. More...

#include <H5.h>

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

Collaboration 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 ()
void	Close ()
void	SelectRange (const hsize_t start, const hsize_t count)
hsize_t	GetSize ()
Public Member Functions inherited from Nektar::LibUtilities::H5::Object
hid_t	GetId () const
	operator hid_t () const

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

Private Member Functions
	DataSpace (hid_t id)

Friends
class	Attribute
class	DataSet

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 DataSpace wrapper.

Definition at line 304 of file H5.h.

Constructor & Destructor Documentation

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

(

)

Definition at line 410 of file H5.cpp.

                     : Object()
{
}

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

Definition at line 424 of file H5.cpp.

References H5_CONSTRUCT.

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

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

(

const std::vector< hsize_t > &

dims

)

Definition at line 418 of file H5.cpp.

References H5_CONSTRUCT.

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

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

Definition at line 432 of file H5.cpp.

References H5_CONSTRUCT.

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

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

(

)

Definition at line 440 of file H5.cpp.

References Close().

{
    Close();
}

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

private

Definition at line 414 of file H5.cpp.

                             : Object(id)
{
}

Member Function Documentation

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

virtual

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

Definition at line 445 of file H5.cpp.

References H5_CALL.

Referenced by ~DataSpace().

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

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

(

)

Definition at line 456 of file H5.cpp.

{
    return H5Sget_simple_extent_npoints(m_Id);
}

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

static

Definition at line 390 of file H5.cpp.

References H5_CONSTRUCT.

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

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

static

Definition at line 403 of file H5.cpp.

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().

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

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

static

Definition at line 397 of file H5.cpp.

References H5_CONSTRUCT.

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

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

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

Definition at line 450 of file H5.cpp.

References H5_CALL.

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

Friends And Related Function Documentation

friend class Attribute

friend

Definition at line 325 of file H5.h.

friend class DataSet

friend

Definition at line 326 of file H5.h.