H5::PredType Class Reference

List of all members.

Public Member Functions

• virtual H5std_string fromClass () const

  Returns this class name.
  

• PredType & operator= (const PredType &rhs)

  Assignment operator.
  

• PredType (const PredType &original)

  Copy constructor: makes a copy of the original PredType object.
  

• virtual ~PredType ()

  Noop destructor.
  

• void commit (H5File &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.
  

• void commit (H5File &loc, const char *name)

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

• void commit (H5Object &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.
  

• void commit (H5Object &loc, const char *name)

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

• bool committed ()

Static Public Attributes

• static const PredType STD_I8BE
• static const PredType STD_I8LE
• static const PredType STD_I16BE
• static const PredType STD_I16LE
• static const PredType STD_I32BE
• static const PredType STD_I32LE
• static const PredType STD_I64BE
• static const PredType STD_I64LE
• static const PredType STD_U8BE
• static const PredType STD_U8LE
• static const PredType STD_U16BE
• static const PredType STD_U16LE
• static const PredType STD_U32BE
• static const PredType STD_U32LE
• static const PredType STD_U64BE
• static const PredType STD_U64LE
• static const PredType STD_B8BE
• static const PredType STD_B8LE
• static const PredType STD_B16BE
• static const PredType STD_B16LE
• static const PredType STD_B32BE
• static const PredType STD_B32LE
• static const PredType STD_B64BE
• static const PredType STD_B64LE
• static const PredType STD_REF_OBJ
• static const PredType STD_REF_DSETREG
• static const PredType C_S1
• static const PredType FORTRAN_S1
• static const PredType IEEE_F32BE
• static const PredType IEEE_F32LE
• static const PredType IEEE_F64BE
• static const PredType IEEE_F64LE
• static const PredType UNIX_D32BE
• static const PredType UNIX_D32LE
• static const PredType UNIX_D64BE
• static const PredType UNIX_D64LE
• static const PredType INTEL_I8
• static const PredType INTEL_I16
• static const PredType INTEL_I32
• static const PredType INTEL_I64
• static const PredType INTEL_U8
• static const PredType INTEL_U16
• static const PredType INTEL_U32
• static const PredType INTEL_U64
• static const PredType INTEL_B8
• static const PredType INTEL_B16
• static const PredType INTEL_B32
• static const PredType INTEL_B64
• static const PredType INTEL_F32
• static const PredType INTEL_F64
• static const PredType ALPHA_I8
• static const PredType ALPHA_I16
• static const PredType ALPHA_I32
• static const PredType ALPHA_I64
• static const PredType ALPHA_U8
• static const PredType ALPHA_U16
• static const PredType ALPHA_U32
• static const PredType ALPHA_U64
• static const PredType ALPHA_B8
• static const PredType ALPHA_B16
• static const PredType ALPHA_B32
• static const PredType ALPHA_B64
• static const PredType ALPHA_F32
• static const PredType ALPHA_F64
• static const PredType MIPS_I8
• static const PredType MIPS_I16
• static const PredType MIPS_I32
• static const PredType MIPS_I64
• static const PredType MIPS_U8
• static const PredType MIPS_U16
• static const PredType MIPS_U32
• static const PredType MIPS_U64
• static const PredType MIPS_B8
• static const PredType MIPS_B16
• static const PredType MIPS_B32
• static const PredType MIPS_B64
• static const PredType MIPS_F32
• static const PredType MIPS_F64
• static const PredType NATIVE_CHAR
• static const PredType NATIVE_SCHAR
• static const PredType NATIVE_UCHAR
• static const PredType NATIVE_SHORT
• static const PredType NATIVE_USHORT
• static const PredType NATIVE_INT
• static const PredType NATIVE_UINT
• static const PredType NATIVE_LONG
• static const PredType NATIVE_ULONG
• static const PredType NATIVE_LLONG
• static const PredType NATIVE_ULLONG
• static const PredType NATIVE_FLOAT
• static const PredType NATIVE_DOUBLE
• static const PredType NATIVE_LDOUBLE
• static const PredType NATIVE_B8
• static const PredType NATIVE_B16
• static const PredType NATIVE_B32
• static const PredType NATIVE_B64
• static const PredType NATIVE_OPAQUE
• static const PredType NATIVE_HSIZE
• static const PredType NATIVE_HSSIZE
• static const PredType NATIVE_HERR
• static const PredType NATIVE_HBOOL
• static const PredType NATIVE_INT8
• static const PredType NATIVE_UINT8
• static const PredType NATIVE_INT16
• static const PredType NATIVE_UINT16
• static const PredType NATIVE_INT32
• static const PredType NATIVE_UINT32
• static const PredType NATIVE_INT64
• static const PredType NATIVE_UINT64

Protected Member Functions

• PredType ()

  Default constructor: Creates a stub predefined datatype.
  

• PredType (const hid_t predtype_id)

  Creates a PredType object using the id of an existing predefined datatype.
  

---

Constructor & Destructor Documentation

H5::PredType::PredType

(

const PredType &

original

)

Copy constructor: makes a copy of the original PredType object.

Parameters:

original

- IN: PredType instance to copy

H5::PredType::PredType

(

const hid_t

predtype_id

)

[protected]

Creates a PredType object using the id of an existing predefined datatype.

Parameters:

predtype_id

- IN: Id of a predefined datatype

---

Member Function Documentation

void H5::PredType::commit	(	H5Object &	loc,
		const char *	name
	)

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

Parameters:

	loc	- IN: Either a group, dataset, named datatype, or attribute.
	name	- IN: Name of the datatype

Exceptions:

H5::DataTypeIException

Reimplemented from H5::DataType.

void H5::PredType::commit	(	H5File &	loc,
		const char *	name
	)

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

Parameters:

	loc	- IN: A file
	name	- IN: Name of the datatype

Exceptions:

H5::DataTypeIException

Reimplemented from H5::DataType.

PredType & H5::PredType::operator=

(

const PredType &

rhs

)

Assignment operator.

Parameters:

rhs

- IN: Reference to the predefined datatype

Returns:

Reference to PredType instance

Exceptions:

H5::DataTypeIException

References H5::DataType::copy().