hdf5::property::FileCreationList Class Reference

dataset creation property list

#include <file_creation.hpp>

Inheritance diagram for hdf5::property::FileCreationList:

Collaboration diagram for hdf5::property::FileCreationList:

Public Member Functions
	FileCreationList ()
	default constructor More...
	~FileCreationList () override
	FileCreationList (ObjectHandle &&handle)
	constructor More...
void	user_block (hsize_t size) const
	set user block More...
hsize_t	user_block () const
	get user block More...
void	object_offset_size (size_t size) const
	set object offset size More...
size_t	object_offset_size () const
	get object offset size More...
void	object_length_size (size_t size) const
	set object length size More...
size_t	object_length_size () const
	get object length size More...
void	btree_rank (unsigned int ik)
	set btree rank More...
unsigned int	btree_rank () const
	get btree rank More...
void	btree_symbols (unsigned int lk)
	set btree symbols More...
unsigned int	btree_symbols () const
	get btree symbols More...
void	chunk_tree_rank (unsigned int ik)
	set chunk tree rank More...
unsigned int	chunk_tree_rank () const
	get chunk tree rank More...
void	page_size (hsize_t size)
	set page size (since hdf5 1.10.1) More...
hsize_t	page_size () const
	get page size (since hdf5 1.10.1) More...
Public Member Functions inherited from hdf5::property::GroupCreationList
	GroupCreationList ()
virtual	~GroupCreationList () override
	GroupCreationList (ObjectHandle &&handle)
size_t	local_heap_size_hint () const
void	local_heap_size_hint (size_t size) const
unsigned	estimated_number_of_links () const
void	estimated_number_of_links (unsigned nlinks) const
unsigned	estimated_link_name_length () const
void	estimated_link_name_length (unsigned name_length) const
void	link_creation_order (CreationOrder order) const
CreationOrder	link_creation_order () const
void	link_storage_thresholds (unsigned max_compact, unsigned min_dense) const
unsigned	link_storage_maximum_compact () const
unsigned	link_storage_minimum_dense () const
	GroupCreationList (const Class &plist_class)
Public Member Functions inherited from hdf5::property::ObjectCreationList
	ObjectCreationList ()
	constructor More...
	ObjectCreationList (const ObjectCreationList &)=default
virtual	~ObjectCreationList () override
	destructor More...
	ObjectCreationList (ObjectHandle &&handle)
void	enable_time_tracking () const
	enable object time tracking More...
void	disable_time_tracking () const
	disable object time tracking More...
bool	time_tracking () const
	return time tacking status More...
void	attribute_creation_order (const CreationOrder &order) const
	set the attribute creation order More...
CreationOrder	attribute_creation_order () const
	retrieve current attribute creation order More...
void	attribute_storage_thresholds (unsigned max_compact, unsigned min_dense) const
	set storage layout thresholds More...
unsigned	attribute_storage_maximum_compact () const
	get upper threshold for compact storage More...
unsigned	attribute_storage_minimum_dense () const
	get lower threshold for dense threshold More...
Public Member Functions inherited from hdf5::property::List
	List (const Class &plist_class)
	constructor More...
	List (const List &plist)
	copy constructor More...
	List (ObjectHandle &&handle)
	constructor More...
List &	operator= (const List &type)
	copy assignment More...
virtual	~List ()
	destructor More...
List &	operator= (List &&type)=default
	List (List &&type)=default
Class	get_class () const
	return property list class More...
	operator hid_t () const
	conversion operator More...

Additional Inherited Members
Protected Member Functions inherited from hdf5::property::ObjectCreationList
	ObjectCreationList (const Class &plist_class)

Constructor & Destructor Documentation

FileCreationList() [1/2]

hdf5::property::FileCreationList::FileCreationList

(

)

~FileCreationList()

hdf5::property::FileCreationList::~FileCreationList ( )

override

FileCreationList() [2/2]

hdf5::property::FileCreationList::FileCreationList ( ObjectHandle &&  handle )

explicit

Construct a file creation property list from a handler instance. This constructor will throw an exception if the handle does not reference a file creation property list.

Exceptions

std::runtime_error

in case of a failure

Parameters

handle

r-value reference to a handle instance

Member Function Documentation

btree_rank() [1/2]

unsigned int hdf5::property::FileCreationList::btree_rank

(

)

const

btree_rank() [2/2]

void hdf5::property::FileCreationList::btree_rank

(

unsigned int

ik

)

btree_symbols() [1/2]

unsigned int hdf5::property::FileCreationList::btree_symbols

(

)

const

btree_symbols() [2/2]

void hdf5::property::FileCreationList::btree_symbols

(

unsigned int

lk

)

chunk_tree_rank() [1/2]

unsigned int hdf5::property::FileCreationList::chunk_tree_rank

(

)

const

chunk_tree_rank() [2/2]

void hdf5::property::FileCreationList::chunk_tree_rank

(

unsigned int

ik

)

object_length_size() [1/2]

size_t hdf5::property::FileCreationList::object_length_size

(

)

const

object_length_size() [2/2]

void hdf5::property::FileCreationList::object_length_size

(

size_t

size

)

const

object_offset_size() [1/2]

size_t hdf5::property::FileCreationList::object_offset_size

(

)

const

object_offset_size() [2/2]

void hdf5::property::FileCreationList::object_offset_size

(

size_t

size

)

const

page_size() [1/2]

hsize_t hdf5::property::FileCreationList::page_size

(

)

const

page_size() [2/2]

void hdf5::property::FileCreationList::page_size

(

hsize_t

size

)

user_block() [1/2]

hsize_t hdf5::property::FileCreationList::user_block

(

)

const

user_block() [2/2]

void hdf5::property::FileCreationList::user_block

(

hsize_t

size

)

const

---

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

• /home/jenkins/h5cpp/src/h5cpp/property/file_creation.hpp