mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-04-18 17:40:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Description:

Browse Source 
Fixed typos and missing items in function headers, that were revealed
    by Doxygen, and revised various comments.
Platforms tested:
    Linux/32 2.6 (jam)
    Linux/64 (platypus)
    Darwin (osx1010test)
This commit is contained in:
Binh-Minh Ribler 2017-03-20 21:56:50 -05:00
parent 17f14945b8
commit 7a799387e1
18 changed files with 117 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
c++/src/H5ArrayType.cpp
View File

@ -77,11 +77,12 @@ ArrayType::ArrayType(const DataType& base_type, int ndims, const hsize_t* dims)
// Function: ArrayType overloaded constructor
///\brief Creates an ArrayType instance by opening an HDF5 array datatype
/// given its name, provided as a C character string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Array type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openArrayType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -94,12 +95,13 @@ ArrayType::ArrayType(const H5Location& loc, const char *dtype_name) : DataType()
//--------------------------------------------------------------------------
// Function: ArrayType overloaded constructor
///\brief Creates an ArrayType instance by opening an HDF5 array datatype
/// given its name, provided as an \c H5std_string.
/// given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Array type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openArrayType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016

6
c++/src/H5CompType.cpp
View File

@ -91,11 +91,12 @@ CompType::CompType(const DataSet& dataset) : DataType()
// Function: CompType overloaded constructor
///\brief Creates an CompType instance by opening an HDF5 compound
/// given its name, provided as a C character string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Compound type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openCompType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -109,11 +110,12 @@ CompType::CompType(const H5Location& loc, const char *dtype_name) : DataType()
// Function: CompType overloaded constructor
///\brief Creates an CompType instance by opening an HDF5 compound
/// datatype given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Compound type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openCompType(const H5Location&)
// to improve usability.
// -BMR, Dec 2016

61
c++/src/H5DataType.cpp
View File

@ -109,13 +109,13 @@ DataType::DataType(const H5Location& loc, const void* ref, H5R_type_t ref_type,
//--------------------------------------------------------------------------
// Function: DataType overload constructor - dereference
///\brief Given a reference, ref, to an hdf5 group, creates a
/// DataType object
///\param attr - IN: Specifying location where the referenced object is in
///\param ref - IN: Reference pointer
///\param ref_type - IN: Reference type - default to H5R_OBJECT
///\param plist - IN: Property list - default to PropList::DEFAULT
///\exception H5::ReferenceException
// brief Given a reference, ref, to an hdf5 group, creates a
// DataType object
// param attr - IN: Specifying location where the referenced object is in
// param ref - IN: Reference pointer
// param ref_type - IN: Reference type - default to H5R_OBJECT
// param plist - IN: Property list - default to PropList::DEFAULT
// exception H5::ReferenceException
// Programmer Binh-Minh Ribler - Oct, 2006
// Modification
// Jul, 2008
@ -162,11 +162,12 @@ DataType::DataType(const PredType& pred_type) : H5Object()
// Function: DataType overloaded constructor
///\brief Creates a DataType instance by opening an HDF5 datatype given
/// its name as a char*.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Datatype name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openDataType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -180,11 +181,12 @@ DataType::DataType(const H5Location& loc, const char *dtype_name) : H5Object()
// Function: DataType overloaded constructor
///\brief Creates a DataType instance by opening an HDF5 datatype given
/// its name as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Datatype name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openDataType(const H5std_string&) to
// improve usability.
// -BMR, Dec 2016
@ -299,27 +301,6 @@ bool DataType::operator==(const DataType& compared_type) const
}
}
//--------------------------------------------------------------------------
// Function: DataType::p_opentype (private)
///\brief Opens an HDF5 datatype given its name
///\param dtype_name - IN: Datatype name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// This function was introduced in 1.10.1 to be used by the new
// XxxType constructors that were introduced to replace the
// existing functions CommonFG::openXxxType(), which is awkward
// to use. -BMR, Dec 2016
//--------------------------------------------------------------------------
hid_t DataType::p_opentype(const H5Location& loc, const char *dtype_name) const
{
// Call C function to open the named datatype at this location
hid_t ret_value = H5Topen2(loc.getId(), dtype_name, H5P_DEFAULT);
if (ret_value < 0)
throw DataTypeIException("DataType constructor", "H5Topen2 failed");
return(ret_value);
}
//--------------------------------------------------------------------------
// Function: DataType::p_commit (private)
//\brief Commits a transient datatype to a file, creating a new
@ -786,6 +767,26 @@ hid_t DataType::getId() const
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: DataType::p_opentype (private)
///\brief Opens an HDF5 datatype given its name
///\param loc - IN: Location of the type
///\param dtype_name - IN: Datatype name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// This function was introduced in 1.10.1 to be used by the new
// XxxType constructors that open a datatype. -BMR, Dec 2016
//--------------------------------------------------------------------------
hid_t DataType::p_opentype(const H5Location& loc, const char *dtype_name) const
{
// Call C function to open the named datatype at this location
hid_t ret_value = H5Topen2(loc.getId(), dtype_name, H5P_DEFAULT);
if (ret_value < 0)
throw DataTypeIException("DataType constructor", "H5Topen2 failed");
return(ret_value);
}
//--------------------------------------------------------------------------
// Function: DataType::p_setId
///\brief Sets the identifier of this object to a new value.

16
c++/src/H5DcreatProp.cpp
View File

@ -744,13 +744,13 @@ void DSetCreatPropList::getExternal(unsigned idx, size_t name_size, char* name,
// Function: DSetCreatPropList::setVirtual
///\brief Maps elements of a virtual dataset to elements of the source
/// dataset.
///\param vspace - IN: Dataspace the virtual dataset, possibly an
///\param vspace - IN: Dataspace the virtual dataset, possibly an
/// unlimited selection
///\param src_fname - IN: Name of the HDF5 file where the source dataset
///\param src_fname - IN: Name of the HDF5 file where the source dataset
/// is located (\a char*)
///\param src_fname - IN: Path to the dataset in the file specified by
///\param src_dsname - IN: Path to the dataset in the file specified by
/// \a src_file_name (\a char*)
///\param sspace - IN: Dataspace with a selection applied, possibly
///\param sspace - IN: Dataspace with a selection applied, possibly
/// an unlimited selection
///\exception H5::PropListIException
///\par Description
@ -771,13 +771,13 @@ void DSetCreatPropList::setVirtual(const DataSpace& vspace, const char *src_fnam
// Function: DSetCreatPropList::setVirtual
///\brief Maps elements of a virtual dataset to elements of the source
/// dataset.
///\param vspace - IN: Dataspace the virtual dataset, possibly an
///\param vspace - IN: Dataspace the virtual dataset, possibly an
/// unlimited selection
///\param src_fname - IN: Name of the HDF5 file where the source dataset
///\param src_fname - IN: Name of the HDF5 file where the source dataset
/// is located (\a H5std_string)
///\param src_fname - IN: Path to the dataset in the file specified by
///\param src_dsname - IN: Path to the dataset in the file specified by
/// \a src_file_name (\a H5std_string)
///\param sspace - IN: Dataspace with a selection applied, possibly
///\param sspace - IN: Dataspace with a selection applied, possibly
/// an unlimited selection
///\exception H5::PropListIException
///\par Description

6
c++/src/H5EnumType.cpp
View File

@ -114,10 +114,11 @@ EnumType::EnumType(const IntType& data_type) : DataType()
///\brief Creates an EnumType instance by opening an HDF5 enum datatype
/// given its name, provided as a C character string.
///\param dtype_name - IN: Enum datatype name
///\param loc - IN: Location of the type
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openEnumType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -131,11 +132,12 @@ EnumType::EnumType(const H5Location& loc, const char *dtype_name) : DataType()
// Function: EnumType overloaded constructor
///\brief Creates an EnumType instance by opening an HDF5 enum datatype
/// given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Enum datatype name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openEnumType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016

7
c++/src/H5FcreatProp.cpp
View File

@ -298,7 +298,8 @@ unsigned FileCreatPropList::getIstorek() const
// Function: FileCreatPropList::setFileSpaceStrategy
///\brief Sets the strategy and the threshold value that the library
/// will employ in managing file space.
///\param strategy - IN: Strategy for file space management
///\param strategy - IN: Strategy for file space management
///\param persist - IN: Whether to persist free-space
///\param threshold - IN: Free-space section threshold. The library
/// default is 1, which is to track all free-space sections.
///\exception H5::PropListIException
@ -325,6 +326,9 @@ void FileCreatPropList::setFileSpaceStrategy(H5F_fspace_strategy_t strategy, hbo
// Function: FileCreatPropList::getFileSpaceStrategy
///\brief Retrieves the strategy, persist, and threshold that the library
/// uses in managing file space.
///\param strategy - OUT: Strategy for file space management
///\param persist - OUT: Whether to persist free-space
///\param threshold - OUT: Free-space section threshold
///\exception H5::PropListIException
// Programmer Binh-Minh Ribler - Feb, 2017
//--------------------------------------------------------------------------
@ -341,6 +345,7 @@ void FileCreatPropList::getFileSpaceStrategy(H5F_fspace_strategy_t& strategy, hb
//--------------------------------------------------------------------------
// Function: FileCreatPropList::setFileSpacePagesize
///\brief Sets the file space page size for paged aggregation.
///\param fsp_psize - IN: Filespace's page size
///\exception H5::PropListIException
// Programmer Binh-Minh Ribler - Feb, 2017
//--------------------------------------------------------------------------

6
c++/src/H5FloatType.cpp
View File

@ -95,11 +95,12 @@ FloatType::FloatType(const DataSet& dataset) : AtomType()
// Function: FloatType overloaded constructor
///\brief Creates an FloatType instance by opening an HDF5 float datatype
/// given its name, provided as a C character string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Float type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openFloatType(const char*)
// to improve usability.
// -BMR, Dec 2016
@ -113,11 +114,12 @@ FloatType::FloatType(const H5Location& loc, const char *dtype_name) : AtomType()
// Function: FloatType overloaded constructor
///\brief Creates an FloatType instance by opening an HDF5 float datatype
/// given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Float type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openFloatType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016

23
c++/src/H5Group.cpp
View File

@ -66,6 +66,9 @@ Group::Group(const Group& original) : H5Object(), CommonFG(), id(original.id)
//--------------------------------------------------------------------------
// Function: Group::getObjId
///\brief Opens an object via object header.
///\param obj_name - IN: Path to the object
///\param plist - IN: Access property list for the link pointing to
/// the object
///\exception H5::FileIException or H5::GroupIException
///\par Description
/// This function opens an object in a group or file, using
@ -88,6 +91,8 @@ hid_t Group::getObjId(const char* obj_name, const PropList& plist) const
///\brief This is an overloaded member function, provided for convenience.
/// It takes a reference to a \c H5std_string for the object's name.
///\param obj_name - IN: Path to the object
///\param plist - IN: Access property list for the link pointing to
/// the object
///\exception H5::FileIException or H5::GroupIException
// Programmer Binh-Minh Ribler - March, 2017
//--------------------------------------------------------------------------
@ -159,15 +164,19 @@ Group::Group(const H5Location& loc, const void* ref, H5R_type_t ref_type, const
//--------------------------------------------------------------------------
// Function: Group overload constructor - dereference
///\brief Given a reference, ref, to an hdf5 group, creates a Group object
///\param attr - IN: Specifying location where the referenced object is in
///\param ref - IN: Reference pointer
///\param ref_type - IN: Reference type - default to H5R_OBJECT
///\param plist - IN: Property list - default to PropList::DEFAULT
///\exception H5::ReferenceException
// brief Given a reference, ref, to an hdf5 group, creates a Group objec
// param attr - IN: Specifying location where the referenced object is i
// param ref - IN: Reference pointer
// param ref_type - IN: Reference type - default to H5R_OBJECT
// param plist - IN: Property list - default to PropList::DEFAULT
// exception H5::ReferenceException
// Programmer Binh-Minh Ribler - Oct, 2006
// Modification
// Mar, 2017
// Removed in 1.10.1 because H5Location is Attribute's baseclass
// now. -BMR
//--------------------------------------------------------------------------
/* Group::Group(const Attribute& attr, const void* ref, H5R_type_t ref_type, const PropList& plist) : H5Object(), id(H5I_INVALID_HID)
/* Group::Group(const Attribute& attr, const void* ref, H5R_type_t ref_type, const PropList& plist) : H5Object(), id(H5I_INVALID_HID)
{
id = H5Location::p_dereference(attr.getId(), ref, ref_type, plist, "constructor - by dereference");
}

1
c++/src/H5Group.h
View File

@ -52,6 +52,7 @@ class H5_DLLCPP Group : public H5Object, public CommonFG {
// Creates a group by way of dereference.
Group(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
// Removed in 1.10.1, because H5Location is baseclass
// Group(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
// Opens an object within a group or a file, i.e., root group.

10
c++/src/H5IdComponent.cpp
View File

@ -24,6 +24,7 @@
namespace H5 {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
// This flag indicates whether H5Library::initH5cpp has been called to register
// the terminating functions with atexit()
bool IdComponent::H5cppinit = false;
@ -32,6 +33,7 @@ bool IdComponent::H5cppinit = false;
// Subclasses that have global constants use it. This is a temporary
// work-around in 1.8.16. It will be removed after HDFFV-9540 is fixed.
bool IdComponent::H5dontAtexit_called = false;
#endif // DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: IdComponent::incRefCount
@ -165,7 +167,7 @@ H5I_type_t IdComponent::getHDFObjType() const
// Function: getNumMembers (static)
///\brief Returns the number of members of the given type.
///\return Number of members
///\Description
///\par Description
/// If there is no member of the given type, getNumMembers will
/// return 0. Valid types are:
/// \li \c H5I_FILE (= 1)
@ -197,9 +199,9 @@ hsize_t IdComponent::getNumMembers(H5I_type_t type)
// Function: isValid (static)
///\brief Checks if the given ID is valid.
///\return true if the given identifier is valid, and false, otherwise.
///\Description
///\par Description
/// A valid ID is one that is in use and has an application
/// reference count of at least 1.
/// reference count of at least 1.
// Programmer Binh-Minh Ribler - Mar 1, 2017
//--------------------------------------------------------------------------
bool IdComponent::isValid(hid_t an_id)
@ -219,7 +221,7 @@ bool IdComponent::isValid(hid_t an_id)
///\brief Queries if a given type is currently registered with the
/// library.
///\return true if the given type exists, and false, otherwise.
///\Description
///\par Description
/// Valid types are:
/// \li \c H5I_FILE (= 1)
/// \li \c H5I_GROUP

6
c++/src/H5IntType.cpp
View File

@ -94,11 +94,12 @@ IntType::IntType(const DataSet& dataset) : AtomType()
// Function: IntType overloaded constructor
///\brief Creates a IntType instance by opening an HDF5 integer datatype
/// given its name as a char*.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Integer type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openIntType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -112,11 +113,12 @@ IntType::IntType(const H5Location& loc, const char *dtype_name) : AtomType()
// Function: IntType overloaded constructor
///\brief Creates a IntType instance by opening an HDF5 integer datatype
/// given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Integer type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openArrayType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016

19
c++/src/H5Location.cpp
View File

@ -524,16 +524,19 @@ void H5Location::dereference(const H5Location& loc, const void* ref, H5R_type_t
//--------------------------------------------------------------------------
// Function: H5Location::dereference
///\brief Dereferences a reference into an HDF5 object, given an attribute.
///\param attr - IN: Attribute specifying the location of the referenced object
///\param ref - IN: Reference pointer
///\param ref_type - IN: Reference type
///\param plist - IN: Property list - default to PropList::DEFAULT
///\exception H5::ReferenceException
// brief Dereferences a reference into an HDF5 object, given an attribute.
// param attr - IN: Attribute specifying the location of the referenced object
// param ref - IN: Reference pointer
// param ref_type - IN: Reference type
// param plist - IN: Property list - default to PropList::DEFAULT
// exception H5::ReferenceException
// Programmer Binh-Minh Ribler - Oct, 2006
// Modification
// May, 2008
// Corrected missing parameters. - BMR
// Corrected missing parameters. -BMR
// Mar, 2017
// Removed in 1.10.1 because H5Location is Attribute's baseclass
// now. -BMR
//--------------------------------------------------------------------------
/* void H5Location::dereference(const Attribute& attr, const void* ref, H5R_type_t ref_type, const PropList& plist)
{
@ -865,7 +868,7 @@ DataSet H5Location::createDataSet(const char* name, const DataType& data_type, c
//--------------------------------------------------------------------------
DataSet H5Location::createDataSet(const H5std_string& name, const DataType& data_type, const DataSpace& data_space, const DSetCreatPropList& create_plist) const
{
return(createDataSet( name.c_str(), data_type, data_space, create_plist));
return(createDataSet(name.c_str(), data_type, data_space, create_plist));
}
//--------------------------------------------------------------------------

1
c++/src/H5Location.h
View File

@ -86,6 +86,7 @@ class H5_DLLCPP H5Location : public IdComponent {
// Open a referenced object whose location is specified by either
// a file, an HDF5 object, or an attribute.
void dereference(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
// Removed in 1.10.1, because H5Location is baseclass
//void dereference(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
// Retrieves a dataspace with the region pointed to selected.

5
c++/src/H5Object.cpp
View File

@ -51,7 +51,6 @@ extern "C" herr_t userAttrOpWrpr(hid_t loc_id, const char *attr_name,
myData->op(*myData->location, s_attr_name, myData->opData);
return 0;
}
#endif
//--------------------------------------------------------------------------
// Function: H5Object default constructor (protected)
@ -101,6 +100,7 @@ void f_Attribute_setId(Attribute* attr, hid_t new_id)
{
attr->p_setId(new_id);
}
#endif
//--------------------------------------------------------------------------
// Function: H5Object::createAttribute
@ -391,6 +391,8 @@ void H5Object::renameAttr(const H5std_string& oldname, const H5std_string& newna
{
renameAttr (oldname.c_str(), newname.c_str());
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: getObjName
///\brief Given an id, returns the type of the object.
@ -502,7 +504,6 @@ ssize_t H5Object::getObjName(H5std_string& obj_name, size_t len) const
return(name_size);
}
#ifndef DOXYGEN_SHOULD_SKIP_THIS
//--------------------------------------------------------------------------
// Function: H5Object destructor
///\brief Noop destructor.

9
c++/src/H5OcreatProp.cpp
View File

@ -155,7 +155,7 @@ void ObjCreatPropList::getAttrPhaseChange(unsigned& max_compact, unsigned& min_d
//--------------------------------------------------------------------------
// Function: ObjCreatPropList::setAttrCrtOrder
///\brief Sets tracking and indexing of attribute creation order.
///\brief Set the flags for creation order of attributes on an object
///\param crt_order_flags - IN: Flags specifying whether to track and
/// index attribute creation order. Default: No flag set
///\exception H5::PropListIException
@ -183,10 +183,9 @@ void ObjCreatPropList::setAttrCrtOrder(unsigned crt_order_flags) const
//--------------------------------------------------------------------------
// Function: ObjCreatPropList::getAttrCrtOrder
///\brief Gets tracking and indexing settings for attribute
/// creation order.
///\param crt_order_flags - OUT: Flags specifying whether to track and
/// index attribute creation order
///\brief Returns the flags indicating creation order is tracked/indexed
/// for attributes on an object.
///\return The flags
///\exception H5::PropListIException
///\par Description
/// When no flag is set, i.e. crt_order_flags = 0, attribute

6
c++/src/H5StrType.cpp
View File

@ -148,11 +148,12 @@ StrType::StrType(const DataSet& dataset) : AtomType ()
// Function: StrType overloaded constructor
///\brief Creates an StrType instance by opening an HDF5 string datatype
/// given its name, provided as a C character string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: String type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openStrType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -166,11 +167,12 @@ StrType::StrType(const H5Location& loc, const char *dtype_name) : AtomType()
// Function: StrType overloaded constructor
///\brief Creates an StrType instance by opening an HDF5 string datatype
/// given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: String type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openStrType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016

6
c++/src/H5VarLenType.cpp
View File

@ -76,11 +76,12 @@ VarLenType::VarLenType(const DataType* base_type) : DataType()
// Function: VarLenType overloaded constructor
///\brief Creates an VarLenType instance by opening an HDF5 variable
/// length datatype given its name, provided as a C char*.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Variable length type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openVarLenType(const char*) to
// improve usability.
// -BMR, Dec 2016
@ -94,11 +95,12 @@ VarLenType::VarLenType(const H5Location& loc, const char *dtype_name) : DataType
// Function: VarLenType overloaded constructor
///\brief Creates an VarLenType instance by opening an HDF5 variable
/// length datatype given its name, provided as an \c H5std_string.
///\param loc - IN: Location of the type
///\param dtype_name - IN: Variable length type name
///\exception H5::DataTypeIException
// Programmer Binh-Minh Ribler - Dec 2016
// Description
// In 1.10.1, this constructor was introduced and will replace the
// In 1.10.1, this constructor was introduced and may replace the
// existing function CommonFG::openVarLenType(const H5std_string&)
// to improve usability.
// -BMR, Dec 2016

3
c++/test/ttypes.cpp
View File

@ -272,9 +272,8 @@ static void test_query()
tcpl.close();
tid2.close();
// Open the datatypes for query
// Open the datatypes for query. Testing both ways
// Deprecated functions
tid1 = file.openCompType(CompT_NAME);
tid1.close();
tid2 = file.openEnumType(EnumT_NAME);