dataset creation property list

#include <dataset_creation.hpp>

Inheritance diagram for hdf5::property::DatasetCreationList:

Collaboration diagram for hdf5::property::DatasetCreationList:

Public Member Functions
	DatasetCreationList ()
	default constructor More...

	DatasetCreationList (const DatasetCreationList &)=default

	~DatasetCreationList () override
	destructor More...

	DatasetCreationList (ObjectHandle &&handle)
	constructor More...

void	layout (DatasetLayout layout) const
	set dataset layout More...

DatasetLayout	layout () const
	get dataset layout More...

void	chunk (const hdf5::Dimensions &chunk_dims) const
	set chunk dimensions More...

hdf5::Dimensions	chunk () const
	get chunk dimensions More...

template<typename T >
void	fill_value (const T &value, const datatype::Datatype &type=datatype::TypeTrait< T >::create()) const
	set fill value for a dataset More...

template<typename T >
T	fill_value (const datatype::Datatype &type=datatype::TypeTrait< T >::create()) const
	get the fill value More...

DatasetFillValueStatus	fill_value_status () const

void	fill_time (DatasetFillTime time) const
	set fill time More...

DatasetFillTime	fill_time () const
	get fill time More...

void	allocation_time (DatasetAllocTime time) const
	set allocation time More...

DatasetAllocTime	allocation_time () const
	get allocation time More...

unsigned int	nfilters () const
	get a number of filters More...

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

◆ DatasetCreationList() [1/3]

hdf5::property::DatasetCreationList::DatasetCreationList ( )

◆ DatasetCreationList() [2/3]

hdf5::property::DatasetCreationList::DatasetCreationList ( const DatasetCreationList & )

default

◆ ~DatasetCreationList()

hdf5::property::DatasetCreationList::~DatasetCreationList ( )

override

◆ DatasetCreationList() [3/3]

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

explicit

Construct a new dataset creation property list from an HDF5 handle. This constructor will throw an exception if the handle does not reference a dataset creation property list.

Exceptions

std::runtime_error in case of a failure

Parameters

handle r-value reference to an HDF5 handle

Member Function Documentation

◆ allocation_time() [1/2]

DatasetAllocTime hdf5::property::DatasetCreationList::allocation_time ( ) const

See also: DatasetAllocTime; allocation_time(DatasetAllocTime)

◆ allocation_time() [2/2]

void hdf5::property::DatasetCreationList::allocation_time ( DatasetAllocTime time ) const

◆ chunk() [1/2]

hdf5::Dimensions hdf5::property::DatasetCreationList::chunk ( ) const

Exceptions

std::runtime_error in case of a failure

Returns: an instance of hdf5::Dimensions with the number of elements along each chunk dimension

◆ chunk() [2/2]

void hdf5::property::DatasetCreationList::chunk ( const hdf5::Dimensions & chunk_dims ) const

The chunk dimensions must be of same rank as the dataspace used to create the dataset.

Exceptions

std::runtime_error in case of a failure

Parameters

chunk_dims vector with elements along each chunk dimension

See also: chunk()

◆ fill_time() [1/2]

DatasetFillTime hdf5::property::DatasetCreationList::fill_time ( ) const

◆ fill_time() [2/2]

void hdf5::property::DatasetCreationList::fill_time ( DatasetFillTime time ) const

◆ fill_value() [1/2]

template<typename T >

T hdf5::property::DatasetCreationList::fill_value ( const datatype::Datatype & type = datatype::TypeTrait<T>::create() ) const

Get the fill value for a dataset stored in the property list as an instance of T. T must not necessarily be of the same type as the data type used t

Template Parameters

T	requrested type for the fill value

Parameters

type	optional HDF5 data type

◆ fill_value() [2/2]

template<typename T >

void hdf5::property::DatasetCreationList::fill_value	(	const T &	value,
		const datatype::Datatype &	type = `datatype::TypeTrait<T>::create()`
	)		const

By default the library tries to deduce the appropriate HDF5 data type automatically. This will succeed if

T is a native type already implemented in the library
the user has provided an appropriate type trait to construct an HDF5 datatype for T

Optionally, an HDF5 data type can be passed as a second argument to this member function. T must not necessarily be the same type used to create the dataset however, the two types must be convertible.

Exceptions

std::runtime_error in case of a failure

Parameters

value	the actual fill value
type	an optional HDF5 data type

Template Parameters

T	the type of the fill value

See also: fill_value(const datatype::Datatype &type)

◆ fill_value_status()

DatasetFillValueStatus hdf5::property::DatasetCreationList::fill_value_status ( ) const

◆ layout() [1/2]

DatasetLayout hdf5::property::DatasetCreationList::layout ( ) const

Exceptions

std::runtime_error in case of failures

Returns: new instance of DatasetLayout

See also: layout(DatasetLayout layout); DatasetLayout

◆ layout() [2/2]

void hdf5::property::DatasetCreationList::layout ( DatasetLayout layout ) const

Exceptions

std::runtime_error in case of failures

Parameters

layout required dataset layout

See also: layout()

◆ nfilters()

unsigned int hdf5::property::DatasetCreationList::nfilters ( ) const

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

/home/jenkins/h5cpp/src/h5cpp/property/dataset_creation.hpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ DatasetCreationList() [1/3]

◆ DatasetCreationList() [2/3]

◆ ~DatasetCreationList()

◆ DatasetCreationList() [3/3]

Member Function Documentation

◆ allocation_time() [1/2]

◆ allocation_time() [2/2]

◆ chunk() [1/2]

◆ chunk() [2/2]

◆ fill_time() [1/2]

◆ fill_time() [2/2]

◆ fill_value() [1/2]

◆ fill_value() [2/2]

◆ fill_value_status()

◆ layout() [1/2]

◆ layout() [2/2]

◆ nfilters()