FloatType is a derivative of a DataType and operates on HDF5 floating point datatype.

#include <H5FloatType.h>

Inheritance diagram for H5::FloatType:

Public Member Functions

FloatType (const PredType &pred_type)

Creates a floating-point datatype using a predefined type. More...

FloatType (const DataSet &dataset)

Gets the floating-point datatype of the specified dataset. More...

FloatType (const H5Location &loc, const char *name)

Creates an FloatType instance by opening an HDF5 float datatype given its name, provided as a C character string. More...

FloatType (const H5Location &loc, const H5std_string &name)

Creates an FloatType instance by opening an HDF5 float datatype given its name, provided as an H5std_string. More...

virtual DataType * decode () const

Returns an FloatType object via DataType* by decoding the binary object description of this type.

Exceptions

H5::DataTypeIException.

More...

size_t getEbias () const

Retrieves the exponent bias of a floating-point type. More...

void setEbias (size_t ebias) const

Sets the exponent bias of a floating-point type. More...

void getFields (size_t &spos, size_t &epos, size_t &esize, size_t &mpos, size_t &msize) const

Retrieves floating point datatype bit field information. More...

void setFields (size_t spos, size_t epos, size_t esize, size_t mpos, size_t msize) const

Sets locations and sizes of floating point bit fields. More...

H5T_pad_t getInpad (H5std_string &pad_string) const

Retrieves the internal padding type for unused bits in this floating-point datatypes. More...

void setInpad (H5T_pad_t inpad) const

Fills unused internal floating point bits. More...

H5T_norm_t getNorm (H5std_string &norm_string) const

Retrieves mantissa normalization of a floating-point datatype. More...

void setNorm (H5T_norm_t norm) const

Sets the mantissa normalization of a floating-point datatype. More...

virtual H5std_string fromClass () const

Returns this class name. More...

FloatType ()

Default constructor: Creates a stub floating-point datatype. More...

FloatType (const hid_t existing_id)

Creates an FloatType object using the id of an existing datatype. More...

FloatType (const FloatType &original)

Copy constructor: makes a copy of the original FloatType object. More...

virtual ~FloatType ()

Noop destructor. More...

Public Member Functions inherited from H5::AtomType

H5T_order_t getOrder () const

Returns the byte order of an atomic datatype. More...

H5T_order_t getOrder (H5std_string &order_string) const

This is an overloaded member function, provided for convenience. It takes a reference to a H5std_string for the buffer that provide the text description of the returned byte order. The text description can be either of the following: "Little endian byte ordering (0)"; "Big endian byte ordering (1)"; "VAX mixed byte ordering (2)";. More...

void setOrder (H5T_order_t order) const

Sets the byte ordering of an atomic datatype. More...

int getOffset () const

Retrieves the bit offset of the first significant bit. More...

void setOffset (size_t offset) const

Sets the bit offset of the first significant bit. More...

void getPad (H5T_pad_t &lsb, H5T_pad_t &msb) const

Retrieves the padding type of the least and most-significant bit padding. More...

void setPad (H5T_pad_t lsb, H5T_pad_t msb) const

Sets the least and most-significant bits padding types. More...

size_t getPrecision () const

Returns the precision of an atomic datatype. More...

void setPrecision (size_t precision) const

Sets the precision of an atomic datatype. More...

void setSize (size_t size) const

Sets the total size for an atomic datatype. More...

Public Member Functions inherited from H5::DataType

DataType (const H5T_class_t type_class, size_t size)

Creates a object given its class and size. More...

DataType (const DataType &original)

Copy constructor: makes a copy of the original DataType object. More...

DataType (const PredType &pred_type)

Creates a DataType instance using a predefined type. More...

DataType (const H5Location &loc, const char *name)

Creates a DataType instance by opening an HDF5 datatype given its name as a char*. More...

DataType (const H5Location &loc, const H5std_string &name)

Creates a DataType instance by opening an HDF5 datatype given its name as an H5std_string. More...

DataType (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

Given a reference, ref, to an hdf5 group, creates a DataType object. More...

DataType (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

Given a reference, ref, to an hdf5 group, creates a DataType object. More...

virtual void close ()

Closes the datatype if it is not a predefined type. More...

void copy (const DataType &like_type)

Copies an existing datatype to this datatype object. More...

void copy (const DataSet &dset)

Copies the datatype of the given dataset to this datatype object. More...

void encode ()

Creates a binary object description of this datatype.

Exceptions

H5::DataTypeIException.

More...

H5T_class_t getClass () const

Returns the datatype class identifier. More...

void commit (const H5Location &loc, const char *name)

Commits a transient datatype to a file, creating a new named datatype. More...

void commit (const H5Location &loc, const H5std_string &name)

This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

bool committed () const

Determines whether a datatype is a named type or a transient type. More...

H5T_conv_t find (const DataType &dest, H5T_cdata_t **pcdata) const

Finds a conversion function that can handle a conversion from this datatype to the specified datatype, dest. More...

void convert (const DataType &dest, size_t nelmts, void *buf, void *background, const PropList &plist=PropList::DEFAULT) const

Converts data from this datatype to the specified datatypes. More...

DataType & operator= (const DataType &rhs)

Assignment operator. More...

bool operator== (const DataType &compared_type) const

Compares this DataType against the given one to determines whether the two objects refer to the same actual datatype. More...

void lock () const

Locks a datatype, making it read-only and non-destructible. More...

size_t getSize () const

Returns the size of a datatype. More...

DataType getSuper () const

Returns the base datatype from which a datatype is derived. More...

void registerFunc (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const

Registers the specified conversion function. More...

void registerFunc (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const

This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

void unregister (H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const

Removes a conversion function from all conversion paths. More...

void unregister (H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const

This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

void setTag (const char *tag) const

Tags an opaque datatype. More...

void setTag (const H5std_string &tag) const

This is an overloaded member function, provided for convenience. It differs from the above function only in the type of the argument name. More...

H5std_string getTag () const

Gets the tag associated with an opaque datatype. More...

bool detectClass (H5T_class_t cls) const

Checks whether a datatype contains (or is) a certain type of datatype. More...

bool isVariableStr () const

Check whether this datatype is a variable-length string. More...

PropList getCreatePlist () const

Returns a copy of the property list, which is for datatype creation. More...

DataType (const hid_t type_id)

Creates a datatype using an existing datatype's id. More...

DataType ()

Default constructor: Creates a stub datatype. More...

bool hasBinaryDesc () const

Determines whether this datatype has a binary object description.

Exceptions

H5::DataTypeIException.

More...

virtual hid_t getId () const

Get the id of this datatype. More...

virtual ~DataType ()

Properly terminates access to this datatype. More...

Public Member Functions inherited from H5::H5Object

Attribute createAttribute (const char *name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const

Deprecated - replaced by H5Object::createAttribute. More...

Attribute createAttribute (const H5std_string &name, const DataType &type, const DataSpace &space, const PropList &create_plist=PropList::DEFAULT) const

Deprecated - replaced by H5Object::createAttribute. More...

Attribute openAttribute (const char *name) const

Deprecated - replaced by H5Object::openAttribute. More...

Attribute openAttribute (const H5std_string &name) const

Deprecated - replaced by H5Object::openAttribute. More...

Attribute openAttribute (const unsigned int idx) const

Deprecated - replaced by H5Object::openAttribute. More...

bool attrExists (const char *name) const

Deprecated - replaced by H5Object::attrExists() More...

bool attrExists (const H5std_string &name) const

Deprecated - replaced by H5Object::attrExists() More...

void renameAttr (const char *oldname, const char *newname) const

Deprecated - replaced by H5Object::renameAttr() More...

void renameAttr (const H5std_string &oldname, const H5std_string &newname) const

Deprecated - replaced by H5Object::renameAttr() More...

void removeAttr (const char *name) const

Deprecated - replaced by H5Object::removeAttr() More...

void removeAttr (const H5std_string &name) const

Deprecated - replaced by H5Object::removeAttr() More...

int getNumAttrs () const

ssize_t getObjName (char *obj_name, size_t buf_size=0) const

ssize_t getObjName (H5std_string &obj_name, size_t len=0) const

H5std_string getObjName () const

Public Member Functions inherited from H5::H5Location

bool nameExists (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Checks if a link of a given name exists in a location. More...

bool nameExists (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Checks if a link of a given name exists in a location. More...

void flush (H5F_scope_t scope) const

Flushes all buffers associated with a location to disk. More...

H5std_string getFileName () const

Gets the name of the file, in which this HDF5 object belongs. More...

void getObjectInfo (H5O_info_t *oinfo) const

Retrieve information about an object, specified by location.

Exceptions

H5::LocationException.

More...

void getObjectInfo (const char *name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Retrieve information about an object, specified by name.

Exceptions

H5::LocationException.

More...

void getObjectInfo (const H5std_string &name, H5O_info_t *oinfo, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Retrieve information about an object, specified by name.

Exceptions

H5::LocationException.

More...

int getNumAttrs () const

Deprecated - replaced by H5Object::getNumAttrs() More...

H5G_obj_t getObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const

Retrieves the type of object that an object reference points to. More...

H5O_type_t getRefObjType (void *ref, H5R_type_t ref_type=H5R_OBJECT) const

Retrieves the type of object that an object reference points to. More...

unsigned objVersion () const

Returns the header version of this HDF5 object. More...

void setComment (const char *name, const char *comment) const

Sets or resets the comment for an object specified by its name. More...

void setComment (const H5std_string &name, const H5std_string &comment) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name and comment. More...

void setComment (const char *comment) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it doesn't take an object name. More...

void setComment (const H5std_string &comment) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for comment. More...

ssize_t getComment (const char *name, size_t buf_size, char *comment) const

Retrieves the comment for this location, returning its length. More...

H5std_string getComment (const char *name, size_t buf_size=0) const

Returns the comment as string for this location, returning its length. More...

H5std_string getComment (const H5std_string &name, size_t buf_size=0) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...

void removeComment (const char *name) const

Removes the comment from an object specified by its name. More...

void removeComment (const H5std_string &name) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...

void reference (void *ref, const char *name, H5R_type_t ref_type=H5R_OBJECT) const

This is an overloaded function, provided for your convenience. It differs from the above function in that it does not take a DataSpace object and the reference type must be specified. More...

void reference (void *ref, const H5std_string &name, H5R_type_t ref_type=H5R_OBJECT) const

This is an overloaded function, provided for your convenience. It differs from the above function in that it takes an H5std_string for the object's name. More...

void reference (void *ref, const char *name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const

Creates a reference to an HDF5 object or a dataset region. More...

void reference (void *ref, const H5std_string &name, const DataSpace &dataspace, H5R_type_t ref_type=H5R_DATASET_REGION) const

This is an overloaded member function, provided for convenience. It differs from the above function in that it takes an H5std_string for name. More...

void dereference (const H5Location &loc, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

Dereferences a reference into an HDF5 object, given an HDF5 object. More...

void dereference (const Attribute &attr, const void *ref, H5R_type_t ref_type=H5R_OBJECT)

Dereferences a reference into an HDF5 object, given an attribute. More...

DataSpace getRegion (void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const

Retrieves a dataspace with the region pointed to selected. More...

hid_t openObjId (const char *name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

Opens an object without knowing the object type. More...

hid_t openObjId (const H5std_string &name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const

This is an overloaded member function, provided for convenience. It takes a reference to a H5std_string for the object's path. More...

void closeObjId (hid_t obj_id) const

Closes an object, which was opened with H5Location::openObjId. More...

virtual int iterateAttrs (attr_operator_t user_op, unsigned *idx=NULL, void *op_data=NULL)

Iterates a user's function over all the attributes of an H5 object, which may be a group, dataset or named datatype. More...

Public Member Functions inherited from H5::IdComponent

void incRefCount (const hid_t obj_id) const

Increment reference counter for a given id. More...

void incRefCount () const

Increment reference counter for the id of this object. More...

void decRefCount (const hid_t obj_id) const

Decrement reference counter for a given id. More...

void decRefCount () const

Decrement reference counter for the id of this object. More...

int getCounter (const hid_t obj_id) const

Returns the reference counter for a given id. More...

int getCounter () const

Returns the reference counter for the id of this object. More...

H5I_type_t getHDFObjType () const

Returns the type of the object. It is an overloaded function of the above function. More...

IdComponent & operator= (const IdComponent &rhs)

Assignment operator. More...

void setId (const hid_t new_id)

Sets the identifier of this object to a new value. More...

virtual ~IdComponent ()

Noop destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)
	Given an id, returns the type of the object. More...

static bool	isValid (hid_t an_id)
	Checks if the given ID is valid. More...

Protected Member Functions inherited from H5::H5Location
virtual	~H5Location ()
	Noop destructor. More...

Constructor & Destructor Documentation

H5::FloatType::FloatType ( const PredType & pred_type )

Parameters

pred_type - IN: Predefined datatype

Exceptions

H5::DataTypeIException

References H5::DataType::copy().

H5::FloatType::FloatType ( const DataSet & dataset )

Parameters

dataset - IN: Dataset that this floating-point datatype associates with

Exceptions

H5::DataTypeIException

References H5::DataSet::getId().

H5::FloatType::FloatType	(	const H5Location &	loc,
		const char *	type_name
	)

Parameters

loc	- IN: Location of the type
type_name	- IN: Float type name

Exceptions

H5::DataTypeIException

H5::FloatType::FloatType	(	const H5Location &	loc,
		const H5std_string &	type_name
	)

Parameters

loc	- IN: Location of the type
type_name	- IN: Float type name

Exceptions

H5::DataTypeIException

H5::FloatType::FloatType ( )

Referenced by decode().

H5::FloatType::FloatType ( const hid_t existing_id )

Parameters

existing_id - IN: Id of an existing datatype

Exceptions

H5::DataTypeIException

H5::FloatType::FloatType ( const FloatType & original )

H5::FloatType::~FloatType ( )

virtual

Member Function Documentation

DataType * H5::FloatType::decode ( ) const

virtual

Reimplemented from H5::DataType.

References FloatType().

virtual H5std_string H5::FloatType::fromClass ( ) const

inlinevirtual

Reimplemented from H5::AtomType.

size_t H5::FloatType::getEbias ( ) const

Returns: Exponent bias

Exceptions

H5::DataTypeIException

void H5::FloatType::getFields	(	size_t &	spos,
		size_t &	epos,
		size_t &	esize,
		size_t &	mpos,
		size_t &	msize
	)		const

Parameters

spos	- OUT: Retrieved floating-point sign bit
epos	- OUT: Retrieved exponent bit-position
esize	- OUT: Retrieved size of exponent, in bits
mpos	- OUT: Retrieved mantissa bit-position
msize	- OUT: Retrieved size of mantissa, in bits

Exceptions

H5::DataTypeIException

H5T_pad_t H5::FloatType::getInpad ( H5std_string & pad_string ) const

Returns

Internal padding type, which can be:

H5T_PAD_ZERO (0) - Set background to zeros
H5T_PAD_ONE (1) - Set background to ones
H5T_PAD_BACKGROUND (2) - Leave background alone

Exceptions

H5::DataTypeIException

Description: For your convenience, this function also provides the text string of the returned internal padding type, via parameter pad_string.

H5T_norm_t H5::FloatType::getNorm ( H5std_string & norm_string ) const

Parameters

norm_string - OUT: Text string of the normalization type

Returns

Valid normalization type, which can be:

H5T_NORM_IMPLIED (0) - MSB of mantissa is not stored
H5T_NORM_MSBSET (1) - MSB of mantissa is always 1
H5T_NORM_NONE (2) - Mantissa is not normalized

Exceptions

H5::DataTypeIException

Description: For your convenience, this function also provides the text string of the returned normalization type, via parameter norm_string.

void H5::FloatType::setEbias ( size_t ebias ) const

Parameters

ebias - Exponent bias value

Exceptions

H5::DataTypeIException

void H5::FloatType::setFields	(	size_t	spos,
		size_t	epos,
		size_t	esize,
		size_t	mpos,
		size_t	msize
	)		const

Parameters

spos	- OUT: Sign position, i.e., the bit offset of the floating-point sign bit.
epos	- OUT: Exponent bit position
esize	- OUT: Size of exponent, in bits
mpos	- OUT: Mantissa bit-position
msize	- OUT: Size of mantissa, in bits

Exceptions

H5::DataTypeIException

void H5::FloatType::setInpad ( H5T_pad_t inpad ) const

Parameters

inpad - IN: Internal padding type

Exceptions

H5::DataTypeIException

Description: If any internal bits of a floating point type are unused (that is, those significant bits which are not part of the sign, exponent, or mantissa), then they will be filled according to the padding value provided by inpad.

Valid values for normalization type include:

H5T_PAD_ZERO (0) - Set background to zeros
H5T_PAD_ONE (1) - Set background to ones
H5T_PAD_BACKGROUND (2) - Leave background alone

void H5::FloatType::setNorm ( H5T_norm_t norm ) const

Parameters

norm	- IN: Mantissa normalization type

Exceptions

H5::DataTypeIException

Description

Valid values for normalization type include:

H5T_NORM_IMPLIED (0) - MSB of mantissa is not stored
H5T_NORM_MSBSET (1) - MSB of mantissa is always 1
H5T_NORM_NONE (2) - Mantissa is not normalized

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

H5FloatType.h
H5FloatType.cpp

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation