Nektar::LibUtilities::H5::PList Class Reference

#include <H5.h>

Inheritance diagram for Nektar::LibUtilities::H5::PList:

Collaboration diagram for Nektar::LibUtilities::H5::PList:

Public Member Functions
	PList ()
	~PList ()
void	Close ()
void	SetChunk (const std::vector< hsize_t > &dims)
void	SetDeflate (const unsigned level=1)
void	SetMpio (CommSharedPtr comm)
void	SetDxMpioCollective ()
void	SetDxMpioIndependent ()
Public Member Functions inherited from Nektar::LibUtilities::H5::Object
hid_t	GetId () const
	operator hid_t () const

Static Public Member Functions
static PListSharedPtr	Default ()
	Default options. More...
static PListSharedPtr	ObjectCreate ()
	Properties for object creation. More...
static PListSharedPtr	FileCreate ()
	Properties for file creation. More...
static PListSharedPtr	FileAccess ()
	Properties for file access. More...
static PListSharedPtr	DatasetCreate ()
	Properties for dataset creation. More...
static PListSharedPtr	DatasetAccess ()
	Properties for dataset access. More...
static PListSharedPtr	DatasetXfer ()
	Properties for raw data transfer. More...
static PListSharedPtr	FileMount ()
	Properties for file mounting. More...
static PListSharedPtr	GroupCreate ()
	Properties for group creation. More...
static PListSharedPtr	GroupAccess ()
	Properties for group access. More...
static PListSharedPtr	DatatypeCreate ()
	Properties for datatype creation. More...
static PListSharedPtr	DatatypeAccess ()
	Properties for datatype access. More...
static PListSharedPtr	StringCreate ()
	Properties for character encoding when encoding strings or object names. More...
static PListSharedPtr	AttributeCreate ()
	Properties for attribute creation. More...
static PListSharedPtr	ObjectCopy ()
	Properties governing the object copying process. More...
static PListSharedPtr	LinkCreate ()
	Properties governing link creation. More...
static PListSharedPtr	LinkAccess ()
	Properties governing link traversal when accessing objects. More...

Private Member Functions
	PList (hid_t cls)

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

Definition at line 129 of file H5.h.

Constructor & Destructor Documentation

Nektar::LibUtilities::H5::PList::PList

(

)

Definition at line 60 of file H5.cpp.

Referenced by AttributeCreate(), DatasetAccess(), DatasetCreate(), DatasetXfer(), DatatypeAccess(), DatatypeCreate(), Default(), FileAccess(), FileCreate(), FileMount(), GroupAccess(), GroupCreate(), LinkAccess(), LinkCreate(), ObjectCopy(), ObjectCreate(), and StringCreate().

             : Object(H5P_DEFAULT)
{
}

Nektar::LibUtilities::H5::PList::~PList

(

)

Definition at line 67 of file H5.cpp.

References Close().

{
    Close();
}

Nektar::LibUtilities::H5::PList::PList ( hid_t  cls )

private

Definition at line 63 of file H5.cpp.

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

                      : Object()
{
    H5_CONSTRUCT(m_Id, H5Pcreate, (cls));
}

Member Function Documentation

PListSharedPtr Nektar::LibUtilities::H5::PList::AttributeCreate ( )

static

Properties for attribute creation.

Definition at line 156 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_ATTRIBUTE_CREATE));
}

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

virtual

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

Definition at line 71 of file H5.cpp.

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

Referenced by ~PList().

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

PListSharedPtr Nektar::LibUtilities::H5::PList::DatasetAccess ( )

static

Properties for dataset access.

Definition at line 108 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_DATASET_ACCESS));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::DatasetCreate ( )

static

Properties for dataset creation.

Definition at line 102 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_DATASET_CREATE));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::DatasetXfer ( )

static

Properties for raw data transfer.

Definition at line 114 of file H5.cpp.

References PList().

Referenced by Nektar::LibUtilities::FieldIOHdf5::v_Import(), and Nektar::LibUtilities::FieldIOHdf5::v_Write().

{
    return PListSharedPtr(new PList(H5P_DATASET_XFER));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::DatatypeAccess ( )

static

Properties for datatype access.

Definition at line 144 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_DATATYPE_ACCESS));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::DatatypeCreate ( )

static

Properties for datatype creation.

Definition at line 138 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_DATATYPE_CREATE));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::Default ( )

static

Default options.

Definition at line 78 of file H5.cpp.

References PList().

Referenced by Nektar::LibUtilities::FieldIOHdf5::v_Import(), Nektar::LibUtilities::FieldIOHdf5::v_ImportFieldMetaData(), and Nektar::LibUtilities::FieldIOHdf5::v_Write().

{
    return PListSharedPtr(new PList());
}

PListSharedPtr Nektar::LibUtilities::H5::PList::FileAccess ( )

static

Properties for file access.

Definition at line 96 of file H5.cpp.

References PList().

Referenced by Nektar::LibUtilities::FieldIOHdf5::v_Import(), and Nektar::LibUtilities::FieldIOHdf5::v_Write().

{
    return PListSharedPtr(new PList(H5P_FILE_ACCESS));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::FileCreate ( )

static

Properties for file creation.

Definition at line 90 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_FILE_CREATE));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::FileMount ( )

static

Properties for file mounting.

Definition at line 120 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_FILE_MOUNT));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::GroupAccess ( )

static

Properties for group access.

Definition at line 132 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_GROUP_ACCESS));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::GroupCreate ( )

static

Properties for group creation.

Definition at line 126 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_GROUP_CREATE));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::LinkAccess ( )

static

Properties governing link traversal when accessing objects.

Definition at line 174 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_LINK_ACCESS));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::LinkCreate ( )

static

Properties governing link creation.

Definition at line 168 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_LINK_CREATE));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::ObjectCopy ( )

static

Properties governing the object copying process.

Definition at line 162 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_OBJECT_COPY));
}

PListSharedPtr Nektar::LibUtilities::H5::PList::ObjectCreate ( )

static

Properties for object creation.

Definition at line 84 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_OBJECT_CREATE));
}

void Nektar::LibUtilities::H5::PList::SetChunk

(

const std::vector< hsize_t > &

dims

)

Definition at line 178 of file H5.cpp.

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

{
    H5_CALL(H5Pset_chunk, (m_Id, dims.size(), &dims[0]));
}

void Nektar::LibUtilities::H5::PList::SetDeflate

(

const unsigned

level = 1

)

Definition at line 182 of file H5.cpp.

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

{
    H5_CALL(H5Pset_deflate, (m_Id, level));
}

void Nektar::LibUtilities::H5::PList::SetDxMpioCollective

(

)

Definition at line 204 of file H5.cpp.

References ASSERTL0.

{
    ASSERTL0(false, "Trying to use parallel HDF5 without MPI!");
}

void Nektar::LibUtilities::H5::PList::SetDxMpioIndependent

(

)

Definition at line 208 of file H5.cpp.

References ASSERTL0.

{
    ASSERTL0(false, "Trying to use parallel HDF5 without MPI!");
}

void Nektar::LibUtilities::H5::PList::SetMpio

(

CommSharedPtr

comm

)

Definition at line 212 of file H5.cpp.

References ASSERTL0.

{
    ASSERTL0(false, "Trying to use parallel HDF5 without MPI!");
}

PListSharedPtr Nektar::LibUtilities::H5::PList::StringCreate ( )

static

Properties for character encoding when encoding strings or object names.

Definition at line 150 of file H5.cpp.

References PList().

{
    return PListSharedPtr(new PList(H5P_STRING_CREATE));
}