H5::CommonFG Class Reference

CommonFG will be deprecated in future releases. In 1.10.1, most member functions are moved to H5Location.

#include <H5CommonFG.h>

Inheritance diagram for H5::CommonFG:

Public Member Functions
DataType	openDataType (const char *name) const
	Opens the named generic datatype at this location. More...
DataType	openDataType (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...
ArrayType	openArrayType (const char *name) const
	Opens the named array datatype at this location. More...
ArrayType	openArrayType (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...
CompType	openCompType (const char *name) const
	Opens the named compound datatype at this location. More...
CompType	openCompType (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...
EnumType	openEnumType (const char *name) const
	Opens the named enumeration datatype at this location. More...
EnumType	openEnumType (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...
IntType	openIntType (const char *name) const
	Opens the named integer datatype at this location. More...
IntType	openIntType (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...
FloatType	openFloatType (const char *name) const
	Opens the named floating-point datatype at this location. More...
FloatType	openFloatType (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...
StrType	openStrType (const char *name) const
	Opens the named string datatype at this location. More...
StrType	openStrType (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...
VarLenType	openVarLenType (const char *name) const
	Opens the named variable length datatype at this location. More...
VarLenType	openVarLenType (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...

Member Function Documentation

ArrayType H5::CommonFG::openArrayType

(

const char *

name

)

const

Parameters

name	- IN: Name of the array datatype to open

Returns

ArrayType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openArrayType().

ArrayType H5::CommonFG::openArrayType

(

const H5std_string &

name

)

const

References openArrayType().

CompType H5::CommonFG::openCompType

(

const char *

name

)

const

Parameters

name	- IN: Name of the compound datatype to open

Returns

CompType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openCompType().

CompType H5::CommonFG::openCompType

(

const H5std_string &

name

)

const

References openCompType().

DataType H5::CommonFG::openDataType

(

const char *

name

)

const

Parameters

name	- IN: Name of the datatype to open

Returns

DataType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openDataType().

DataType H5::CommonFG::openDataType

(

const H5std_string &

name

)

const

References openDataType().

EnumType H5::CommonFG::openEnumType

(

const char *

name

)

const

Parameters

name	- IN: Name of the enumeration datatype to open

Returns

EnumType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openEnumType().

EnumType H5::CommonFG::openEnumType

(

const H5std_string &

name

)

const

References openEnumType().

FloatType H5::CommonFG::openFloatType

(

const char *

name

)

const

Parameters

name	- IN: Name of the floating-point datatype to open

Returns

FloatType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openFloatType().

FloatType H5::CommonFG::openFloatType

(

const H5std_string &

name

)

const

References openFloatType().

IntType H5::CommonFG::openIntType

(

const char *

name

)

const

Parameters

name	- IN: Name of the integer datatype to open

Returns

IntType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openIntType().

IntType H5::CommonFG::openIntType

(

const H5std_string &

name

)

const

References openIntType().

StrType H5::CommonFG::openStrType

(

const char *

name

)

const

Parameters

name	- IN: Name of the string datatype to open

Returns

StrType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openStrType().

StrType H5::CommonFG::openStrType

(

const H5std_string &

name

)

const

References openStrType().

VarLenType H5::CommonFG::openVarLenType

(

const char *

name

)

const

Parameters

name	- IN: Name of the variable length datatype to open

Returns

VarLenType instance

Exceptions

H5::FileIException

or H5::GroupIException

Referenced by openVarLenType().

VarLenType H5::CommonFG::openVarLenType

(

const H5std_string &

name

)

const

References openVarLenType().

---

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

• H5CommonFG.h
• H5CommonFG.cpp