hdf5::datatype Namespace Reference

Classes
class	Array
	array datatype More...
class	Compound
	compound data type More...
class	Datatype
	base class for all data types More...
class	Enum
	compound data type More...
class	Float
class	Integer
	HDF5 integer datatype. More...
class	String
	string datatype More...
class	TypeTrait
	trait to create HDF5 datatypes More...
class	TypeTrait< ArrayAdapter< T > >
	datatype type trait for array adapters
class	TypeTrait< bool >
class	TypeTrait< char >
class	TypeTrait< datatype::EBool >
class	TypeTrait< double >
class	TypeTrait< float >
class	TypeTrait< int >
class	TypeTrait< long >
class	TypeTrait< long double >
class	TypeTrait< long long >
class	TypeTrait< short >
class	TypeTrait< signed char >
class	TypeTrait< std::array< T, N > >
class	TypeTrait< std::basic_string< CharT > >
class	TypeTrait< std::string >
class	TypeTrait< std::vector< T > >
class	TypeTrait< unsigned char >
class	TypeTrait< unsigned int >
class	TypeTrait< unsigned long >
class	TypeTrait< unsigned long long >
class	TypeTrait< unsigned short >
class	VLengthArray
	variable length array type More...

Enumerations
enum	EBool : int8_t { FALSE = 0, TRUE = 1 }
	enumeration bool type More...
enum	Class : std::underlying_type< H5T_class_t >::type {   Class::NONE = H5T_NO_CLASS, Class::INTEGER = H5T_INTEGER, Class::FLOAT = H5T_FLOAT, Class::TIME = H5T_TIME,   Class::STRING = H5T_STRING, Class::BITFIELD = H5T_BITFIELD, Class::OPAQUE = H5T_OPAQUE, Class::COMPOUND = H5T_COMPOUND,   Class::REFERENCE = H5T_REFERENCE, Class::ENUM = H5T_ENUM, Class::VARLENGTH = H5T_VLEN, Class::ARRAY = H5T_ARRAY }
enum	Order : std::underlying_type< H5T_order_t >::type { Order::LE = H5T_ORDER_LE, Order::BE = H5T_ORDER_BE }
	enumeration type for byte order More...
enum	Sign : std::underlying_type< H5T_sign_t >::type { Sign::TWOS_COMPLEMENT = H5T_SGN_2, Sign::UNSIGNED = H5T_SGN_NONE }
	enumeration for sign More...
enum	Norm : std::underlying_type< H5T_norm_t >::type { Norm::IMPLIED = H5T_NORM_IMPLIED, Norm::MSBSET = H5T_NORM_MSBSET, Norm::NONE = H5T_NORM_NONE }
	enumeration describes mantissa norm More...
enum	Pad : std::underlying_type< H5T_pad_t >::type { Pad::ZERO = H5T_PAD_ZERO, Pad::ONE = H5T_PAD_ONE, Pad::BACKGROUND = H5T_PAD_BACKGROUND }
	enumeration for floating point padding More...
enum	StringPad : std::underlying_type< H5T_str_t >::type { StringPad::NULLTERM = H5T_STR_NULLTERM, StringPad::NULLPAD = H5T_STR_NULLPAD, StringPad::SPACEPAD = H5T_STR_SPACEPAD }
	enumeration determining string padding More...
enum	Direction : std::underlying_type< H5T_direction_t >::type { Direction::ASCEND = H5T_DIR_ASCEND, Direction::DESCEND = H5T_DIR_DESCEND }
enum	CharacterEncoding : std::underlying_type< H5T_cset_t >::type { CharacterEncoding::ASCII = H5T_CSET_ASCII, CharacterEncoding::UTF8 = H5T_CSET_UTF8 }
	character set encoding More...

Functions
DLL_EXPORT bool	is_bool (const Enum &etype)
	check if Enum is EBool More...
template<typename T >
TypeTrait< typename std::remove_const< T >::type >::TypeClass	create (const T &v=T())
	factory function for creating data types More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const Order &o)
	output stream operator for the Order enumeration More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const Sign &s)
	output stream for Sign enumeration More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const Norm &n)
	stream output operator for the Norm enumeration More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const Pad &p)
	stream output operator for Pad enumerations More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const StringPad &pad)
	stream output operator for StringPad enumerations More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const Direction &d)
	stream output operator for Direction enumerations More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const CharacterEncoding &enc)
	stream output operator for CharacterEncoding enumerations More...

Variables
decltype(H5T_VARIABLE) const	kVariable = H5T_VARIABLE

Enumeration Type Documentation

CharacterEncoding

enum hdf5::datatype::CharacterEncoding : std::underlying_type< H5T_cset_t >::type

strong

Enumeration type determining the character encoding used by string types and links.

Enumerator
ASCII	ASCII.
UTF8	UTF8.

Class

enum hdf5::datatype::Class : std::underlying_type< H5T_class_t >::type

strong

Enumerator
NONE	indicates a non-type
INTEGER	indicates an integer type
FLOAT	indicates a float type
TIME	indicates a time type
STRING	indicates a string type
BITFIELD	indicates a bitfield type
OPAQUE	indicates an opaque type
COMPOUND	indicates a compound type
REFERENCE	indicates a reference type
ENUM	indicates an enumeration type
VARLENGTH	indicates a variable length type
ARRAY	indicates an array type

Direction

enum hdf5::datatype::Direction : std::underlying_type< H5T_direction_t >::type

strong

Enumerator
ASCEND
DESCEND

EBool

enum hdf5::datatype::EBool : int8_t

Enumerator
FALSE	indicates a false value
TRUE	indicates a true value

Norm

enum hdf5::datatype::Norm : std::underlying_type< H5T_norm_t >::type

strong

Enumerator
IMPLIED
MSBSET
NONE

Order

enum hdf5::datatype::Order : std::underlying_type< H5T_order_t >::type

strong

Enumerator
LE	littlen endian type
BE	big endian type

Pad

enum hdf5::datatype::Pad : std::underlying_type< H5T_pad_t >::type

strong

Enumerator
ZERO
ONE
BACKGROUND

Sign

enum hdf5::datatype::Sign : std::underlying_type< H5T_sign_t >::type

strong

Enumerator
TWOS_COMPLEMENT	indicates a signed type
UNSIGNED	indicates an unsigned type

StringPad

enum hdf5::datatype::StringPad : std::underlying_type< H5T_str_t >::type

strong

Enumerator
NULLTERM	indicates a null terminated string type
NULLPAD	indicates a null padded string type
SPACEPAD	indicates a space padded string type

Function Documentation

create()

template<typename T >

TypeTrait<typename std::remove_const<T>::type>::TypeClass hdf5::datatype::create

(

const T &

v = T()

)

is_bool()

DLL_EXPORT bool hdf5::datatype::is_bool

(

const Enum &

etype

)

Parameters

Enum

object

Returns

if Enum is EBool flag

operator<<() [1/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const Order &	o
	)

Parameters

stream	reference to the output stream
o	reference to an Order enumeration instance

Returns

modified output stream

operator<<() [2/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const Sign &	s
	)

Parameters

stream	reference to the output stream
s	reference to the Sign enumeration

Returns

modified output stream

operator<<() [3/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const Norm &	n
	)

Parameters

stream	reference to the output stream
n	refernece to a Norm enumeration instance

Returns

modified ouput stream

operator<<() [4/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const Pad &	p
	)

Parameters

stream	reference to the output stream
p	reference to a Pad enumeratino instance

Returns

modified output stream

operator<<() [5/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const StringPad &	pad
	)

Parameters

stream	reference to an output stream
pad	reference to a StringPad enumeration instance

Returns

modified output stream

operator<<() [6/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const Direction &	d
	)

Parameters

stream	reference to an output stream
d	reference to a Direction enumeration instance

Returns

modified output stream

operator<<() [7/7]

DLL_EXPORT std::ostream& hdf5::datatype::operator<<	(	std::ostream &	stream,
		const CharacterEncoding &	enc
	)

Parameters

stream	reference to an output stream
enc	reference to a CharacterEncoding enumeration instance

Returns

modified output stream

Variable Documentation

kVariable

decltype(H5T_VARIABLE) const hdf5::datatype::kVariable = H5T_VARIABLE