Bindings.HDF5.Raw.H5T

Documentation

newtype H5T_class_t

These are the various classes of datatypes

If this goes over 16 types (0-15), the file format will need to change)

Constructors

H5T_class_t Int32

Instances

Storable H5T_class_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_class_t -> Int

alignment :: H5T_class_t -> Int

peekElemOff :: Ptr H5T_class_t -> Int -> IO H5T_class_t

pokeElemOff :: Ptr H5T_class_t -> Int -> H5T_class_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_class_t

pokeByteOff :: Ptr b -> Int -> H5T_class_t -> IO ()

peek :: Ptr H5T_class_t -> IO H5T_class_t

poke :: Ptr H5T_class_t -> H5T_class_t -> IO ()

Show H5T_class_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_class_t -> ShowS

show :: H5T_class_t -> String

showList :: [H5T_class_t] -> ShowS

Eq H5T_class_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_class_t -> H5T_class_t -> Bool

(/=) :: H5T_class_t -> H5T_class_t -> Bool

h5t_NO_CLASS :: H5T_class_t

error

h5t_INTEGER :: H5T_class_t

integer types

h5t_FLOAT :: H5T_class_t

floating-point types

h5t_TIME :: H5T_class_t

date and time types

h5t_STRING :: H5T_class_t

character string types

h5t_BITFIELD :: H5T_class_t

bit field types

h5t_OPAQUE :: H5T_class_t

opaque types

h5t_COMPOUND :: H5T_class_t

compound types

h5t_REFERENCE :: H5T_class_t

reference types

h5t_ENUM :: H5T_class_t

enumeration types

h5t_VLEN :: H5T_class_t

Variable-Length types

h5t_ARRAY :: H5T_class_t

Array types

h5t_NCLASSES :: Num a => a

The number of basic datatypes

newtype H5T_order_t

Byte orders

Constructors

H5T_order_t Int32

Instances

Storable H5T_order_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_order_t -> Int

alignment :: H5T_order_t -> Int

peekElemOff :: Ptr H5T_order_t -> Int -> IO H5T_order_t

pokeElemOff :: Ptr H5T_order_t -> Int -> H5T_order_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_order_t

pokeByteOff :: Ptr b -> Int -> H5T_order_t -> IO ()

peek :: Ptr H5T_order_t -> IO H5T_order_t

poke :: Ptr H5T_order_t -> H5T_order_t -> IO ()

Show H5T_order_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_order_t -> ShowS

show :: H5T_order_t -> String

showList :: [H5T_order_t] -> ShowS

Eq H5T_order_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_order_t -> H5T_order_t -> Bool

(/=) :: H5T_order_t -> H5T_order_t -> Bool

HDFResultType H5T_order_t

Defined in Bindings.HDF5.Core.HDFResultType

Methods

isError :: H5T_order_t -> Bool

h5t_ORDER_ERROR :: H5T_order_t

error

h5t_ORDER_LE :: H5T_order_t

little endian

h5t_ORDER_BE :: H5T_order_t

bit endian

h5t_ORDER_VAX :: H5T_order_t

VAX mixed endian

h5t_ORDER_MIXED :: H5T_order_t

Compound type with mixed member orders

h5t_ORDER_NONE :: H5T_order_t

no particular order (strings, bits,..)

newtype H5T_sign_t

Types of integer sign schemes

Constructors

H5T_sign_t Int32

Instances

Storable H5T_sign_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_sign_t -> Int

alignment :: H5T_sign_t -> Int

peekElemOff :: Ptr H5T_sign_t -> Int -> IO H5T_sign_t

pokeElemOff :: Ptr H5T_sign_t -> Int -> H5T_sign_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_sign_t

pokeByteOff :: Ptr b -> Int -> H5T_sign_t -> IO ()

peek :: Ptr H5T_sign_t -> IO H5T_sign_t

poke :: Ptr H5T_sign_t -> H5T_sign_t -> IO ()

Show H5T_sign_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_sign_t -> ShowS

show :: H5T_sign_t -> String

showList :: [H5T_sign_t] -> ShowS

Eq H5T_sign_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_sign_t -> H5T_sign_t -> Bool

(/=) :: H5T_sign_t -> H5T_sign_t -> Bool

h5t_SGN_ERROR :: H5T_sign_t

error

h5t_SGN_NONE :: H5T_sign_t

this is an unsigned type

h5t_SGN_2 :: H5T_sign_t

two's complement

h5t_NSGN :: Num a => a

The number of recognized integer sign schemes

newtype H5T_norm_t

Floating-point normalization schemes

Constructors

H5T_norm_t Int32

Instances

Storable H5T_norm_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_norm_t -> Int

alignment :: H5T_norm_t -> Int

peekElemOff :: Ptr H5T_norm_t -> Int -> IO H5T_norm_t

pokeElemOff :: Ptr H5T_norm_t -> Int -> H5T_norm_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_norm_t

pokeByteOff :: Ptr b -> Int -> H5T_norm_t -> IO ()

peek :: Ptr H5T_norm_t -> IO H5T_norm_t

poke :: Ptr H5T_norm_t -> H5T_norm_t -> IO ()

Show H5T_norm_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_norm_t -> ShowS

show :: H5T_norm_t -> String

showList :: [H5T_norm_t] -> ShowS

Eq H5T_norm_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_norm_t -> H5T_norm_t -> Bool

(/=) :: H5T_norm_t -> H5T_norm_t -> Bool

HDFResultType H5T_norm_t

Defined in Bindings.HDF5.Core.HDFResultType

Methods

isError :: H5T_norm_t -> Bool

h5t_NORM_ERROR :: H5T_norm_t

error

h5t_NORM_IMPLIED :: H5T_norm_t

msb of mantissa isn't stored, always 1

h5t_NORM_MSBSET :: H5T_norm_t

msb of mantissa is always 1

h5t_NORM_NONE :: H5T_norm_t

not normalized

newtype H5T_cset_t

Character set to use for text strings. Do not change these values since they appear in HDF5 files!

Constructors

H5T_cset_t Int32

Instances

Storable H5T_cset_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_cset_t -> Int

alignment :: H5T_cset_t -> Int

peekElemOff :: Ptr H5T_cset_t -> Int -> IO H5T_cset_t

pokeElemOff :: Ptr H5T_cset_t -> Int -> H5T_cset_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_cset_t

pokeByteOff :: Ptr b -> Int -> H5T_cset_t -> IO ()

peek :: Ptr H5T_cset_t -> IO H5T_cset_t

poke :: Ptr H5T_cset_t -> H5T_cset_t -> IO ()

Read H5T_cset_t

Defined in Bindings.HDF5.Raw.H5T

Methods

readsPrec :: Int -> ReadS H5T_cset_t

readList :: ReadS [H5T_cset_t]

readPrec :: ReadPrec H5T_cset_t

readListPrec :: ReadPrec [H5T_cset_t]

Show H5T_cset_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_cset_t -> ShowS

show :: H5T_cset_t -> String

showList :: [H5T_cset_t] -> ShowS

Eq H5T_cset_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_cset_t -> H5T_cset_t -> Bool

(/=) :: H5T_cset_t -> H5T_cset_t -> Bool

Ord H5T_cset_t

Defined in Bindings.HDF5.Raw.H5T

Methods

compare :: H5T_cset_t -> H5T_cset_t -> Ordering

(<) :: H5T_cset_t -> H5T_cset_t -> Bool

(<=) :: H5T_cset_t -> H5T_cset_t -> Bool

(>) :: H5T_cset_t -> H5T_cset_t -> Bool

(>=) :: H5T_cset_t -> H5T_cset_t -> Bool

max :: H5T_cset_t -> H5T_cset_t -> H5T_cset_t

min :: H5T_cset_t -> H5T_cset_t -> H5T_cset_t

h5t_CSET_ERROR :: H5T_cset_t

error

h5t_CSET_ASCII :: H5T_cset_t

US ASCII

h5t_CSET_UTF8 :: H5T_cset_t

UTF-8 Unicode encoding

h5t_CSET_RESERVED_2 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_3 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_4 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_5 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_6 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_7 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_8 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_9 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_10 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_11 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_12 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_13 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_14 :: H5T_cset_t

reserved for later use

h5t_CSET_RESERVED_15 :: H5T_cset_t

reserved for later use

h5t_NCSET :: Num a => a

Number of character sets actually defined

newtype H5T_str_t

Type of padding to use in character strings. Do not change these values since they appear in HDF5 files!

Constructors

H5T_str_t Int32

Instances

Storable H5T_str_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_str_t -> Int

alignment :: H5T_str_t -> Int

peekElemOff :: Ptr H5T_str_t -> Int -> IO H5T_str_t

pokeElemOff :: Ptr H5T_str_t -> Int -> H5T_str_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_str_t

pokeByteOff :: Ptr b -> Int -> H5T_str_t -> IO ()

peek :: Ptr H5T_str_t -> IO H5T_str_t

poke :: Ptr H5T_str_t -> H5T_str_t -> IO ()

Show H5T_str_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_str_t -> ShowS

show :: H5T_str_t -> String

showList :: [H5T_str_t] -> ShowS

Eq H5T_str_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_str_t -> H5T_str_t -> Bool

(/=) :: H5T_str_t -> H5T_str_t -> Bool

HDFResultType H5T_str_t

Defined in Bindings.HDF5.Core.HDFResultType

Methods

isError :: H5T_str_t -> Bool

h5t_STR_ERROR :: H5T_str_t

error

h5t_STR_NULLTERM :: H5T_str_t

null terminate like in C

h5t_STR_NULLPAD :: H5T_str_t

pad with nulls

h5t_STR_SPACEPAD :: H5T_str_t

pad with spaces like in Fortran

h5t_STR_RESERVED_3 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_4 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_5 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_6 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_7 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_8 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_9 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_10 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_11 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_12 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_13 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_14 :: H5T_str_t

reserved for later use

h5t_STR_RESERVED_15 :: H5T_str_t

reserved for later use

h5t_NSTR :: Num a => a

num H5T_str_t types actually defined

newtype H5T_pad_t

Type of padding to use in other atomic types

Constructors

H5T_pad_t Int32

Instances

Storable H5T_pad_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_pad_t -> Int

alignment :: H5T_pad_t -> Int

peekElemOff :: Ptr H5T_pad_t -> Int -> IO H5T_pad_t

pokeElemOff :: Ptr H5T_pad_t -> Int -> H5T_pad_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_pad_t

pokeByteOff :: Ptr b -> Int -> H5T_pad_t -> IO ()

peek :: Ptr H5T_pad_t -> IO H5T_pad_t

poke :: Ptr H5T_pad_t -> H5T_pad_t -> IO ()

Show H5T_pad_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_pad_t -> ShowS

show :: H5T_pad_t -> String

showList :: [H5T_pad_t] -> ShowS

Eq H5T_pad_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_pad_t -> H5T_pad_t -> Bool

(/=) :: H5T_pad_t -> H5T_pad_t -> Bool

HDFResultType H5T_pad_t

Defined in Bindings.HDF5.Core.HDFResultType

Methods

isError :: H5T_pad_t -> Bool

h5t_PAD_ERROR :: H5T_pad_t

error

h5t_PAD_ZERO :: H5T_pad_t

always set to zero

h5t_PAD_ONE :: H5T_pad_t

always set to one

h5t_PAD_BACKGROUND :: H5T_pad_t

set to background value

h5t_NPAD :: Num a => a

Number of valid H5T_pad_t values.

newtype H5T_cmd_t

Commands sent to conversion functions

Constructors

H5T_cmd_t Word32

Instances

Storable H5T_cmd_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_cmd_t -> Int

alignment :: H5T_cmd_t -> Int

peekElemOff :: Ptr H5T_cmd_t -> Int -> IO H5T_cmd_t

pokeElemOff :: Ptr H5T_cmd_t -> Int -> H5T_cmd_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_cmd_t

pokeByteOff :: Ptr b -> Int -> H5T_cmd_t -> IO ()

peek :: Ptr H5T_cmd_t -> IO H5T_cmd_t

poke :: Ptr H5T_cmd_t -> H5T_cmd_t -> IO ()

Show H5T_cmd_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_cmd_t -> ShowS

show :: H5T_cmd_t -> String

showList :: [H5T_cmd_t] -> ShowS

Eq H5T_cmd_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_cmd_t -> H5T_cmd_t -> Bool

(/=) :: H5T_cmd_t -> H5T_cmd_t -> Bool

h5t_CONV_INIT :: H5T_cmd_t

query and/or initialize private data

h5t_CONV_CONV :: H5T_cmd_t

convert data from source to dest datatype

h5t_CONV_FREE :: H5T_cmd_t

function is being removed from path

newtype H5T_bkg_t

How is the bkg buffer used by the conversion function?

Constructors

H5T_bkg_t Word32

Instances

Storable H5T_bkg_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_bkg_t -> Int

alignment :: H5T_bkg_t -> Int

peekElemOff :: Ptr H5T_bkg_t -> Int -> IO H5T_bkg_t

pokeElemOff :: Ptr H5T_bkg_t -> Int -> H5T_bkg_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_bkg_t

pokeByteOff :: Ptr b -> Int -> H5T_bkg_t -> IO ()

peek :: Ptr H5T_bkg_t -> IO H5T_bkg_t

poke :: Ptr H5T_bkg_t -> H5T_bkg_t -> IO ()

Show H5T_bkg_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_bkg_t -> ShowS

show :: H5T_bkg_t -> String

showList :: [H5T_bkg_t] -> ShowS

Eq H5T_bkg_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_bkg_t -> H5T_bkg_t -> Bool

(/=) :: H5T_bkg_t -> H5T_bkg_t -> Bool

h5t_BKG_NO :: H5T_bkg_t

background buffer is not needed, send NULL

h5t_BKG_TEMP :: H5T_bkg_t

bkg buffer used as temp storage only

h5t_BKG_YES :: H5T_bkg_t

init bkg buf with data before conversion

data H5T_cdata_t a

Type conversion client data

Constructors

H5T_cdata_t

Fields

• h5t_cdata_t'command :: H5T_cmd_t

  what should the conversion function do?

• h5t_cdata_t'need_bkg :: H5T_bkg_t

  is the background buffer needed?

• h5t_cdata_t'recalc :: HBool_t

  recalculate private data

• h5t_cdata_t'priv :: Ptr a

  private data

Instances

Storable (H5T_cdata_t a)

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_cdata_t a -> Int

alignment :: H5T_cdata_t a -> Int

peekElemOff :: Ptr (H5T_cdata_t a) -> Int -> IO (H5T_cdata_t a)

pokeElemOff :: Ptr (H5T_cdata_t a) -> Int -> H5T_cdata_t a -> IO ()

peekByteOff :: Ptr b -> Int -> IO (H5T_cdata_t a)

pokeByteOff :: Ptr b -> Int -> H5T_cdata_t a -> IO ()

peek :: Ptr (H5T_cdata_t a) -> IO (H5T_cdata_t a)

poke :: Ptr (H5T_cdata_t a) -> H5T_cdata_t a -> IO ()

Show (H5T_cdata_t a)

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_cdata_t a -> ShowS

show :: H5T_cdata_t a -> String

showList :: [H5T_cdata_t a] -> ShowS

Eq (H5T_cdata_t a)

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: H5T_cdata_t a -> H5T_cdata_t a -> Bool

(/=) :: H5T_cdata_t a -> H5T_cdata_t a -> Bool

newtype H5T_pers_t

Conversion function persistence

Constructors

H5T_pers_t Int32

Instances

Storable H5T_pers_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_pers_t -> Int

alignment :: H5T_pers_t -> Int

peekElemOff :: Ptr H5T_pers_t -> Int -> IO H5T_pers_t

pokeElemOff :: Ptr H5T_pers_t -> Int -> H5T_pers_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_pers_t

pokeByteOff :: Ptr b -> Int -> H5T_pers_t -> IO ()

peek :: Ptr H5T_pers_t -> IO H5T_pers_t

poke :: Ptr H5T_pers_t -> H5T_pers_t -> IO ()

Show H5T_pers_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_pers_t -> ShowS

show :: H5T_pers_t -> String

showList :: [H5T_pers_t] -> ShowS

h5t_PERS_DONTCARE :: H5T_pers_t

wild card

h5t_PERS_HARD :: H5T_pers_t

hard conversion function

h5t_PERS_SOFT :: H5T_pers_t

soft conversion function

newtype H5T_direction_t

The order to retrieve atomic native datatype

Constructors

H5T_direction_t Word32

Instances

Storable H5T_direction_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_direction_t -> Int

alignment :: H5T_direction_t -> Int

peekElemOff :: Ptr H5T_direction_t -> Int -> IO H5T_direction_t

pokeElemOff :: Ptr H5T_direction_t -> Int -> H5T_direction_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_direction_t

pokeByteOff :: Ptr b -> Int -> H5T_direction_t -> IO ()

peek :: Ptr H5T_direction_t -> IO H5T_direction_t

poke :: Ptr H5T_direction_t -> H5T_direction_t -> IO ()

Show H5T_direction_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_direction_t -> ShowS

show :: H5T_direction_t -> String

showList :: [H5T_direction_t] -> ShowS

h5t_DIR_DEFAULT :: H5T_direction_t

default direction is inscendent

h5t_DIR_ASCEND :: H5T_direction_t

in inscendent order

h5t_DIR_DESCEND :: H5T_direction_t

in descendent order

newtype H5T_conv_except_t

The exception type passed into the conversion callback function

Constructors

H5T_conv_except_t Word32

Instances

Storable H5T_conv_except_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_conv_except_t -> Int

alignment :: H5T_conv_except_t -> Int

peekElemOff :: Ptr H5T_conv_except_t -> Int -> IO H5T_conv_except_t

pokeElemOff :: Ptr H5T_conv_except_t -> Int -> H5T_conv_except_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_conv_except_t

pokeByteOff :: Ptr b -> Int -> H5T_conv_except_t -> IO ()

peek :: Ptr H5T_conv_except_t -> IO H5T_conv_except_t

poke :: Ptr H5T_conv_except_t -> H5T_conv_except_t -> IO ()

Show H5T_conv_except_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_conv_except_t -> ShowS

show :: H5T_conv_except_t -> String

showList :: [H5T_conv_except_t] -> ShowS

h5t_CONV_EXCEPT_RANGE_HI :: H5T_conv_except_t

source value is greater than destination's range

h5t_CONV_EXCEPT_RANGE_LOW :: H5T_conv_except_t

source value is less than destination's range

h5t_CONV_EXCEPT_PRECISION :: H5T_conv_except_t

source value loses precision in destination

h5t_CONV_EXCEPT_TRUNCATE :: H5T_conv_except_t

source value is truncated in destination

h5t_CONV_EXCEPT_PINF :: H5T_conv_except_t

source value is positive infinity(floating number)

h5t_CONV_EXCEPT_NINF :: H5T_conv_except_t

source value is negative infinity(floating number)

h5t_CONV_EXCEPT_NAN :: H5T_conv_except_t

source value is NaN(floating number)

newtype H5T_conv_ret_t

The return value from conversion callback function h5t_conv_except_func_t

Constructors

H5T_conv_ret_t Int32

Instances

Storable H5T_conv_ret_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: H5T_conv_ret_t -> Int

alignment :: H5T_conv_ret_t -> Int

peekElemOff :: Ptr H5T_conv_ret_t -> Int -> IO H5T_conv_ret_t

pokeElemOff :: Ptr H5T_conv_ret_t -> Int -> H5T_conv_ret_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO H5T_conv_ret_t

pokeByteOff :: Ptr b -> Int -> H5T_conv_ret_t -> IO ()

peek :: Ptr H5T_conv_ret_t -> IO H5T_conv_ret_t

poke :: Ptr H5T_conv_ret_t -> H5T_conv_ret_t -> IO ()

Show H5T_conv_ret_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> H5T_conv_ret_t -> ShowS

show :: H5T_conv_ret_t -> String

showList :: [H5T_conv_ret_t] -> ShowS

h5t_CONV_ABORT :: H5T_conv_ret_t

abort conversion

h5t_CONV_UNHANDLED :: H5T_conv_ret_t

callback function failed to handle the exception

h5t_CONV_HANDLED :: H5T_conv_ret_t

callback function handled the exception successfully

data HVl_t

Variable Length Datatype struct in memory (This is only used for VL sequences, not VL strings, which are stored in char *'s)

Length of VL data (in base type units)

Pointer to VL data

Constructors

HVl_t

Fields

• hvl_t'len :: CSize
• hvl_t'p :: Ptr ()

Instances

Storable HVl_t

Defined in Bindings.HDF5.Raw.H5T

Methods

sizeOf :: HVl_t -> Int

alignment :: HVl_t -> Int

peekElemOff :: Ptr HVl_t -> Int -> IO HVl_t

pokeElemOff :: Ptr HVl_t -> Int -> HVl_t -> IO ()

peekByteOff :: Ptr b -> Int -> IO HVl_t

pokeByteOff :: Ptr b -> Int -> HVl_t -> IO ()

peek :: Ptr HVl_t -> IO HVl_t

poke :: Ptr HVl_t -> HVl_t -> IO ()

Show HVl_t

Defined in Bindings.HDF5.Raw.H5T

Methods

showsPrec :: Int -> HVl_t -> ShowS

show :: HVl_t -> String

showList :: [HVl_t] -> ShowS

Eq HVl_t

Defined in Bindings.HDF5.Raw.H5T

Methods

(==) :: HVl_t -> HVl_t -> Bool

(/=) :: HVl_t -> HVl_t -> Bool

h5t_VARIABLE :: CSize

Indicate that a string is variable length (null-terminated in C, instead of fixed length)

p'hvl_t'len :: Ptr HVl_t -> Ptr CSize

p'hvl_t'p :: Ptr HVl_t -> Ptr (Ptr ())

h5t_OPAQUE_TAG_MAX :: Num a => a

Maximum length of an opaque tag.

type H5T_conv_t a b conversionData = FunPtr (HId_t -> HId_t -> Ptr (H5T_cdata_t conversionData) -> CSize -> CSize -> CSize -> InOutArray a -> InArray b -> HId_t -> IO HErr_t)

type H5T_conv_except_func_t a userData = FunPtr (H5T_conv_except_t -> HId_t -> HId_t -> In a -> In a -> InOut userData -> IO H5T_conv_ret_t)

Exception handler. If an exception like overflow happens during conversion, this function is called if it's registered through h5p_set_type_conv_cb.

Constants identifying data types

The IEEE floating point types in various byte orders.

h5t_IEEE_F32BE :: HId_t

h5t_IEEE_F32LE :: HId_t

h5t_IEEE_F64BE :: HId_t

h5t_IEEE_F64LE :: HId_t

"Standard" Types

h5t_STD_I8BE :: HId_t

h5t_STD_I8LE :: HId_t

h5t_STD_I16BE :: HId_t

h5t_STD_I16LE :: HId_t

h5t_STD_I32BE :: HId_t

h5t_STD_I32LE :: HId_t

h5t_STD_I64BE :: HId_t

h5t_STD_I64LE :: HId_t

h5t_STD_U8BE :: HId_t

h5t_STD_U8LE :: HId_t

h5t_STD_U16BE :: HId_t

h5t_STD_U16LE :: HId_t

h5t_STD_U32BE :: HId_t

h5t_STD_U32LE :: HId_t

h5t_STD_U64BE :: HId_t

h5t_STD_U64LE :: HId_t

h5t_STD_B8BE :: HId_t

h5t_STD_B8LE :: HId_t

h5t_STD_B16BE :: HId_t

h5t_STD_B16LE :: HId_t

h5t_STD_B32BE :: HId_t

h5t_STD_B32LE :: HId_t

h5t_STD_B64BE :: HId_t

h5t_STD_B64LE :: HId_t

h5t_STD_REF_OBJ :: HId_t

h5t_STD_REF_DSETREG :: HId_t

Types which are particular to Unix.

h5t_UNIX_D32BE :: HId_t

h5t_UNIX_D32LE :: HId_t

h5t_UNIX_D64BE :: HId_t

h5t_UNIX_D64LE :: HId_t

Types particular to the C language.

h5t_C_S1 :: HId_t

Types particular to Fortran.

h5t_FORTRAN_S1 :: HId_t

Types for Intel CPUs.

h5t_INTEL_I8 :: HId_t

h5t_INTEL_I16 :: HId_t

h5t_INTEL_I32 :: HId_t

h5t_INTEL_I64 :: HId_t

h5t_INTEL_U8 :: HId_t

h5t_INTEL_U16 :: HId_t

h5t_INTEL_U32 :: HId_t

h5t_INTEL_U64 :: HId_t

h5t_INTEL_B8 :: HId_t

h5t_INTEL_B16 :: HId_t

h5t_INTEL_B32 :: HId_t

h5t_INTEL_B64 :: HId_t

h5t_INTEL_F32 :: HId_t

h5t_INTEL_F64 :: HId_t

Types for Alpha CPUs.

h5t_ALPHA_I8 :: HId_t

h5t_ALPHA_I16 :: HId_t

h5t_ALPHA_I32 :: HId_t

h5t_ALPHA_I64 :: HId_t

h5t_ALPHA_U8 :: HId_t

h5t_ALPHA_U16 :: HId_t

h5t_ALPHA_U32 :: HId_t

h5t_ALPHA_U64 :: HId_t

h5t_ALPHA_B8 :: HId_t

h5t_ALPHA_B16 :: HId_t

h5t_ALPHA_B32 :: HId_t

h5t_ALPHA_B64 :: HId_t

h5t_ALPHA_F32 :: HId_t

h5t_ALPHA_F64 :: HId_t

Types for MIPS CPUs.

h5t_MIPS_I8 :: HId_t

h5t_MIPS_I16 :: HId_t

h5t_MIPS_I32 :: HId_t

h5t_MIPS_I64 :: HId_t

h5t_MIPS_U8 :: HId_t

h5t_MIPS_U16 :: HId_t

h5t_MIPS_U32 :: HId_t

h5t_MIPS_U64 :: HId_t

h5t_MIPS_B8 :: HId_t

h5t_MIPS_B16 :: HId_t

h5t_MIPS_B32 :: HId_t

h5t_MIPS_B64 :: HId_t

h5t_MIPS_F32 :: HId_t

h5t_MIPS_F64 :: HId_t

VAX floating point types (i.e. in VAX byte order)

h5t_VAX_F32 :: HId_t

h5t_VAX_F64 :: HId_t

Predefined native types.

h5t_NATIVE_CHAR :: HId_t

h5t_NATIVE_SCHAR :: HId_t

h5t_NATIVE_UCHAR :: HId_t

h5t_NATIVE_SHORT :: HId_t

h5t_NATIVE_USHORT :: HId_t

h5t_NATIVE_INT :: HId_t

h5t_NATIVE_UINT :: HId_t

h5t_NATIVE_LONG :: HId_t

h5t_NATIVE_ULONG :: HId_t

h5t_NATIVE_LLONG :: HId_t

h5t_NATIVE_ULLONG :: HId_t

h5t_NATIVE_FLOAT :: HId_t

h5t_NATIVE_DOUBLE :: HId_t

h5t_NATIVE_LDOUBLE :: HId_t

h5t_NATIVE_B8 :: HId_t

h5t_NATIVE_B16 :: HId_t

h5t_NATIVE_B32 :: HId_t

h5t_NATIVE_B64 :: HId_t

h5t_NATIVE_OPAQUE :: HId_t

h5t_NATIVE_HADDR :: HId_t

h5t_NATIVE_HSIZE :: HId_t

h5t_NATIVE_HSSIZE :: HId_t

h5t_NATIVE_HERR :: HId_t

h5t_NATIVE_HBOOL :: HId_t

C9x integer types

h5t_NATIVE_INT8 :: HId_t

h5t_NATIVE_UINT8 :: HId_t

h5t_NATIVE_INT_LEAST8 :: HId_t

h5t_NATIVE_UINT_LEAST8 :: HId_t

h5t_NATIVE_INT_FAST8 :: HId_t

h5t_NATIVE_UINT_FAST8 :: HId_t

h5t_NATIVE_INT16 :: HId_t

h5t_NATIVE_UINT16 :: HId_t

h5t_NATIVE_INT_LEAST16 :: HId_t

h5t_NATIVE_UINT_LEAST16 :: HId_t

h5t_NATIVE_INT_FAST16 :: HId_t

h5t_NATIVE_UINT_FAST16 :: HId_t

h5t_NATIVE_INT32 :: HId_t

h5t_NATIVE_UINT32 :: HId_t

h5t_NATIVE_INT_LEAST32 :: HId_t

h5t_NATIVE_UINT_LEAST32 :: HId_t

h5t_NATIVE_INT_FAST32 :: HId_t

h5t_NATIVE_UINT_FAST32 :: HId_t

h5t_NATIVE_INT64 :: HId_t

h5t_NATIVE_UINT64 :: HId_t

h5t_NATIVE_INT_LEAST64 :: HId_t

h5t_NATIVE_UINT_LEAST64 :: HId_t

h5t_NATIVE_INT_FAST64 :: HId_t

h5t_NATIVE_UINT_FAST64 :: HId_t

Operations defined on all datatypes

h5t_create :: H5T_class_t -> CSize -> IO HId_t

Create a new type and initialize it to reasonable values. The type is a member of type class 'type' and is size bytes.

On success, returns a new type identifier. On failure, returns a negative value.

hid_t H5Tcreate(H5T_class_t type, size_t size);

p_H5Tcreate :: FunPtr (H5T_class_t -> CSize -> IO HId_t)

h5t_copy :: HId_t -> IO HId_t

Copies a datatype. The resulting datatype is not locked. The datatype should be closed when no longer needed by calling h5t_close.

Returns the ID of a new datatype on success, negative on failure.

hid_t H5Tcopy(hid_t type_id);

p_H5Tcopy :: FunPtr (HId_t -> IO HId_t)

h5t_close :: HId_t -> IO HErr_t

Frees a datatype and all associated memory.

Returns non-negative on success, negative on failure.

herr_t H5Tclose(hid_t type_id);

p_H5Tclose :: FunPtr (HId_t -> IO HErr_t)

h5t_equal :: HId_t -> HId_t -> IO HTri_t

Determines if two datatypes are equal.

htri_t H5Tequal(hid_t type1_id, hid_t type2_id);

p_H5Tequal :: FunPtr (HId_t -> HId_t -> IO HTri_t)

h5t_lock :: HId_t -> IO HErr_t

Locks a type, making it read only and non-destructable. This is normally done by the library for predefined datatypes so the application doesn't inadvertently change or delete a predefined type.

Once a datatype is locked it can never be unlocked unless the entire library is closed.

It is illegal to lock a named datatype since we must allow named types to be closed (to release file resources) but locking a type prevents that.

Returns non-negative on success, negative on failure.

herr_t H5Tlock(hid_t type_id);

p_H5Tlock :: FunPtr (HId_t -> IO HErr_t)

h5t_commit2 :: HId_t -> CString -> HId_t -> HId_t -> HId_t -> HId_t -> IO HErr_t

Save a transient datatype to a file and turn the type handle into a "named", immutable type.

Returns non-negative on success, negative on failure.

herr_t H5Tcommit2(hid_t loc_id, const char *name, hid_t type_id,
    hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id);

p_H5Tcommit2 :: FunPtr (HId_t -> CString -> HId_t -> HId_t -> HId_t -> HId_t -> IO HErr_t)

h5t_open2 :: HId_t -> CString -> HId_t -> IO HId_t

Opens a named datatype using a Datatype Access Property List.

Returns the object ID of the named datatype on success, negative on failure.

hid_t H5Topen2(hid_t loc_id, const char *name, hid_t tapl_id);

p_H5Topen2 :: FunPtr (HId_t -> CString -> HId_t -> IO HId_t)

h5t_commit_anon :: HId_t -> HId_t -> HId_t -> HId_t -> IO HErr_t

Save a transient datatype to a file and turn the type handle into a "named", immutable type.

The resulting ID should be linked into the file with h5o_link or it will be deleted when closed.

Note: Datatype access property list is unused currently, but is checked for sanity anyway.

Returns non-negative on success, negative on failure.

herr_t H5Tcommit_anon(hid_t loc_id, hid_t type_id, hid_t tcpl_id, hid_t tapl_id);

p_H5Tcommit_anon :: FunPtr (HId_t -> HId_t -> HId_t -> HId_t -> IO HErr_t)

h5t_get_create_plist :: HId_t -> IO HId_t

Returns a copy of the datatype creation property list, or negative on failure. The property list ID should be released by calling h5p_close.

hid_t H5Tget_create_plist(hid_t type_id);

p_H5Tget_create_plist :: FunPtr (HId_t -> IO HId_t)

h5t_committed :: HId_t -> IO HTri_t

Determines if a datatype is committed or not.

htri_t H5Tcommitted(hid_t type_id);

p_H5Tcommitted :: FunPtr (HId_t -> IO HTri_t)

h5t_encode :: HId_t -> OutArray a -> InOut CSize -> IO HErr_t

Given a datatype ID, converts the object description into binary in a buffer.

Returns non-negative on success, negative on failure.

herr_t H5Tencode(hid_t obj_id, void *buf, size_t *nalloc);

p_H5Tencode :: FunPtr (HId_t -> OutArray a -> InOut CSize -> IO HErr_t)

h5t_decode :: InArray a -> IO HId_t

Decode a binary object description and return a new object handle, or negative on failure.

hid_t H5Tdecode(const void *buf);

p_H5Tdecode :: FunPtr (InArray a -> IO HId_t)

h5t_flush :: HId_t -> IO HErr_t

p_H5Tflush :: FunPtr (HId_t -> IO HErr_t)

h5t_refresh :: HId_t -> IO HErr_t

Operations defined on compound datatypes

p_H5Trefresh :: FunPtr (HId_t -> IO HErr_t)

h5t_insert :: HId_t -> CString -> CSize -> HId_t -> IO HErr_t

Adds another member to the compound datatype parent_id. The new member has a name which must be unique within the compound datatype. The offset argument defines the start of the member in an instance of the compound datatype, and member_id is the type of the new member.

Returns non-negative on success, negative on failure.

herr_t H5Tinsert(hid_t parent_id, const char *name, size_t offset,
       hid_t member_id);

p_H5Tinsert :: FunPtr (HId_t -> CString -> CSize -> HId_t -> IO HErr_t)

h5t_pack :: HId_t -> IO HErr_t

Recursively removes padding from within a compound datatype to make it more efficient (space-wise) to store that data.

Returns non-negative on success, negative on failure.

herr_t H5Tpack(hid_t type_id);

Operations defined on enumeration datatypes

p_H5Tpack :: FunPtr (HId_t -> IO HErr_t)

h5t_enum_create :: HId_t -> IO HId_t

Create a new enumeration data type based on the specified 'type', which must be an integer type.

Returns the ID of a new enumeration data type on success, negative on failure.

hid_t H5Tenum_create(hid_t base_id);

p_H5Tenum_create :: FunPtr (HId_t -> IO HId_t)

h5t_enum_insert :: HId_t -> CString -> In a -> IO HErr_t

Insert a new enumeration data type member into an enumeration type. 'type' is the enumeration type, name is the name of the new member, and value points to the value of the new member. The name and value must both be unique within the 'type'. value points to data which is of the data type defined when the enumeration type was created.

Returns non-negative on success, negative on failure.

herr_t H5Tenum_insert(hid_t type, const char *name, const void *value);

p_H5Tenum_insert :: FunPtr (HId_t -> CString -> In a -> IO HErr_t)

h5t_enum_nameof :: HId_t -> In a -> OutArray CChar -> CSize -> IO HErr_t

Finds the symbol name that corresponds to the specified value of an enumeration data type 'type'. At most size characters of the symbol name are copied into the name buffer. If the entire symbol anem and null terminator do not fit in the name buffer then as many characters as possible are copied (not null terminated) and the function fails.

Returns non-negative on success, negative on failure. On failure, the first character of name is set to null if size allows it.

WARNING: the above 2 paragraphs contradict each other about what happens on failure. This is because the documentation in the source does. If I read the source correctly, this is because there are some failures which have one behavior and some which have the other. Therefore, I would probably not rely on either behavior.

herr_t H5Tenum_nameof(hid_t type, const void *value, char *name/*out*/,
       size_t size);

p_H5Tenum_nameof :: FunPtr (HId_t -> In a -> OutArray CChar -> CSize -> IO HErr_t)

h5t_enum_valueof :: HId_t -> CString -> Out a -> IO HErr_t

Finds the value that corresponds to the specified name of an enumeration 'type'. The value argument should be at least as large as the value of h5t_get_size type in order to hold the result.

Returns non-negative on success, negative on failure.

herr_t H5Tenum_valueof(hid_t type, const char *name,
       void *value/*out*/);

Operations defined on variable-length datatypes

p_H5Tenum_valueof :: FunPtr (HId_t -> CString -> Out a -> IO HErr_t)

h5t_vlen_create :: HId_t -> IO HId_t

Create a new variable-length datatype based on the specified base_type.

Returns the ID of a new VL datatype on success, negative on failure.

hid_t H5Tvlen_create(hid_t base_id);

Operations defined on array datatypes

p_H5Tvlen_create :: FunPtr (HId_t -> IO HId_t)

h5t_array_create2 :: HId_t -> CUInt -> InArray HSize_t -> IO HId_t

Create a new array datatype based on the specified base_type. The type is an array with ndims dimensionality and the size of the array is dims. The total member size should be relatively small. Array datatypes are currently limited to h5s_max_rank number of dimensions and must have the number of dimensions set greater than 0. (i.e. 0 > ndims <= h5s_MAX_RANK) All dimensions sizes must be greater than 0 also.

Returns the ID of a new array datatype on success, negative on failure.

hid_t H5Tarray_create2(hid_t base_id, unsigned ndims,
       const hsize_t dim[/* ndims */]);

p_H5Tarray_create2 :: FunPtr (HId_t -> CUInt -> InArray HSize_t -> IO HId_t)

h5t_get_array_ndims :: HId_t -> IO CInt

Returns the number of dimensions of an array datatype, or negative on failure.

int H5Tget_array_ndims(hid_t type_id);

p_H5Tget_array_ndims :: FunPtr (HId_t -> IO CInt)

h5t_get_array_dims2 :: HId_t -> OutArray HSize_t -> IO CInt

Query the sizes of dimensions for an array datatype.

Returns the number of dimensions of the array type on success or negative on failure.

int H5Tget_array_dims2(hid_t type_id, hsize_t dims[]);

Operations defined on opaque datatypes

p_H5Tget_array_dims2 :: FunPtr (HId_t -> OutArray HSize_t -> IO CInt)

h5t_set_tag :: HId_t -> CString -> IO HErr_t

Tag an opaque datatype with a unique ASCII identifier.

Returns non-negative on success, negative on failure.

herr_t H5Tset_tag(hid_t type, const char *tag);

p_H5Tset_tag :: FunPtr (HId_t -> CString -> IO HErr_t)

h5t_get_tag :: HId_t -> IO CString

Get the tag associated with an opaque datatype.

Returns a pointer to a malloced string. The caller should free the string.

char *H5Tget_tag(hid_t type);

Querying property values

p_H5Tget_tag :: FunPtr (HId_t -> IO CString)

h5t_get_super :: HId_t -> IO HId_t

Returns the type from which 'type' is derived. In the case of an enumeration type the return value is an integer type.

Returns the type ID for the base datatype on success, or negative on failure.

hid_t H5Tget_super(hid_t type);

p_H5Tget_super :: FunPtr (HId_t -> IO HId_t)

h5t_get_class :: HId_t -> IO H5T_class_t

Returns the datatype class identifier for datatype type_id.

Returns one of the non-negative datatype class constants on success or h5t_NO_CLASS (which is negative) on failure.

H5T_class_t H5Tget_class(hid_t type_id);

p_H5Tget_class :: FunPtr (HId_t -> IO H5T_class_t)

h5t_detect_class :: HId_t -> H5T_class_t -> IO HTri_t

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

htri_t H5Tdetect_class(hid_t type_id, H5T_class_t cls);

p_H5Tdetect_class :: FunPtr (HId_t -> H5T_class_t -> IO HTri_t)

h5t_get_size :: HId_t -> IO CSize

Determines the total size of a datatype in bytes.

Returns the size of an instance of the datatype (in bytes) on success or 0 on failure (valid datatypes are never zero size).

size_t H5Tget_size(hid_t type_id);

p_H5Tget_size :: FunPtr (HId_t -> IO CSize)

h5t_get_order :: HId_t -> IO H5T_order_t

Returns the byte order of a datatype on success, or h5t_ORDER_ERROR (which is negative) on failure.

If the type is compound and its members have mixed orders, this function returns h5t_ORDER_MIXED.

H5T_order_t H5Tget_order(hid_t type_id);

p_H5Tget_order :: FunPtr (HId_t -> IO H5T_order_t)

h5t_get_precision :: HId_t -> IO CSize

Gets the precision of a datatype. The precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by h5t_get_size.

Returns 0 on failure (all atomic types have at least one significant bit)

size_t H5Tget_precision(hid_t type_id);

p_H5Tget_precision :: FunPtr (HId_t -> IO CSize)

h5t_get_offset :: HId_t -> IO CInt

Retrieves the bit offset of the first significant bit. The signficant bits of an atomic datum can be offset from the beginning of the memory for that datum by an amount of padding. The offset property specifies the number of bits of padding that appear to the "right of" the value. That is, if we have a 32-bit datum with 16-bits of precision having the value 0x1122 then it will be layed out in memory as (from small byte address toward larger byte addresses):

    Big      Big       Little   Little
    Endian   Endian    Endian   Endian
    offset=0 offset=16 offset=0 offset=16

0:  [ pad]   [0x11]    [0x22]   [ pad]
1:  [ pad]   [0x22]    [0x11]   [ pad]
2:  [0x11]   [ pad]    [ pad]   [0x22]
3:  [0x22]   [ pad]    [ pad]   [0x11]

Returns the offset on success or negative on failure.

int H5Tget_offset(hid_t type_id);

p_H5Tget_offset :: FunPtr (HId_t -> IO CInt)

h5t_get_pad :: HId_t -> Out H5T_pad_t -> Out H5T_pad_t -> IO HErr_t

Gets the least significant pad type and the most significant pad type and returns their values through the LSB and MSB arguments, either of which may be the null pointer.

Returns non-negative on success or negative on failure.

herr_t H5Tget_pad(hid_t type_id, H5T_pad_t *lsb/*out*/,
       H5T_pad_t *msb/*out*/);

p_H5Tget_pad :: FunPtr (HId_t -> Out H5T_pad_t -> Out H5T_pad_t -> IO HErr_t)

h5t_get_sign :: HId_t -> IO H5T_sign_t

Returns the sign type for an integer type or h5t_SGN_ERROR (a negative value) on failure.

H5T_sign_t H5Tget_sign(hid_t type_id);

p_H5Tget_sign :: FunPtr (HId_t -> IO H5T_sign_t)

h5t_get_fields :: HId_t -> Out CSize -> Out CSize -> Out CSize -> Out CSize -> Out CSize -> IO HErr_t

Returns information about the locations of the various bit fields of a floating point datatype. The field positions are bit positions in the significant region of the datatype. Bits are numbered with the least significant bit number zero.

Any (or even all) of the arguments can be null pointers.

Returns non-negative on success, negative on failure.

herr_t H5Tget_fields(hid_t type_id, size_t *spos/*out*/,
       size_t *epos/*out*/, size_t *esize/*out*/,
       size_t *mpos/*out*/, size_t *msize/*out*/);

p_H5Tget_fields :: FunPtr (HId_t -> Out CSize -> Out CSize -> Out CSize -> Out CSize -> Out CSize -> IO HErr_t)

h5t_get_ebias :: HId_t -> IO CSize

Returns the exponent bias of a floating-point type, or 0 on failure.

size_t H5Tget_ebias(hid_t type_id);

p_H5Tget_ebias :: FunPtr (HId_t -> IO CSize)

h5t_get_norm :: HId_t -> IO H5T_norm_t

Returns the mantisssa normalization of a floating-point data type, or h5t_NORM_ERROR (a negative value) on failure.

H5T_norm_t H5Tget_norm(hid_t type_id);

p_H5Tget_norm :: FunPtr (HId_t -> IO H5T_norm_t)

h5t_get_inpad :: HId_t -> IO H5T_pad_t

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 value of this property.

H5T_pad_t H5Tget_inpad(hid_t type_id);

p_H5Tget_inpad :: FunPtr (HId_t -> IO H5T_pad_t)

h5t_get_strpad :: HId_t -> IO H5T_str_t

The method used to store character strings differs with the programming language: C usually null terminates strings while Fortran left-justifies and space-pads strings. This property defines the storage mechanism for the string.

Returns the character set of a string type on success, or h5t_STR_ERROR (a negative value) on failure.

H5T_str_t H5Tget_strpad(hid_t type_id);

p_H5Tget_strpad :: FunPtr (HId_t -> IO H5T_str_t)

h5t_get_nmembers :: HId_t -> IO CInt

Determines how many members type_id has. The type must be either a compound datatype or an enumeration datatype.

Returns the number of members defined in the datatype on success, or negative on failure.

int H5Tget_nmembers(hid_t type_id);

p_H5Tget_nmembers :: FunPtr (HId_t -> IO CInt)

h5t_get_member_name :: HId_t -> CUInt -> IO CString

Returns the name of a member of a compound or enumeration datatype. Members are stored in no particular order with numbers 0 through N-1 where N is the value returned by h5t_get_nmembers.

Returns a pointer to a string allocated with malloc, or NULL on failure. The caller is responsible for freeing the string.

char *H5Tget_member_name(hid_t type_id, unsigned membno);

p_H5Tget_member_name :: FunPtr (HId_t -> CUInt -> IO CString)

h5t_get_member_index :: HId_t -> CString -> IO CInt

Returns the index of a member in a compound or enumeration datatype by given name. Members are stored in no particular order with numbers 0 through N-1 where N is the value returned by h5t_get_nmembers.

Returns the index of the member on success, or negative on failure.

int H5Tget_member_index(hid_t type_id, const char *name);

p_H5Tget_member_index :: FunPtr (HId_t -> CString -> IO CInt)

h5t_get_member_offset :: HId_t -> CUInt -> IO CSize

Returns the byte offset of the beginning of a member with respect to the beginning of the compound datatype datum.

Returns the byte offset on success, or zero on failure. Zero is a valid offset, but this function will fail only if a call to h5t_get_member_dims fails with the same arguments.

size_t H5Tget_member_offset(hid_t type_id, unsigned membno);

p_H5Tget_member_offset :: FunPtr (HId_t -> CUInt -> IO CSize)

h5t_get_member_class :: HId_t -> CUInt -> IO H5T_class_t

Returns the datatype class of a member of a compound datatype.

Returns non-negative on success, negative on failure.

H5T_class_t H5Tget_member_class(hid_t type_id, unsigned membno);

p_H5Tget_member_class :: FunPtr (HId_t -> CUInt -> IO H5T_class_t)

h5t_get_member_type :: HId_t -> CUInt -> IO HId_t

Returns a copy of the datatype of the specified member, or negative on failure. The caller should invoke h5t_close to release resources associated with the type.

hid_t H5Tget_member_type(hid_t type_id, unsigned membno);

p_H5Tget_member_type :: FunPtr (HId_t -> CUInt -> IO HId_t)

h5t_get_member_value :: HId_t -> CUInt -> Out a -> IO HErr_t

Return the value for an enumeration data type member.

Returns non-negative on success, negative on failure.

herr_t H5Tget_member_value(hid_t type_id, unsigned membno, void *value/*out*/);

p_H5Tget_member_value :: FunPtr (HId_t -> CUInt -> Out a -> IO HErr_t)

h5t_get_cset :: HId_t -> IO H5T_cset_t

HDF5 is able to distinguish between character sets of different nationalities and to convert between them to the extent possible.

Returns the character set of a string type on success, or h5t_CSET_ERROR (a negative value) on failure.

H5T_cset_t H5Tget_cset(hid_t type_id);

p_H5Tget_cset :: FunPtr (HId_t -> IO H5T_cset_t)

h5t_is_variable_str :: HId_t -> IO HTri_t

Check whether a datatype is a variable-length string

htri_t H5Tis_variable_str(hid_t type_id);

p_H5Tis_variable_str :: FunPtr (HId_t -> IO HTri_t)

h5t_get_native_type :: HId_t -> H5T_direction_t -> IO HId_t

High-level API to return the native type of a datatype. The native type is chosen by matching the size and class of querried datatype from the following native premitive datatypes:

h5t_NATIVE_CHAR h5t_NATIVE_UCHAR h5t_NATIVE_SHORT h5t_NATIVE_USHORT h5t_NATIVE_INT h5t_NATIVE_UINT h5t_NATIVE_LONG h5t_NATIVE_ULONG h5t_NATIVE_LLONG h5t_NATIVE_ULLONG

H5T_NATIVE_FLOAT H5T_NATIVE_DOUBLE H5T_NATIVE_LDOUBLE

Compound, array, enum, and VL types all choose among these types for theire members. Time, Bifield, Opaque, Reference types are only copy out.

Returns the native data type if successful, negative otherwise.

hid_t H5Tget_native_type(hid_t type_id, H5T_direction_t direction);

Setting property values

p_H5Tget_native_type :: FunPtr (HId_t -> H5T_direction_t -> IO HId_t)

h5t_set_size :: HId_t -> CSize -> IO HErr_t

Sets the total size in bytes for a datatype (this operation is not permitted on reference datatypes). If the size is decreased so that the significant bits of the datatype extend beyond the edge of the new size, then the offset property is decreased toward zero. If the offset becomes zero and the significant bits of the datatype still hang over the edge of the new size, then the number of significant bits is decreased.

Adjusting the size of an h5t_STRING automatically sets the precision to 8*size.

All datatypes have a positive size.

Returns non-negative on success, negative on failure.

herr_t H5Tset_size(hid_t type_id, size_t size);

p_H5Tset_size :: FunPtr (HId_t -> CSize -> IO HErr_t)

h5t_set_order :: HId_t -> H5T_order_t -> IO HErr_t

Sets the byte order for a datatype.

Notes: There are some restrictions on this operation:

1. For enum type, members shouldn't be defined yet.
2. h5t_ORDER_NONE only works for reference and fixed-length string.
3. For opaque type, the order will be ignored.
4. For compound type, all restrictions above apply to the members.

Returns non-negative on success, negative on failure.

herr_t H5Tset_order(hid_t type_id, H5T_order_t order);

p_H5Tset_order :: FunPtr (HId_t -> H5T_order_t -> IO HErr_t)

h5t_set_precision :: HId_t -> CSize -> IO HErr_t

Sets the precision of a datatype. The precision is the number of significant bits which, unless padding is present, is 8 times larger than the value returned by h5t_get_size.

If the precision is increased then the offset is decreased and then the size is increased to insure that significant bits do not "hang over" the edge of the datatype.

The precision property of strings is read-only.

When decreasing the precision of a floating point type, set the locations and sizes of the sign, mantissa, and exponent fields first.

Returns non-negative on success, negative on failure.

herr_t H5Tset_precision(hid_t type_id, size_t prec);

p_H5Tset_precision :: FunPtr (HId_t -> CSize -> IO HErr_t)

h5t_set_offset :: HId_t -> CSize -> IO HErr_t

Sets the bit offset of the first significant bit. The signficant bits of an atomic datum can be offset from the beginning of the memory for that datum by an amount of padding. The offset property specifies the number of bits of padding that appear to the "right of" the value. That is, if we have a 32-bit datum with 16-bits of precision having the value 0x1122 then it will be layed out in memory as (from small byte address toward larger byte addresses):

    Big      Big       Little   Little
    Endian   Endian    Endian   Endian
    offset=0 offset=16 offset=0 offset=16

0:  [ pad]   [0x11]    [0x22]   [ pad]
1:  [ pad]   [0x22]    [0x11]   [ pad]
2:  [0x11]   [ pad]    [ pad]   [0x22]
3:  [0x22]   [ pad]    [ pad]   [0x11]

If the offset is incremented then the total size is incremented also if necessary to prevent significant bits of the value from hanging over the edge of the data type.

The offset of an h5t_STRING cannot be set to anything but zero.

Returns non-negative on success, negative on failure.

herr_t H5Tset_offset(hid_t type_id, size_t offset);

p_H5Tset_offset :: FunPtr (HId_t -> CSize -> IO HErr_t)

h5t_set_pad :: HId_t -> H5T_pad_t -> H5T_pad_t -> IO HErr_t

Sets the LSB and MSB pad types.

Returns non-negative on success, negative on failure.

herr_t H5Tset_pad(hid_t type_id, H5T_pad_t lsb, H5T_pad_t msb);

p_H5Tset_pad :: FunPtr (HId_t -> H5T_pad_t -> H5T_pad_t -> IO HErr_t)

h5t_set_sign :: HId_t -> H5T_sign_t -> IO HErr_t

Sets the sign property for an integer.

Returns non-negative on success, negative on failure.

herr_t H5Tset_sign(hid_t type_id, H5T_sign_t sign);

p_H5Tset_sign :: FunPtr (HId_t -> H5T_sign_t -> IO HErr_t)

h5t_set_fields :: HId_t -> CSize -> CSize -> CSize -> CSize -> CSize -> IO HErr_t

Sets the locations and sizes of the various floating point bit fields. The field positions are bit positions in the significant region of the datatype. Bits are numbered with the least significant bit number zero.

Fields are not allowed to extend beyond the number of bits of precision, nor are they allowed to overlap with one another.

Returns non-negative on success, negative on failure.

herr_t H5Tset_fields(hid_t type_id, size_t spos, size_t epos,
       size_t esize, size_t mpos, size_t msize);

p_H5Tset_fields :: FunPtr (HId_t -> CSize -> CSize -> CSize -> CSize -> CSize -> IO HErr_t)

h5t_set_ebias :: HId_t -> CSize -> IO HErr_t

Sets the exponent bias of a floating-point type.

Returns non-negative on success, negative on failure.

herr_t H5Tset_ebias(hid_t type_id, size_t ebias);

p_H5Tset_ebias :: FunPtr (HId_t -> CSize -> IO HErr_t)

h5t_set_norm :: HId_t -> H5T_norm_t -> IO HErr_t

Sets the mantissa normalization method for a floating point datatype.

Returns non-negative on success, negative on failure.

herr_t H5Tset_norm(hid_t type_id, H5T_norm_t norm);

p_H5Tset_norm :: FunPtr (HId_t -> H5T_norm_t -> IO HErr_t)

h5t_set_inpad :: HId_t -> H5T_pad_t -> IO HErr_t

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 value of this property.

Returns non-negative on success, negative on failure.

herr_t H5Tset_inpad(hid_t type_id, H5T_pad_t pad);

p_H5Tset_inpad :: FunPtr (HId_t -> H5T_pad_t -> IO HErr_t)

h5t_set_cset :: HId_t -> H5T_cset_t -> IO HErr_t

HDF5 is able to distinguish between character sets of different nationalities and to convert between them to the extent possible.

Returns non-negative on success, negative on failure.

herr_t H5Tset_cset(hid_t type_id, H5T_cset_t cset);

p_H5Tset_cset :: FunPtr (HId_t -> H5T_cset_t -> IO HErr_t)

h5t_set_strpad :: HId_t -> H5T_str_t -> IO HErr_t

The method used to store character strings differs with the programming language: C usually null terminates strings while Fortran left-justifies and space-pads strings. This property defines the storage mechanism for the string.

When converting from a long string to a short string if the short string is h5t_STR_NULLPAD or h5t_STR_SPACEPAD then the string is simply truncated; otherwise if the short string is h5t_STR_NULLTERM it will be truncated and a null terminator is appended.

When converting from a short string to a long string, the long string is padded on the end by appending nulls or spaces.

Returns non-negative on success, negative on failure.

herr_t H5Tset_strpad(hid_t type_id, H5T_str_t strpad);

Type conversion database

p_H5Tset_strpad :: FunPtr (HId_t -> H5T_str_t -> IO HErr_t)

h5t_register :: H5T_pers_t -> CString -> HId_t -> HId_t -> H5T_conv_t a b c -> IO HErr_t

Register a hard or soft conversion function for a data type conversion path. The path is specified by the source and destination data types src_id and dst_id (for soft functions only the class of these types is important). If func is a hard function then it replaces any previous path; if it's a soft function then it replaces all existing paths to which it applies and is used for any new path to which it applies as long as that path doesn't have a hard function.

Returns non-negative on success, negative on failure.

herr_t H5Tregister(H5T_pers_t pers, const char *name, hid_t src_id,
       hid_t dst_id, H5T_conv_t func);

p_H5Tregister :: FunPtr (H5T_pers_t -> CString -> HId_t -> HId_t -> H5T_conv_t a b c -> IO HErr_t)

h5t_unregister :: H5T_pers_t -> CString -> HId_t -> HId_t -> H5T_conv_t a b c -> IO HErr_t

Removes conversion paths that match the specified criteria. All arguments are optional. Missing arguments are wild cards. The special no-op path cannot be removed.

Returns non-negative on success, negative on failure.

herr_t H5Tunregister(H5T_pers_t pers, const char *name, hid_t src_id,
       hid_t dst_id, H5T_conv_t func);

p_H5Tunregister :: FunPtr (H5T_pers_t -> CString -> HId_t -> HId_t -> H5T_conv_t a b c -> IO HErr_t)

h5t_find :: HId_t -> HId_t -> Out (Ptr (H5T_cdata_t c)) -> IO (H5T_conv_t a b c)

Finds a conversion function that can handle a conversion from type src_id to type dst_id. The pcdata argument is a pointer to a pointer to type conversion data which was created and initialized by the type conversion function of this path when the conversion function was installed on the path.

H5T_convT H5Tfind(hid_t src_id, hid_t dst_id, H5T_cdata_t **pcdata);

p_H5Tfind :: FunPtr (HId_t -> HId_t -> Out (Ptr (H5T_cdata_t c)) -> IO (H5T_conv_t a b c))

h5t_compiler_conv :: HId_t -> HId_t -> IO HTri_t

Finds out whether the library's conversion function from type src_id to type dst_id is a compiler (hard) conversion. A hard conversion uses compiler's casting; a soft conversion uses the library's own conversion function.

htri_t H5Tcompiler_conv(hid_t src_id, hid_t dst_id);

p_H5Tcompiler_conv :: FunPtr (HId_t -> HId_t -> IO HTri_t)

h5t_convert :: HId_t -> HId_t -> CSize -> InOutArray a -> InArray b -> HId_t -> IO HErr_t

Convert nelmts elements from type src_id to type dst_id. The source elements are packed in buf and on return the destination will be packed in buf. That is, the conversion is performed in place. The optional background buffer is an array of nelmts values of destination type which are merged with the converted values to fill in cracks (for instance, background might be an array of structs with the a and b fields already initialized and the conversion of BUF supplies the c and d field values). The plist_id a dataset transfer property list which is passed to the conversion functions. (It's currently only used to pass along the VL datatype custom allocation information -QAK 7199)

herr_t H5Tconvert(hid_t src_id, hid_t dst_id, size_t nelmts,
       void *buf, void *background, hid_t plist_id);

p_H5Tconvert :: FunPtr (HId_t -> HId_t -> CSize -> InOutArray a -> InArray b -> HId_t -> IO HErr_t)

Symbols defined for compatibility with previous versions of the HDF5 API.

h5t_commit1 :: HId_t -> CString -> HId_t -> IO HErr_t

Save a transient datatype to a file and turn the type handle into a named, immutable type.

Note: Deprecated in favor of h5t_commit2

herr_t H5Tcommit1(hid_t loc_id, const char *name, hid_t type_id);

p_H5Tcommit1 :: FunPtr (HId_t -> CString -> HId_t -> IO HErr_t)

h5t_open1 :: HId_t -> CString -> IO HId_t

Opens a named datatype.

Deprecated in favor of h5t_open2.

hid_t H5Topen1(hid_t loc_id, const char *name);

p_H5Topen1 :: FunPtr (HId_t -> CString -> IO HId_t)

h5t_array_create1 :: HId_t -> CInt -> InArray HSize_t -> InArray CInt -> IO HId_t

Create a new array datatype based on the specified base_type. The type is an array with ndims dimensionality and the size of the array is dims. The total member size should be relatively small. Array datatypes are currently limited to h5s_MAX_RANK number of dimensions and must have the number of dimensions set greater than 0. (i.e. 0 > ndims <= h5s_MAX_RANK) All dimensions sizes must be greater than 0 also.

Returns the ID of a new array datatype on success, negative on failure.

hid_t H5Tarray_create1(hid_t base_id, int ndims,
       const hsize_t dim[/* ndims */],
       const int perm[/* ndims */]);

p_H5Tarray_create1 :: FunPtr (HId_t -> CInt -> InArray HSize_t -> InArray CInt -> IO HId_t)

h5t_get_array_dims1 :: HId_t -> OutArray HSize_t -> OutArray CInt -> IO CInt

Query the sizes of dimensions for an array datatype.

Returns the number of dimensions of the array type on success, negative on failure.

int H5Tget_array_dims1(hid_t type_id, hsize_t dims[], int perm[]);

p_H5Tget_array_dims1 :: FunPtr (HId_t -> OutArray HSize_t -> OutArray CInt -> IO CInt)