diff options
| author | Quincey Koziol <koziol@hdfgroup.org> | 2005-08-13 20:53:35 (GMT) |
|---|---|---|
| committer | Quincey Koziol <koziol@hdfgroup.org> | 2005-08-13 20:53:35 (GMT) |
| commit | 6b45f5172ccb4311e0be9ae15da3758abb6b0e67 (patch) | |
| tree | 5a7a112fe7a8a98c6fecb45b513789d15962eb3d /c++/src | |
| parent | 6562465a2c2a58cfbc2f47bf60bb538f7a783933 (diff) | |
| download | hdf5-6b45f5172ccb4311e0be9ae15da3758abb6b0e67.zip hdf5-6b45f5172ccb4311e0be9ae15da3758abb6b0e67.tar.gz hdf5-6b45f5172ccb4311e0be9ae15da3758abb6b0e67.tar.bz2 | |
[svn-r11245] Purpose:
Code cleanup
Description:
Trim trailing whitespace, which is making 'diff'ing the two branches
difficult.
Solution:
Ran this script in each directory:
foreach f (*.[ch] *.cpp)
sed 's/[[:blank:]]*$//' $f > sed.out && mv sed.out $f
end
Platforms tested:
FreeBSD 4.11 (sleipnir)
Too minor to require h5committest
Diffstat (limited to 'c++/src')
50 files changed, 712 insertions, 712 deletions
diff --git a/c++/src/H5AbstractDs.cpp b/c++/src/H5AbstractDs.cpp index 9e02181..e3bbd79 100644 --- a/c++/src/H5AbstractDs.cpp +++ b/c++/src/H5AbstractDs.cpp @@ -51,7 +51,7 @@ AbstractDs::AbstractDs( const AbstractDs& original ) : H5Object( original ) {} //-------------------------------------------------------------------------- // Function: AbstractDs::getTypeClass -///\brief Returns the class of the datatype that is used by this +///\brief Returns the class of the datatype that is used by this /// object, which can be a dataset or an attribute. ///\return Datatype class identifier ///\exception H5::DataTypeIException @@ -60,7 +60,7 @@ AbstractDs::AbstractDs( const AbstractDs& original ) : H5Object( original ) {} H5T_class_t AbstractDs::getTypeClass() const { // Gets the datatype used by this dataset or attribute. - // p_get_type calls either H5Dget_type or H5Aget_type depending on + // p_get_type calls either H5Dget_type or H5Aget_type depending on // which object invokes getTypeClass hid_t datatype_id; try { @@ -79,7 +79,7 @@ H5T_class_t AbstractDs::getTypeClass() const return( type_class ); else { - throw DataTypeIException(inMemFunc("getTypeClass"), + throw DataTypeIException(inMemFunc("getTypeClass"), "H5Tget_class returns H5T_NO_CLASS"); } } @@ -95,8 +95,8 @@ H5T_class_t AbstractDs::getTypeClass() const DataType AbstractDs::getDataType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getDataType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getDataType. Then, create and // return the DataType object try { DataType datatype(p_get_type()); @@ -121,8 +121,8 @@ DataType AbstractDs::getDataType() const ArrayType AbstractDs::getArrayType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getArrayType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getArrayType. Then, create and // return the ArrayType object try { ArrayType arraytype(p_get_type()); @@ -138,7 +138,7 @@ ArrayType AbstractDs::getArrayType() const //-------------------------------------------------------------------------- // Function: AbstractDs::getCompType -///\brief Returns the compound datatype of this abstract dataset which +///\brief Returns the compound datatype of this abstract dataset which /// can be a dataset or an attribute. ///\return CompType instance ///\exception H5::DataTypeIException @@ -147,8 +147,8 @@ ArrayType AbstractDs::getArrayType() const CompType AbstractDs::getCompType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getCompType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getCompType. Then, create and // return the CompType object try { CompType comptype(p_get_type()); @@ -164,7 +164,7 @@ CompType AbstractDs::getCompType() const //-------------------------------------------------------------------------- // Function: AbstractDs::getEnumType -///\brief Returns the enumeration datatype of this abstract dataset which +///\brief Returns the enumeration datatype of this abstract dataset which /// can be a dataset or an attribute. ///\return EnumType instance ///\exception H5::DataTypeIException @@ -173,8 +173,8 @@ CompType AbstractDs::getCompType() const EnumType AbstractDs::getEnumType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getEnumType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getEnumType. Then, create and // return the EnumType object try { EnumType enumtype(p_get_type()); @@ -190,7 +190,7 @@ EnumType AbstractDs::getEnumType() const //-------------------------------------------------------------------------- // Function: AbstractDs::getIntType -///\brief Returns the integer datatype of this abstract dataset which +///\brief Returns the integer datatype of this abstract dataset which /// can be a dataset or an attribute. ///\return IntType instance ///\exception H5::DataTypeIException @@ -199,8 +199,8 @@ EnumType AbstractDs::getEnumType() const IntType AbstractDs::getIntType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getIntType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getIntType. Then, create and // return the IntType object try { IntType inttype(p_get_type()); @@ -225,8 +225,8 @@ IntType AbstractDs::getIntType() const FloatType AbstractDs::getFloatType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getFloatType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getFloatType. Then, create and // return the FloatType object try { FloatType floatype(p_get_type()); @@ -242,7 +242,7 @@ FloatType AbstractDs::getFloatType() const //-------------------------------------------------------------------------- // Function: AbstractDs::getStrType -///\brief Returns the string datatype of this abstract dataset which +///\brief Returns the string datatype of this abstract dataset which /// can be a dataset or an attribute. ///\return StrType instance ///\exception H5::DataTypeIException @@ -251,8 +251,8 @@ FloatType AbstractDs::getFloatType() const StrType AbstractDs::getStrType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getStrType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getStrType. Then, create and // return the StrType object try { StrType strtype(p_get_type()); @@ -277,8 +277,8 @@ StrType AbstractDs::getStrType() const VarLenType AbstractDs::getVarLenType() const { // Gets the id of the datatype used by this dataset or attribute using - // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type - // depending on which object invokes getVarLenType. Then, create and + // p_get_type. p_get_type calls either H5Dget_type or H5Aget_type + // depending on which object invokes getVarLenType. Then, create and // return the VarLenType object try { VarLenType varlentype(p_get_type()); diff --git a/c++/src/H5AbstractDs.h b/c++/src/H5AbstractDs.h index 03b87ec..de086a3 100644 --- a/c++/src/H5AbstractDs.h +++ b/c++/src/H5AbstractDs.h @@ -35,9 +35,9 @@ class VarLenType; class H5_DLLCPP AbstractDs : public H5Object { public: // Gets a copy the datatype of that this abstract dataset uses. - // Note that this datatype is a generic one and can only be accessed - // via generic member functions, i.e., member functions belong - // to DataType. To get specific datatype, i.e. EnumType, FloatType, + // Note that this datatype is a generic one and can only be accessed + // via generic member functions, i.e., member functions belong + // to DataType. To get specific datatype, i.e. EnumType, FloatType, // etc..., use the specific functions, that follow, instead. DataType getDataType() const; @@ -53,11 +53,11 @@ class H5_DLLCPP AbstractDs : public H5Object { // Gets the dataspace of this abstract dataset - pure virtual. virtual DataSpace getSpace() const = 0; - // Gets the class of the datatype that is used by this abstract + // Gets the class of the datatype that is used by this abstract // dataset. H5T_class_t getTypeClass() const; - // Returns the amount of storage size required for this abstract + // Returns the amount of storage size required for this abstract // dataset - pure virtual. virtual hsize_t getStorageSize() const = 0; @@ -65,7 +65,7 @@ class H5_DLLCPP AbstractDs : public H5Object { AbstractDs( const AbstractDs& original ); // Destructor - virtual ~AbstractDs(); + virtual ~AbstractDs(); protected: // Default constructor diff --git a/c++/src/H5ArrayType.cpp b/c++/src/H5ArrayType.cpp index 6366752..b23877c 100644 --- a/c++/src/H5ArrayType.cpp +++ b/c++/src/H5ArrayType.cpp @@ -33,11 +33,11 @@ namespace H5 { ///\brief Default constructor: Creates a stub ArrayType // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- -ArrayType::ArrayType() : DataType() +ArrayType::ArrayType() : DataType() { // Initialize members rank = -1; - dimensions = NULL; + dimensions = NULL; } //-------------------------------------------------------------------------- @@ -47,7 +47,7 @@ ArrayType::ArrayType() : DataType() ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- -ArrayType::ArrayType( const hid_t existing_id ) : DataType( existing_id ) +ArrayType::ArrayType( const hid_t existing_id ) : DataType( existing_id ) { // Get the rank of the existing array and store it in this array rank = H5Tget_array_ndims(existing_id); @@ -71,17 +71,17 @@ ArrayType::ArrayType( const hid_t existing_id ) : DataType( existing_id ) ///\brief Copy constructor: makes a copy of the original ArrayType object. // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- -ArrayType::ArrayType( const ArrayType& original ) : DataType( original ) +ArrayType::ArrayType( const ArrayType& original ) : DataType( original ) { rank = original.rank; dimensions = new hsize_t[rank]; for (int i = 0; i < rank; i++) - dimensions[i] = original.dimensions[i]; + dimensions[i] = original.dimensions[i]; } //-------------------------------------------------------------------------- // Function: ArrayType overloaded constructor -///\brief Creates a new array data type based on the specified +///\brief Creates a new array data type based on the specified /// \a base_type. ///\param base_type - IN: Existing datatype ///\param ndims - IN: Rank of the array, [0..H5S_MAX_RANK] @@ -100,7 +100,7 @@ ArrayType::ArrayType(const DataType& base_type, int ndims, const hsize_t* dims) rank = ndims; dimensions = new hsize_t[rank]; for (int i = 0; i < rank; i++) - dimensions[i] = dims[i]; + dimensions[i] = dims[i]; } //-------------------------------------------------------------------------- @@ -147,11 +147,11 @@ int ArrayType::getArrayDims(hsize_t* dims) rank = ndims; dimensions = new hsize_t[rank]; for (int i = 0; i < rank; i++) - dimensions[i] = dims[i]; + dimensions[i] = dims[i]; } // otherwise, simply copy what's in 'dimensions' to 'dims' for (int i = 0; i < rank; i++) - dims[i] = dimensions[i]; + dims[i] = dimensions[i]; return(rank); } @@ -160,7 +160,7 @@ int ArrayType::getArrayDims(hsize_t* dims) ///\brief Properly terminates access to this array datatype. // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- -ArrayType::~ArrayType() +ArrayType::~ArrayType() { // Free allocated memory if (dimensions != NULL) diff --git a/c++/src/H5ArrayType.h b/c++/src/H5ArrayType.h index 023998d..faf738a 100644 --- a/c++/src/H5ArrayType.h +++ b/c++/src/H5ArrayType.h @@ -24,7 +24,7 @@ namespace H5 { #endif class H5_DLLCPP ArrayType : public DataType { public: - // Constructor that creates a new array data type based on the + // Constructor that creates a new array data type based on the // specified base type. ArrayType(const DataType& base_type, int ndims, const hsize_t* dims); diff --git a/c++/src/H5AtomType.cpp b/c++/src/H5AtomType.cpp index 56bb6eb..c58f2e7 100644 --- a/c++/src/H5AtomType.cpp +++ b/c++/src/H5AtomType.cpp @@ -55,7 +55,7 @@ AtomType::AtomType( const AtomType& original ) : DataType( original ) {} //-------------------------------------------------------------------------- // Function: AtomType::setSize -///\brief Sets the total size for an atomic datatype. +///\brief Sets the total size for an atomic datatype. ///\param size - IN: Size to set ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -88,7 +88,7 @@ H5T_order_t AtomType::getOrder() const // return a byte order constant if successful if( type_order == H5T_ORDER_ERROR ) { - throw DataTypeIException(inMemFunc("getOrder"), + throw DataTypeIException(inMemFunc("getOrder"), "H5Tget_order returns H5T_ORDER_ERROR"); } return( type_order ); @@ -148,12 +148,12 @@ void AtomType::setOrder( H5T_order_t order ) const //-------------------------------------------------------------------------- // Function: AtomType::getPrecision -///\brief Returns the precision of an atomic datatype. -///\return Number of significant bits +///\brief Returns the precision of an atomic datatype. +///\return Number of significant bits ///\exception H5::DataTypeIException ///\par Description -/// The precision is the number of significant bits which, -/// unless padding is present, is 8 times larger than the +/// The precision is the number of significant bits which, +/// unless padding is present, is 8 times larger than the /// value returned by \c DataType::getSize(). // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -172,7 +172,7 @@ size_t AtomType::getPrecision() const //-------------------------------------------------------------------------- // Function: AtomType::setPrecision -///\brief Sets the precision of an atomic datatype. +///\brief Sets the precision of an atomic datatype. ///\param precision - IN: Number of bits of precision ///\exception H5::DataTypeIException ///\par Description @@ -192,7 +192,7 @@ void AtomType::setPrecision( size_t precision ) const //-------------------------------------------------------------------------- // Function: AtomType::getOffset -///\brief Retrieves the bit offset of the first significant bit. +///\brief Retrieves the bit offset of the first significant bit. ///\return Offset value ///\exception H5::DataTypeIException ///\par Description @@ -219,7 +219,7 @@ int AtomType::getOffset() const //-------------------------------------------------------------------------- // Function: AtomType::setOffset -///\brief Sets the bit offset of the first significant bit. +///\brief Sets the bit offset of the first significant bit. ///\param offset - IN: Offset of first significant bit ///\exception H5::DataTypeIException ///\par Description @@ -239,16 +239,16 @@ void AtomType::setOffset( size_t offset ) const //-------------------------------------------------------------------------- // Function: AtomType::getPad -///\brief Retrieves the padding type of the least and most-significant -/// bit padding. +///\brief Retrieves the padding type of the least and most-significant +/// bit padding. ///\param lsb - OUT: Least-significant bit padding type ///\param msb - OUT: Most-significant bit padding type ///\exception H5::DataTypeIException ///\par Description /// Possible values for \a lsb and \a msb include: -/// \li \c H5T_PAD_ZERO (0) - Set background to zeros. -/// \li \c H5T_PAD_ONE (1) - Set background to ones. -/// \li \c H5T_PAD_BACKGROUND (2) - Leave background alone. +/// \li \c H5T_PAD_ZERO (0) - Set background to zeros. +/// \li \c H5T_PAD_ONE (1) - Set background to ones. +/// \li \c H5T_PAD_BACKGROUND (2) - Leave background alone. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void AtomType::getPad( H5T_pad_t& lsb, H5T_pad_t& msb ) const @@ -269,9 +269,9 @@ void AtomType::getPad( H5T_pad_t& lsb, H5T_pad_t& msb ) const ///\exception H5::DataTypeIException ///\par Description /// Valid values for \a lsb and \a msb include: -/// \li \c H5T_PAD_ZERO (0) - Set background to zeros. -/// \li \c H5T_PAD_ONE (1) - Set background to ones. -/// \li \c H5T_PAD_BACKGROUND (2) - Leave background alone. +/// \li \c H5T_PAD_ZERO (0) - Set background to zeros. +/// \li \c H5T_PAD_ONE (1) - Set background to ones. +/// \li \c H5T_PAD_BACKGROUND (2) - Leave background alone. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void AtomType::setPad( H5T_pad_t lsb, H5T_pad_t msb ) const diff --git a/c++/src/H5AtomType.h b/c++/src/H5AtomType.h index 9cca02c..b9a583c 100644 --- a/c++/src/H5AtomType.h +++ b/c++/src/H5AtomType.h @@ -26,33 +26,33 @@ namespace H5 { #endif class H5_DLLCPP AtomType : public DataType { public: - // Returns the byte order of an atomic datatype. + // Returns the byte order of an atomic datatype. H5T_order_t getOrder( string& order_string ) const; H5T_order_t getOrder() const; - // Sets the byte ordering of an atomic datatype. + // Sets the byte ordering of an atomic datatype. void setOrder( H5T_order_t order ) const; - // Retrieves the bit offset of the first significant bit. + // Retrieves the bit offset of the first significant bit. // 12/05/00 - changed return type to int from size_t - C API int getOffset() const; - // Sets the bit offset of the first significant bit. + // Sets the bit offset of the first significant bit. void setOffset( size_t offset ) const; - // Retrieves the padding type of the least and most-significant bit padding. + // Retrieves the padding type of the least and most-significant bit padding. void getPad( H5T_pad_t& lsb, H5T_pad_t& msb ) const; // Sets the least and most-significant bits padding types void setPad( H5T_pad_t lsb, H5T_pad_t msb ) const; - // Returns the precision of an atomic datatype. + // Returns the precision of an atomic datatype. size_t getPrecision() const; - // Sets the precision of an atomic datatype. + // Sets the precision of an atomic datatype. void setPrecision( size_t precision ) const; - // Sets the total size for an atomic datatype. + // Sets the total size for an atomic datatype. void setSize( size_t size ) const; // Returns this class name diff --git a/c++/src/H5Attribute.cpp b/c++/src/H5Attribute.cpp index ccfdd4c..9a177b9 100644 --- a/c++/src/H5Attribute.cpp +++ b/c++/src/H5Attribute.cpp @@ -52,7 +52,7 @@ Attribute::Attribute( const Attribute& original ) : AbstractDs( original ) {} //-------------------------------------------------------------------------- // Function: Attribute overloaded constructor -///\brief Creates an Attribute object using the id of an existing +///\brief Creates an Attribute object using the id of an existing /// attribute. ///\param existing_id - IN: Id of an existing attribute ///\exception H5::AttributeIException @@ -203,7 +203,7 @@ ssize_t Attribute::getName( size_t buf_size, string& attr_name ) const { throw AttributeIException("Attribute::getName", "H5Aget_name failed"); } - // otherwise, convert the C attribute name and return + // otherwise, convert the C attribute name and return attr_name = name_C; delete []name_C; return( name_size ); @@ -212,7 +212,7 @@ ssize_t Attribute::getName( size_t buf_size, string& attr_name ) const //-------------------------------------------------------------------------- // Function: Attribute::getName ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it returns the +/// It differs from the above function in that it returns the /// attribute's name, not the length. ///\return Name of the attribute ///\param buf_size - IN: Desired length of the name @@ -223,7 +223,7 @@ string Attribute::getName( size_t buf_size ) const { string attr_name; ssize_t name_size = getName( buf_size, attr_name ); - return( attr_name ); + return( attr_name ); // let caller catch exception if any } @@ -238,8 +238,8 @@ string Attribute::getName( size_t buf_size ) const //-------------------------------------------------------------------------- string Attribute::getName() const { - // Try with 256 characters for the name first, if the name's length - // returned is more than that then, read the name again with the + // Try with 256 characters for the name first, if the name's length + // returned is more than that then, read the name again with the // appropriate space allocation char* name_C = new char[256]; // temporary C-string for C API ssize_t name_size = H5Aget_name(id, 255, name_C); @@ -248,12 +248,12 @@ string Attribute::getName() const if (name_size >= 256) name_size = getName(name_size, attr_name); - // otherwise, convert the C attribute name and return + // otherwise, convert the C attribute name and return else attr_name = name_C; delete []name_C; - return( attr_name ); + return( attr_name ); } //-------------------------------------------------------------------------- diff --git a/c++/src/H5Attribute.h b/c++/src/H5Attribute.h index 73a5612..9eeab98 100644 --- a/c++/src/H5Attribute.h +++ b/c++/src/H5Attribute.h @@ -57,9 +57,9 @@ class H5_DLLCPP Attribute : public AbstractDs { virtual ~Attribute(); private: - // This function contains the common code that is used by - // getTypeClass and various API functions getXxxType - // defined in AbstractDs for generic datatype and specific + // This function contains the common code that is used by + // getTypeClass and various API functions getXxxType + // defined in AbstractDs for generic datatype and specific // sub-types virtual hid_t p_get_type() const; diff --git a/c++/src/H5CommonFG.cpp b/c++/src/H5CommonFG.cpp index 767286e..de46889 100644 --- a/c++/src/H5CommonFG.cpp +++ b/c++/src/H5CommonFG.cpp @@ -50,10 +50,10 @@ namespace H5 { //-------------------------------------------------------------------------- // Function: CommonFG::createGroup -///\brief Creates a new group at this location which can be a file +///\brief Creates a new group at this location which can be a file /// or another group. ///\param name - IN: Name of the group to create -///\param size_hint - IN: Indicates the number of bytes to reserve for +///\param size_hint - IN: Indicates the number of bytes to reserve for /// the names that will appear in the group ///\return Group instance ///\exception H5::GroupIException @@ -66,7 +66,7 @@ namespace H5 { //-------------------------------------------------------------------------- Group CommonFG::createGroup( const char* name, size_t size_hint ) const { - // Call C routine H5Gcreate to create the named group, giving the + // Call C routine H5Gcreate to create the named group, giving the // location id which can be a file id or a group id hid_t group_id = H5Gcreate( getLocId(), name, size_hint ); @@ -84,7 +84,7 @@ Group CommonFG::createGroup( const char* name, size_t size_hint ) const //-------------------------------------------------------------------------- // Function: CommonFG::createGroup ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -95,7 +95,7 @@ Group CommonFG::createGroup( const string& name, size_t size_hint ) const //-------------------------------------------------------------------------- // Function: CommonFG::openGroup -///\brief Opens an existing group in a location which can be a file +///\brief Opens an existing group in a location which can be a file /// or another group. ///\param name - IN: Name of the group to open ///\return Group instance @@ -104,11 +104,11 @@ Group CommonFG::createGroup( const string& name, size_t size_hint ) const //-------------------------------------------------------------------------- Group CommonFG::openGroup( const char* name ) const { - // Call C routine H5Gopen to open the named group, giving the + // Call C routine H5Gopen to open the named group, giving the // location id which can be a file id or a group id hid_t group_id = H5Gopen( getLocId(), name ); - // If the opening of the group failed, throw an exception + // If the opening of the group failed, throw an exception if( group_id < 0 ) { throwException("openGroup", "H5Gopen failed"); @@ -122,7 +122,7 @@ Group CommonFG::openGroup( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openGroup ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -152,7 +152,7 @@ DataSet CommonFG::createDataSet( const char* name, const DataType& data_type, co // Call C routine H5Dcreate to create the named dataset hid_t dataset_id = H5Dcreate( getLocId(), name, type_id, space_id, create_plist_id ); - // If the creation of the dataset failed, throw an exception + // If the creation of the dataset failed, throw an exception if( dataset_id < 0 ) { throwException("createDataSet", "H5Dcreate failed"); @@ -166,7 +166,7 @@ DataSet CommonFG::createDataSet( const char* name, const DataType& data_type, co //-------------------------------------------------------------------------- // Function: CommonFG::createDataSet ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -186,7 +186,7 @@ DataSet CommonFG::createDataSet( const string& name, const DataType& data_type, DataSet CommonFG::openDataSet( const char* name ) const { // Call C function H5Dopen to open the specified dataset, giving - // the location id and the dataset's name + // the location id and the dataset's name hid_t dataset_id = H5Dopen( getLocId(), name ); // If the dataset's opening failed, throw an exception @@ -203,7 +203,7 @@ DataSet CommonFG::openDataSet( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openDataSet ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -214,17 +214,17 @@ DataSet CommonFG::openDataSet( const string& name ) const //-------------------------------------------------------------------------- // Function: CommonFG::link -///\brief Creates a link of the specified type from \a new_name to +///\brief Creates a link of the specified type from \a new_name to /// \a curr_name. -///\param link_type - IN: Link type; possible values are +///\param link_type - IN: Link type; possible values are /// \li \c H5G_LINK_HARD /// \li \c H5G_LINK_SOFT -///\param curr_name - IN: Name of the existing object if link is a hard +///\param curr_name - IN: Name of the existing object if link is a hard /// link; can be anything for the soft link ///\param new_name - IN: New name for the object ///\exception H5::FileIException or H5::GroupIException ///\par Description -/// Note that both names are interpreted relative to the +/// Note that both names are interpreted relative to the /// specified location. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -240,7 +240,7 @@ void CommonFG::link( H5G_link_t link_type, const char* curr_name, const char* ne //-------------------------------------------------------------------------- // Function: CommonFG::link ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a curr_name and \a new_name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -268,7 +268,7 @@ void CommonFG::unlink( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::unlink ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -284,7 +284,7 @@ void CommonFG::unlink( const string& name ) const ///\param dst - IN: Object's new name ///\exception H5::FileIException or H5::GroupIException ///\note -/// Exercise care in moving groups as it is possible to render +/// Exercise care in moving groups as it is possible to render /// data in a file inaccessible with Group::move. Please refer /// to the Group Interface in the HDF5 User's Guide at: /// http://hdf.ncsa.uiuc.edu/HDF5/doc/Groups.html @@ -302,7 +302,7 @@ void CommonFG::move( const char* src, const char* dst ) const //-------------------------------------------------------------------------- // Function: CommonFG::move ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a src and \a dst. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -336,7 +336,7 @@ void CommonFG::getObjinfo( const char* name, hbool_t follow_link, H5G_stat_t& st //-------------------------------------------------------------------------- // Function: CommonFG::getObjinfo ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -348,7 +348,7 @@ void CommonFG::getObjinfo( const string& name, hbool_t follow_link, H5G_stat_t& //-------------------------------------------------------------------------- // Function: CommonFG::getLinkval ///\brief Returns the name of the object that the symbolic link points to. -///\param name - IN: Symbolic link to the object +///\param name - IN: Symbolic link to the object ///\param size - IN: Maximum number of characters of value to be returned ///\return Name of the object ///\exception H5::FileIException or H5::GroupIException @@ -371,7 +371,7 @@ string CommonFG::getLinkval( const char* name, size_t size ) const //-------------------------------------------------------------------------- // Function: CommonFG::getLinkval ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -387,11 +387,11 @@ string CommonFG::getLinkval( const string& name, size_t size ) const ///\param comment - IN: New comment ///\exception H5::FileIException or H5::GroupIException ///\par Description -/// If \a comment is an empty string or a null pointer, the comment -/// message is removed from the object. -/// Comments should be relatively short, null-terminated, ASCII -/// strings. They can be attached to any object that has an -/// object header, e.g., data sets, groups, named data types, +/// If \a comment is an empty string or a null pointer, the comment +/// message is removed from the object. +/// Comments should be relatively short, null-terminated, ASCII +/// strings. They can be attached to any object that has an +/// object header, e.g., data sets, groups, named data types, /// and data spaces, but not symbolic links. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -407,7 +407,7 @@ void CommonFG::setComment( const char* name, const char* comment ) const //-------------------------------------------------------------------------- // Function: CommonFG::setComment ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name and \a comment. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -495,7 +495,7 @@ string CommonFG::getComment (const string& name) const string CommonFG::getComment( const char* name, size_t bufsize ) const { // temporary C-string for the object's comment - char* comment_C = new char[bufsize+1]; + char* comment_C = new char[bufsize+1]; herr_t ret_value = H5Gget_comment( getLocId(), name, bufsize, comment_C ); @@ -512,7 +512,7 @@ string CommonFG::getComment( const char* name, size_t bufsize ) const //-------------------------------------------------------------------------- // Function: CommonFG::getComment ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -549,7 +549,7 @@ void CommonFG::mount( const char* name, H5File& child, PropList& plist ) const //-------------------------------------------------------------------------- // Function: CommonFG::mount ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -580,7 +580,7 @@ void CommonFG::unmount( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::unmount ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -600,14 +600,14 @@ void CommonFG::unmount( const string& name ) const DataType CommonFG::openDataType( const char* name ) const { // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openDataType", "H5Topen failed"); - } + } // No failure, create and return the DataType object DataType data_type(type_id); return(data_type); @@ -616,7 +616,7 @@ DataType CommonFG::openDataType( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openDataType ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -636,14 +636,14 @@ DataType CommonFG::openDataType( const string& name ) const ArrayType CommonFG::openArrayType( const char* name ) const { // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openArrayType", "H5Topen failed"); - } + } // No failure, create and return the ArrayType object ArrayType array_type (type_id); return(array_type); @@ -672,14 +672,14 @@ ArrayType CommonFG::openArrayType( const string& name ) const CompType CommonFG::openCompType( const char* name ) const { // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openCompType", "H5Topen failed"); - } + } // No failure, create and return the CompType object CompType comp_type(type_id); return(comp_type); @@ -688,7 +688,7 @@ CompType CommonFG::openCompType( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openCompType ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -708,30 +708,30 @@ CompType CommonFG::openCompType( const string& name ) const EnumType CommonFG::openEnumType( const char* name ) const { // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openEnumType", "H5Topen failed"); - } + } // No failure, create and return the EnumType object EnumType enum_type(type_id); return(enum_type); -} +} //-------------------------------------------------------------------------- // Function: CommonFG::openEnumType ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- EnumType CommonFG::openEnumType( const string& name ) const { return( openEnumType( name.c_str()) ); -} +} //-------------------------------------------------------------------------- // Function: CommonFG::openIntType @@ -742,16 +742,16 @@ EnumType CommonFG::openEnumType( const string& name ) const // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- IntType CommonFG::openIntType( const char* name ) const -{ +{ // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openIntType", "H5Topen failed"); - } + } // No failure, create and return the IntType object IntType int_type(type_id); return(int_type); @@ -760,12 +760,12 @@ IntType CommonFG::openIntType( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openIntType ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- IntType CommonFG::openIntType( const string& name ) const -{ +{ return( openIntType( name.c_str()) ); } @@ -778,16 +778,16 @@ IntType CommonFG::openIntType( const string& name ) const // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- FloatType CommonFG::openFloatType( const char* name ) const -{ +{ // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openFloatType", "H5Topen failed"); - } + } // No failure, create and return the FloatType object FloatType float_type(type_id); return(float_type); @@ -796,12 +796,12 @@ FloatType CommonFG::openFloatType( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openFloatType ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- FloatType CommonFG::openFloatType( const string& name ) const -{ +{ return( openFloatType( name.c_str()) ); } @@ -816,14 +816,14 @@ FloatType CommonFG::openFloatType( const string& name ) const StrType CommonFG::openStrType( const char* name ) const { // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openStrType", "H5Topen failed"); - } + } // No failure, create and return the StrType object StrType str_type(type_id); return(str_type); @@ -832,7 +832,7 @@ StrType CommonFG::openStrType( const char* name ) const //-------------------------------------------------------------------------- // Function: CommonFG::openStrType ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -852,14 +852,14 @@ StrType CommonFG::openStrType( const string& name ) const VarLenType CommonFG::openVarLenType( const char* name ) const { // Call C function H5Topen to open the named datatype in this group, - // given either the file or group id + // given either the file or group id hid_t type_id = H5Topen(getLocId(), name); - + // If the datatype's opening failed, throw an exception - if( type_id < 0 ) - { + if( type_id < 0 ) + { throwException("openVarLenType", "H5Topen failed"); - } + } // No failure, create and return the VarLenType object VarLenType varlen_type(type_id); return(varlen_type); @@ -884,8 +884,8 @@ VarLenType CommonFG::openVarLenType( const string& name ) const ///\param idx - IN/OUT: Starting (IN) and ending (OUT) entry indices ///\param op - IN : User's function to operate on each entry ///\param op_data - IN/OUT: Data associated with the operation -///\return The return value of the first operator that returns non-zero, -/// or zero if all members were processed with no operator +///\return The return value of the first operator that returns non-zero, +/// or zero if all members were processed with no operator /// returning non-zero. ///\exception H5::FileIException or H5::GroupIException // Programmer Binh-Minh Ribler - 2000 @@ -903,7 +903,7 @@ int CommonFG::iterateElems( const char* name, int *idx, H5G_iterate_t op , void* //-------------------------------------------------------------------------- // Function: CommonFG::iterateElems ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h index 0bb8e67..c2934b1 100644 --- a/c++/src/H5CommonFG.h +++ b/c++/src/H5CommonFG.h @@ -30,12 +30,12 @@ class ArrayType; class VarLenType; class H5_DLLCPP CommonFG { public: - // Creates a new group at this location which can be a file + // Creates a new group at this location which can be a file // or another group. Group createGroup(const char* name, size_t size_hint = 0) const; Group createGroup(const string& name, size_t size_hint = 0) const; - // Opens an existing group in a location which can be a file + // Opens an existing group in a location which can be a file // or another group. Group openGroup(const char* name) const; Group openGroup(const string& name) const; @@ -68,7 +68,7 @@ class H5_DLLCPP CommonFG { // Returns the number of objects in this group. hsize_t getNumObjs() const; - // Returns information about an HDF5 object, given by its name, + // Returns information about an HDF5 object, given by its name, // at this location. void getObjinfo(const char* name, hbool_t follow_link, H5G_stat_t& statbuf) const; void getObjinfo(const string& name, hbool_t follow_link, H5G_stat_t& statbuf) const; @@ -142,9 +142,9 @@ class H5_DLLCPP CommonFG { VarLenType openVarLenType(const string& name) const; #ifndef DOXYGEN_SHOULD_SKIP_THIS - /// For subclasses, H5File and Group, to return the correct + /// For subclasses, H5File and Group, to return the correct /// object id, i.e. file or group id. - virtual hid_t getLocId() const = 0; + virtual hid_t getLocId() const = 0; #endif // DOXYGEN_SHOULD_SKIP_THIS diff --git a/c++/src/H5CompType.cpp b/c++/src/H5CompType.cpp index aed4b58..9990087 100644 --- a/c++/src/H5CompType.cpp +++ b/c++/src/H5CompType.cpp @@ -89,7 +89,7 @@ CompType::CompType( const DataSet& dataset ) : DataType() //-------------------------------------------------------------------------- // Function: CompType::getNmembers -///\brief Returns the number of members in this compound datatype. +///\brief Returns the number of members in this compound datatype. ///\return Number of members ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -99,7 +99,7 @@ int CompType::getNmembers() const int num_members = H5Tget_nmembers( id ); if( num_members < 0 ) { - throw DataTypeIException("CompType::getNmembers", + throw DataTypeIException("CompType::getNmembers", "H5Tget_nmembers returns negative number of members"); } return( num_members ); @@ -107,7 +107,7 @@ int CompType::getNmembers() const //-------------------------------------------------------------------------- // Function: CompType::getMemberName -///\brief Returns the name of a member in this compound datatype. +///\brief Returns the name of a member in this compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return Name of member ///\exception H5::DataTypeIException @@ -118,23 +118,23 @@ string CompType::getMemberName( unsigned member_num ) const char* member_name_C = H5Tget_member_name( id, member_num ); if( member_name_C == NULL ) // NULL means failure { - throw DataTypeIException("CompType::getMemberName", + throw DataTypeIException("CompType::getMemberName", "H5Tget_member_name returns NULL for member name"); } - string member_name = string(member_name_C); // convert C string to string - HDfree(member_name_C); // free the C string + string member_name = string(member_name_C); // convert C string to string + HDfree(member_name_C); // free the C string return( member_name ); // return the member name string } //-------------------------------------------------------------------------- // Function: CompType::getMemberIndex -///\brief Returns the index of a member in this compound datatype. +///\brief Returns the index of a member in this compound datatype. ///\param name - IN: Name of the member ///\return Index of member ///\exception H5::DataTypeIException ///\par Description -/// Members are stored in no particular order with numbers 0 -/// through N-1, where N is the value returned by the member +/// Members are stored in no particular order with numbers 0 +/// through N-1, where N is the value returned by the member /// function \c CompType::getNmembers. // Programmer Binh-Minh Ribler - May 16, 2002 //-------------------------------------------------------------------------- @@ -143,7 +143,7 @@ int CompType::getMemberIndex(const char* name) const int member_index = H5Tget_member_index(id, name); if( member_index < 0 ) { - throw DataTypeIException("CompType::getMemberIndex", + throw DataTypeIException("CompType::getMemberIndex", "H5Tget_member_index returns negative value"); } return( member_index ); @@ -162,8 +162,8 @@ int CompType::getMemberIndex(const string& name) const ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 // Description -/// Members are stored in no particular order with numbers 0 -/// through N-1, where N is the value returned by the member +/// Members are stored in no particular order with numbers 0 +/// through N-1, where N is the value returned by the member /// function \c CompType::getNmembers. // // Note that byte offset being returned as 0 doesn't indicate @@ -175,11 +175,11 @@ size_t CompType::getMemberOffset( unsigned member_num ) const return( offset ); } -// Returns the dimensionality of the member. +// Returns the dimensionality of the member. int CompType::getMemberDims( unsigned member_num, size_t* dims, int* perm ) const { throw DataTypeIException( "Error: getMemberDims is no longer supported." ); - return (-1); // unreachable statement; but without it, the compiler + return (-1); // unreachable statement; but without it, the compiler // will complain } @@ -204,7 +204,7 @@ H5T_class_t CompType::getMemberClass( unsigned member_num ) const return(member_class); } -// This private member function calls the C API to get the identifier +// This private member function calls the C API to get the identifier // of the specified member. It provides the id to construct appropriate // sub-types in the functions getMemberXxxType below, where Xxx indicates // the sub-types. @@ -224,8 +224,8 @@ hid_t CompType::p_get_member_type(unsigned member_num) const //-------------------------------------------------------------------------- // Function: CompType::getMemberDataType -///\brief Returns the generic datatype of the specified member in this -/// compound datatype. +///\brief Returns the generic datatype of the specified member in this +/// compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return DataType instance ///\exception H5::DataTypeIException @@ -234,7 +234,7 @@ hid_t CompType::p_get_member_type(unsigned member_num) const DataType CompType::getMemberDataType( unsigned member_num ) const { try { - DataType datatype(p_get_member_type(member_num)); + DataType datatype(p_get_member_type(member_num)); return(datatype); } catch (DataTypeIException E) { @@ -264,8 +264,8 @@ ArrayType CompType::getMemberArrayType( unsigned member_num ) const //-------------------------------------------------------------------------- // Function: CompType::getMemberEnumType -///\brief Returns the enumeration datatype of the specified member in -/// this compound datatype. +///\brief Returns the enumeration datatype of the specified member in +/// this compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return EnumType instance ///\exception H5::DataTypeIException @@ -274,7 +274,7 @@ ArrayType CompType::getMemberArrayType( unsigned member_num ) const EnumType CompType::getMemberEnumType( unsigned member_num ) const { try { - EnumType enumtype(p_get_member_type(member_num)); + EnumType enumtype(p_get_member_type(member_num)); return(enumtype); } catch (DataTypeIException E) { @@ -284,8 +284,8 @@ EnumType CompType::getMemberEnumType( unsigned member_num ) const //-------------------------------------------------------------------------- // Function: CompType::getMemberCompType -///\brief Returns the compound datatype of the specified member in this -/// compound datatype. +///\brief Returns the compound datatype of the specified member in this +/// compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return CompType instance ///\exception H5::DataTypeIException @@ -294,7 +294,7 @@ EnumType CompType::getMemberEnumType( unsigned member_num ) const CompType CompType::getMemberCompType( unsigned member_num ) const { try { - CompType comptype(p_get_member_type(member_num)); + CompType comptype(p_get_member_type(member_num)); return(comptype); } catch (DataTypeIException E) { @@ -304,8 +304,8 @@ CompType CompType::getMemberCompType( unsigned member_num ) const //-------------------------------------------------------------------------- // Function: CompType::getMemberIntType -///\brief Returns the integer datatype of the specified member in this -/// compound datatype. +///\brief Returns the integer datatype of the specified member in this +/// compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return IntType instance ///\exception H5::DataTypeIException @@ -314,7 +314,7 @@ CompType CompType::getMemberCompType( unsigned member_num ) const IntType CompType::getMemberIntType( unsigned member_num ) const { try { - IntType inttype(p_get_member_type(member_num)); + IntType inttype(p_get_member_type(member_num)); return(inttype); } catch (DataTypeIException E) { @@ -324,8 +324,8 @@ IntType CompType::getMemberIntType( unsigned member_num ) const //-------------------------------------------------------------------------- // Function: CompType::getMemberFloatType -///\brief Returns the floating-point datatype of the specified member -/// in this compound datatype. +///\brief Returns the floating-point datatype of the specified member +/// in this compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return FloatType instance ///\exception H5::DataTypeIException @@ -334,7 +334,7 @@ IntType CompType::getMemberIntType( unsigned member_num ) const FloatType CompType::getMemberFloatType( unsigned member_num ) const { try { - FloatType floatype(p_get_member_type(member_num)); + FloatType floatype(p_get_member_type(member_num)); return(floatype); } catch (DataTypeIException E) { @@ -344,8 +344,8 @@ FloatType CompType::getMemberFloatType( unsigned member_num ) const //-------------------------------------------------------------------------- // Function: CompType::getMemberStrType -///\brief Returns the string datatype of the specified member in this -/// compound datatype. +///\brief Returns the string datatype of the specified member in this +/// compound datatype. ///\param member_num - IN: Zero-based index of the member ///\return StrType instance ///\exception H5::DataTypeIException @@ -354,13 +354,13 @@ FloatType CompType::getMemberFloatType( unsigned member_num ) const StrType CompType::getMemberStrType( unsigned member_num ) const { try { - StrType strtype(p_get_member_type(member_num)); + StrType strtype(p_get_member_type(member_num)); return(strtype); } catch (DataTypeIException E) { throw DataTypeIException("CompType::getMemberStrType", E.getDetailMsg()); } -} +} //-------------------------------------------------------------------------- // Function: CompType::getMemberVarLenType @@ -382,35 +382,35 @@ VarLenType CompType::getMemberVarLenType( unsigned member_num ) const } } -/* old style of getMemberType - using overloads; new style above +/* old style of getMemberType - using overloads; new style above returns the appropriate datatypes but has different named functions. In the old style, a datatype must be passed into the function. May, 2004: These should be reconsidered to provide more convenience. -// Returns the datatype of the specified member in this compound datatype. +// Returns the datatype of the specified member in this compound datatype. // Several overloading of getMemberType are for different datatypes void CompType::getMemberType( unsigned member_num, EnumType& enumtype ) const { - p_get_member_type(member_num, enumtype); + p_get_member_type(member_num, enumtype); } void CompType::getMemberType( unsigned member_num, CompType& comptype ) const { - p_get_member_type(member_num, comptype); + p_get_member_type(member_num, comptype); } void CompType::getMemberType( unsigned member_num, IntType& inttype ) const { - p_get_member_type(member_num, inttype); + p_get_member_type(member_num, inttype); } void CompType::getMemberType( unsigned member_num, FloatType& floatype ) const { - p_get_member_type(member_num, floatype); + p_get_member_type(member_num, floatype); } void CompType::getMemberType( unsigned member_num, StrType& strtype ) const { - p_get_member_type(member_num, strtype); + p_get_member_type(member_num, strtype); } // end of overloading of getMemberType */ @@ -442,7 +442,7 @@ void CompType::insertMember( const string& name, size_t offset, const DataType& //-------------------------------------------------------------------------- // Function: CompType::pack -///\brief Recursively removes padding from within a compound datatype. +///\brief Recursively removes padding from within a compound datatype. /// ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 diff --git a/c++/src/H5CompType.h b/c++/src/H5CompType.h index d548043..401ed6b 100644 --- a/c++/src/H5CompType.h +++ b/c++/src/H5CompType.h @@ -36,58 +36,58 @@ class H5_DLLCPP CompType : public DataType { // to create another datatype of the same class H5T_class_t getMemberClass( unsigned member_num ) const; - // Returns the dimensionality of the specified member. + // Returns the dimensionality of the specified member. int getMemberDims( unsigned member_num, size_t* dims, int* perm ) const; // Returns the index of a member in this compound data type. int getMemberIndex(const char* name) const; int getMemberIndex(const string& name) const; - // Returns the offset of a member of this compound datatype. + // Returns the offset of a member of this compound datatype. size_t getMemberOffset( unsigned memb_no ) const; - // Returns the name of a member of this compound datatype. + // Returns the name of a member of this compound datatype. string getMemberName( unsigned member_num ) const; - // Returns the generic datatype of the specified member in + // Returns the generic datatype of the specified member in // this compound datatype. DataType getMemberDataType( unsigned member_num ) const; - // Returns the array datatype of the specified member in + // Returns the array datatype of the specified member in // this compound datatype. ArrayType getMemberArrayType( unsigned member_num ) const; - // Returns the compound datatype of the specified member in + // Returns the compound datatype of the specified member in // this compound datatype. CompType getMemberCompType( unsigned member_num ) const; - // Returns the enumeration datatype of the specified member in + // Returns the enumeration datatype of the specified member in // this compound datatype. EnumType getMemberEnumType( unsigned member_num ) const; - // Returns the integer datatype of the specified member in + // Returns the integer datatype of the specified member in // this compound datatype. IntType getMemberIntType( unsigned member_num ) const; - // Returns the floating-point datatype of the specified member in + // Returns the floating-point datatype of the specified member in // this compound datatype. FloatType getMemberFloatType( unsigned member_num ) const; - // Returns the string datatype of the specified member in + // Returns the string datatype of the specified member in // this compound datatype. StrType getMemberStrType( unsigned member_num ) const; - // Returns the variable length datatype of the specified member in + // Returns the variable length datatype of the specified member in // this compound datatype. VarLenType getMemberVarLenType( unsigned member_num ) const; - // Returns the number of members in this compound datatype. + // Returns the number of members in this compound datatype. int getNmembers() const; // Adds a new member to this compound datatype. void insertMember( const string& name, size_t offset, const DataType& new_member ) const; - // Recursively removes padding from within this compound datatype. + // Recursively removes padding from within this compound datatype. void pack() const; // Returns this class name @@ -108,7 +108,7 @@ class H5_DLLCPP CompType : public DataType { private: // Contains common code that is used by the member functions // getMemberXxxType - hid_t p_get_member_type(unsigned member_num) const; + hid_t p_get_member_type(unsigned member_num) const; }; #ifndef H5_NO_NAMESPACE } diff --git a/c++/src/H5CppDoc.h b/c++/src/H5CppDoc.h index f451d56..d215f19 100644 --- a/c++/src/H5CppDoc.h +++ b/c++/src/H5CppDoc.h @@ -17,7 +17,7 @@ #define _H5CPPDOC_H //------------------------------------------------------------------------- -// The following section will be used to generate the 'Mainpage' +// The following section will be used to generate the 'Mainpage' // and the 'Examples' for the RM. // ------------------------------------------------------------------------ @@ -26,15 +26,15 @@ * \section intro_sec Introduction * * The C++ API provides C++ wrappers for the HDF5 C library. - * It is assumed that the user has knowledge of the HDF5 file format + * It is assumed that the user has knowledge of the HDF5 file format * and its components. If you are not familiar with HDF5 file format, * and would like to find out more, please refer to the HDF5 documentation * at http://hdf.ncsa.uiuc.edu/HDF5/doc/H5.intro.html * - * Because the HDF5 library maps very well to - * the object oriented design approach, classes in the C++ API can + * Because the HDF5 library maps very well to + * the object oriented design approach, classes in the C++ API can * closely represent the interfaces of the HDF5 APIs, as followed: - * + * * \verbatim HDF5 C APIs C++ Classes ----------- ----------- @@ -54,7 +54,7 @@ * under the top directory for information about installing, building, * and testing the C++ API. * - * + * */ /// This example shows how to create datasets. diff --git a/c++/src/H5DataSet.cpp b/c++/src/H5DataSet.cpp index 7ab5179..34a87d7 100644 --- a/c++/src/H5DataSet.cpp +++ b/c++/src/H5DataSet.cpp @@ -82,7 +82,7 @@ DataSpace DataSet::getSpace() const return( data_space ); } -// This private member function calls the C API to get the identifier +// This private member function calls the C API to get the identifier // of the datatype that is used by this dataset. It is used // by the various AbstractDs functions to get the specific datatype. hid_t DataSet::p_get_type() const @@ -110,7 +110,7 @@ DSetCreatPropList DataSet::getCreatePlist() const { throw DataSetIException("DataSet::getCreatePlist", "H5Dget_create_plist failed"); } - // create and return the DSetCreatPropList object + // create and return the DSetCreatPropList object DSetCreatPropList create_plist( create_plist_id ); return( create_plist ); } @@ -190,9 +190,9 @@ hsize_t DataSet::getVlenBufSize( DataType& type, DataSpace& space ) const //-------------------------------------------------------------------------- // Function: DataSet::vlenReclaim -///\brief Reclaims VL datatype memory buffers. +///\brief Reclaims VL datatype memory buffers. ///\param type - IN: Datatype, which is the datatype stored in the buffer -///\param space - IN: Selection for the memory buffer to free the +///\param space - IN: Selection for the memory buffer to free the /// VL datatypes within ///\param xfer_plist - IN: Property list used to create the buffer ///\param buf - IN: Pointer to the buffer to be reclaimed @@ -223,9 +223,9 @@ void DataSet::vlenReclaim( DataType& type, DataSpace& space, DSetMemXferPropList ///\param xfer_plist - IN: Transfer property list for this I/O operation ///\exception H5::DataSetIException ///\par Description -/// This function reads raw data from this dataset into the -/// buffer \a buf, converting from file datatype and dataspace -/// to memory datatype \a mem_type and dataspace \a mem_space. +/// This function reads raw data from this dataset into the +/// buffer \a buf, converting from file datatype and dataspace +/// to memory datatype \a mem_type and dataspace \a mem_space. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void DataSet::read( void* buf, const DataType& mem_type, const DataSpace& mem_space, const DataSpace& file_space, const DSetMemXferPropList& xfer_plist ) const @@ -273,9 +273,9 @@ void DataSet::read( string& strg, const DataType& mem_type, const DataSpace& mem ///\param xfer_plist - IN: Transfer property list for this I/O operation ///\exception H5::DataSetIException ///\par Description -/// This function writes raw data from an application buffer -/// \a buf to a dataset, converting from memory datatype -/// \a mem_type and dataspace \a mem_space to file datatype +/// This function writes raw data from an application buffer +/// \a buf to a dataset, converting from memory datatype +/// \a mem_type and dataspace \a mem_space to file datatype /// and dataspace. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -312,18 +312,18 @@ void DataSet::write( const string& strg, const DataType& mem_type, const DataSpa //-------------------------------------------------------------------------- // Function: DataSet::iterateElems -///\brief Iterates over all selected elements in a dataspace. -///\param buf - IN/OUT: Pointer to the buffer in memory containing the +///\brief Iterates over all selected elements in a dataspace. +///\param buf - IN/OUT: Pointer to the buffer in memory containing the /// elements to iterate over ///\param type - IN: Datatype for the elements stored in \a buf -///\param space - IN: Dataspace for \a buf. Also contains the selection +///\param space - IN: Dataspace for \a buf. Also contains the selection /// to iterate over. -///\param op - IN: Function pointer to the routine to be called for +///\param op - IN: Function pointer to the routine to be called for /// each element in \a buf iterated over -///\param op_data - IN/OUT: Pointer to any user-defined data associated +///\param op_data - IN/OUT: Pointer to any user-defined data associated /// with the operation ///\exception H5::DataSetIException -///\note This function may not work correctly yet - it's still +///\note This function may not work correctly yet - it's still /// under development. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -436,7 +436,7 @@ void* DataSet::Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_ ///\return A reference ///\exception H5::DataSetIException ///\par Description -// This function passes H5R_OBJECT and -1 to the protected +// This function passes H5R_OBJECT and -1 to the protected // function for it to pass to the C API H5Rcreate // to create a reference to the named object. // Programmer Binh-Minh Ribler - May, 2004 @@ -454,7 +454,7 @@ void* DataSet::Reference(const char* name) const //-------------------------------------------------------------------------- // Function: DataSet::Reference ///\brief This is an overloaded function, provided for your convenience. -/// It differs from the above function in that it takes an +/// It differs from the above function in that it takes an /// \c std::string for the object's name. ///\param name - IN: Name of the object to be referenced - \c std::string // Programmer Binh-Minh Ribler - May, 2004 @@ -470,10 +470,10 @@ void* DataSet::Reference(const string& name) const ///\param ref_type - IN: Type of reference to query ///\param ref - IN: Reference to query ///\return An object type, which can be one of the following: -// H5G_LINK Object is a symbolic link. -// H5G_GROUP Object is a group. -// H5G_DATASET Object is a dataset. -// H5G_TYPE Object is a named datatype +// H5G_LINK Object is a symbolic link. +// H5G_GROUP Object is a group. +// H5G_DATASET Object is a dataset. +// H5G_TYPE Object is a named datatype ///\exception H5::DataSetIException // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h index 24e88a7..453a60e 100644 --- a/c++/src/H5DataSet.h +++ b/c++/src/H5DataSet.h @@ -32,7 +32,7 @@ class H5_DLLCPP DataSet : public AbstractDs { // Fills a selection in memory with a value void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& space); - // Fills a selection in memory with zero + // Fills a selection in memory with zero void fillMemBuf(void *buf, DataType& buf_type, DataSpace& space); // Gets the creation property list of this dataset. @@ -40,7 +40,7 @@ class H5_DLLCPP DataSet : public AbstractDs { // Returns the address of this dataset in the file. haddr_t getOffset() const; - + // Gets the dataspace of this dataset. virtual DataSpace getSpace() const; @@ -100,7 +100,7 @@ class H5_DLLCPP DataSet : public AbstractDs { private: // This function contains the common code that is used by - // getTypeClass and various API functions getXxxType + // getTypeClass and various API functions getXxxType // defined in AbstractDs for generic datatype and specific // sub-types virtual hid_t p_get_type() const; diff --git a/c++/src/H5DataSpace.cpp b/c++/src/H5DataSpace.cpp index d29ba20..7ed6ae2 100644 --- a/c++/src/H5DataSpace.cpp +++ b/c++/src/H5DataSpace.cpp @@ -36,7 +36,7 @@ const DataSpace DataSpace::ALL( H5S_ALL ); //-------------------------------------------------------------------------- // Function: DataSpace constructor ///\brief Creates a new dataspace given a dataspace type. -///\param type - IN: Type of the dataspace to be created, which +///\param type - IN: Type of the dataspace to be created, which /// currently can be either \c H5S_SCALAR or \c H5S_SIMPLE; /// default to \c H5S_SCALAR. ///\exception H5::DataSpaceIException @@ -54,9 +54,9 @@ DataSpace::DataSpace( H5S_class_t type ) : IdComponent() //-------------------------------------------------------------------------- // Function: DataSpace overloaded constructor ///\brief Creates a new simple dataspace. -///\param rank - IN: Number of dimensions of dataspace. -///\param dims - IN: An array of the size of each dimension. -///\param maxdims - IN: An array of the maximum size of each dimension. +///\param rank - IN: Number of dimensions of dataspace. +///\param dims - IN: An array of the size of each dimension. +///\param maxdims - IN: An array of the maximum size of each dimension. ///\exception H5::DataSpaceIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -71,7 +71,7 @@ DataSpace::DataSpace( int rank, const hsize_t * dims, const hsize_t * maxdims) : //-------------------------------------------------------------------------- // Function: DataSpace overloaded constructor -///\brief Creates a DataSpace object using the id of an existing +///\brief Creates a DataSpace object using the id of an existing /// dataspace. ///\param existing_id - IN: Id of an existing dataspace ///\exception H5::DataSpaceIException @@ -101,7 +101,7 @@ void DataSpace::copy( const DataSpace& like_space ) { // If this object has a valid id, appropriately decrement reference // counter and close the id. - if( id != H5S_ALL ) { + if( id != H5S_ALL ) { try { decRefCount(); } @@ -110,7 +110,7 @@ void DataSpace::copy( const DataSpace& like_space ) } } // if - // call C routine to copy the dataspace + // call C routine to copy the dataspace id = H5Scopy( like_space.getId() ); if( id < 0 ) @@ -137,7 +137,7 @@ DataSpace& DataSpace::operator=( const DataSpace& rhs ) //-------------------------------------------------------------------------- // Function: DataSpace::isSimple ///\brief Determines whether this dataspace is a simple dataspace. -///\return \c true if the dataspace is a simple dataspace, and \c false, +///\return \c true if the dataspace is a simple dataspace, and \c false, /// otherwise ///\exception H5::DataSpaceIException // Programmer Binh-Minh Ribler - 2000 @@ -151,7 +151,7 @@ bool DataSpace::isSimple () const return false; else { - throw DataSpaceIException("DataSpace::isSimple", + throw DataSpaceIException("DataSpace::isSimple", "H5Sis_simple returns negative value"); } } @@ -162,9 +162,9 @@ bool DataSpace::isSimple () const ///\param offset - IN: Offset to position the selection at ///\exception H5::DataSpaceIException ///\par Description -/// This function creates an offset for the selection within -/// an extent, allowing the same shaped selection to be moved -/// to different locations within a dataspace without requiring +/// This function creates an offset for the selection within +/// an extent, allowing the same shaped selection to be moved +/// to different locations within a dataspace without requiring /// it to be re-defined. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -182,7 +182,7 @@ void DataSpace::offsetSimple ( const hssize_t* offset ) const ///\brief Retrieves dataspace dimension size and maximum size. ///\param dims - IN: Name of the new member ///\param maxdims - IN: Pointer to the value of the new member -///\return Number of dimensions, the same value as returned by +///\return Number of dimensions, the same value as returned by /// \c DataSpace::getSimpleExtentNdims() ///\exception H5::DataSpaceIException // Programmer Binh-Minh Ribler - 2000 @@ -192,7 +192,7 @@ int DataSpace::getSimpleExtentDims ( hsize_t *dims, hsize_t *maxdims ) const int ndims = H5Sget_simple_extent_dims( id, dims, maxdims ); if( ndims < 0 ) { - throw DataSpaceIException("DataSpace::getSimpleExtentDims", + throw DataSpaceIException("DataSpace::getSimpleExtentDims", "H5Sget_simple_extent_dims returns negative number of dimensions"); } return( ndims ); @@ -210,7 +210,7 @@ int DataSpace::getSimpleExtentNdims () const int ndims = H5Sget_simple_extent_ndims( id ); if( ndims < 0 ) { - throw DataSpaceIException("DataSpace::getSimpleExtentNdims", + throw DataSpaceIException("DataSpace::getSimpleExtentNdims", "H5Sget_simple_extent_ndims returns negative value for dimensionality of the dataspace"); } return( ndims ); @@ -235,7 +235,7 @@ hssize_t DataSpace::getSimpleExtentNpoints () const return( num_elements ); else { - throw DataSpaceIException("DataSpace::getSimpleExtentNpoints", + throw DataSpaceIException("DataSpace::getSimpleExtentNpoints", "H5Sget_simple_extent_npoints returns negative value for the number of elements in the dataspace"); } } @@ -252,7 +252,7 @@ H5S_class_t DataSpace::getSimpleExtentType () const H5S_class_t class_name = H5Sget_simple_extent_type( id ); if( class_name == H5S_NO_CLASS ) { - throw DataSpaceIException("DataSpace::getSimpleExtentType", + throw DataSpaceIException("DataSpace::getSimpleExtentType", "H5Sget_simple_extent_type returns H5S_NO_CLASS"); } return( class_name ); @@ -322,7 +322,7 @@ hssize_t DataSpace::getSelectNpoints () const hssize_t num_elements = H5Sget_select_npoints( id ); if( num_elements < 0 ) { - throw DataSpaceIException("DataSpace::getSelectNpoints", + throw DataSpaceIException("DataSpace::getSelectNpoints", "H5Sget_select_npoints returns negative value for number of elements in the dataspace selection"); } return( num_elements ); @@ -340,7 +340,7 @@ hssize_t DataSpace::getSelectHyperNblocks () const hssize_t num_blocks = H5Sget_select_hyper_nblocks( id ); if( num_blocks < 0 ) { - throw DataSpaceIException("DataSpace::getSelectHyperNblocks", + throw DataSpaceIException("DataSpace::getSelectHyperNblocks", "H5Sget_select_hyper_nblocks returns negative value for the number of hyperslab blocks"); } return( num_blocks ); @@ -361,7 +361,7 @@ void DataSpace::getSelectHyperBlocklist( hsize_t startblock, hsize_t numblocks, ret_value = H5Sget_select_hyper_blocklist( id, startblock, numblocks, buf ); if( ret_value < 0 ) { - throw DataSpaceIException("DataSpace::getSelectHyperBlocklist", + throw DataSpaceIException("DataSpace::getSelectHyperBlocklist", "H5Sget_select_hyper_blocklist failed"); } } @@ -378,7 +378,7 @@ hssize_t DataSpace::getSelectElemNpoints () const hssize_t num_points = H5Sget_select_elem_npoints( id ); if( num_points < 0 ) { - throw DataSpaceIException("DataSpace::getSelectElemNpoints", + throw DataSpaceIException("DataSpace::getSelectElemNpoints", "H5Sget_select_elem_npoints failed"); } return( num_points ); @@ -412,7 +412,7 @@ void DataSpace::getSelectElemPointlist ( hsize_t startpoint, hsize_t numpoints, // Function: DataSpace::getSelectBounds ///\brief Gets the bounding box containing the current selection. ///\param start - IN: Starting coordinates of the bounding box -///\param end - IN: Ending coordinates of the bounding box, i.e., +///\param end - IN: Ending coordinates of the bounding box, i.e., /// the coordinates of the diagonally opposite corner ///\exception H5::DataSpaceIException ///\par Description @@ -433,12 +433,12 @@ void DataSpace::getSelectBounds ( hsize_t* start, hsize_t* end ) const //-------------------------------------------------------------------------- // Function: DataSpace::H5Sselect_elements -///\brief Selects array elements to be included in the selection for +///\brief Selects array elements to be included in the selection for /// this dataspace. -///\param op - IN: Operator specifying how the new selection is to be +///\param op - IN: Operator specifying how the new selection is to be /// combined with the existing selection for the dataspace ///\param num_elements - IN: Number of elements to be selected -///\param coord - IN: A 2-dimensional array of 0-based values +///\param coord - IN: A 2-dimensional array of 0-based values /// specifying the coordinates of the elements being selected ///\exception H5::DataSpaceIException ///\par Description @@ -493,7 +493,7 @@ void DataSpace::selectNone () const //-------------------------------------------------------------------------- // Function: DataSpace::selectValid -///\brief Verifies that the selection is within the extent of the +///\brief Verifies that the selection is within the extent of the /// dataspace. ///\return \c true if the selection is within the extent of the /// dataspace, and \c false, otherwise @@ -525,7 +525,7 @@ bool DataSpace::selectValid () const ///\exception H5::DataSpaceIException ///\par Description /// For more information, please refer to the C layer Reference -/// Manual at: +/// Manual at: /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5S.html#Dataspace-SelectHyperslab // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -572,10 +572,10 @@ void DataSpace::close() // ID reference counting mechanism - June 1, 2004 //-------------------------------------------------------------------------- DataSpace::~DataSpace() -{ +{ // If this object has a valid id, appropriately decrement reference // counter and close the id. - if( id != H5S_ALL ) { + if( id != H5S_ALL ) { try { decRefCount(); } @@ -583,7 +583,7 @@ DataSpace::~DataSpace() cerr << "DataSpace::~DataSpace - " << close_error.getDetailMsg() << endl; } } // if -} +} #ifndef H5_NO_NAMESPACE } // end namespace diff --git a/c++/src/H5DataSpace.h b/c++/src/H5DataSpace.h index 46c620e..3510a19 100644 --- a/c++/src/H5DataSpace.h +++ b/c++/src/H5DataSpace.h @@ -68,7 +68,7 @@ class H5_DLLCPP DataSpace : public IdComponent { int getSimpleExtentNdims() const; // Gets the number of elements in this dataspace. - // 12/05/00 - changed return type to hssize_t from hsize_t - C API + // 12/05/00 - changed return type to hssize_t from hsize_t - C API hssize_t getSimpleExtentNpoints() const; // Gets the current class of this dataspace. @@ -83,7 +83,7 @@ class H5_DLLCPP DataSpace : public IdComponent { // Selects the entire dataspace. void selectAll() const; - // Selects array elements to be included in the selection for + // Selects array elements to be included in the selection for // this dataspace. void selectElements( H5S_seloper_t op, const size_t num_elements, const hsize_t *coord[ ] ) const; diff --git a/c++/src/H5DataType.cpp b/c++/src/H5DataType.cpp index 28668a46..62dca0f 100644 --- a/c++/src/H5DataType.cpp +++ b/c++/src/H5DataType.cpp @@ -43,11 +43,11 @@ namespace H5 { ///\param predefined - IN: Indicates whether or not this datatype is /// a predefined datatype; default to \c false // Description -// Constructor creates a copy of an existing DataType using -// its id. The argument "predefined" is default to false; -// when a default datatype is created, this argument is set -// to true so H5Tclose will not be called on it later. - need -// a reassessment after changing to the new ref counting mech. +// Constructor creates a copy of an existing DataType using +// its id. The argument "predefined" is default to false; +// when a default datatype is created, this argument is set +// to true so H5Tclose will not be called on it later. - need +// a reassessment after changing to the new ref counting mech. // - BMR 5/2004 // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -125,8 +125,8 @@ void DataType::copy( const DataType& like_type ) ///\return Reference to DataType instance ///\exception H5::DataTypeIException // Description -// Makes a copy of the type on the right hand side and stores -// the new id in the left hand side object. +// Makes a copy of the type on the right hand side and stores +// the new id in the left hand side object. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- DataType& DataType::operator=( const DataType& rhs ) @@ -137,7 +137,7 @@ DataType& DataType::operator=( const DataType& rhs ) //-------------------------------------------------------------------------- // Function: DataType::operator== -///\brief Compares this DataType against the given one to determines +///\brief Compares this DataType against the given one to determines /// whether the two objects refer to the same actual datatype. ///\param compared_type - IN: Reference to the datatype to compare ///\return true if the datatypes are equal, and false, otherwise. @@ -146,7 +146,7 @@ DataType& DataType::operator=( const DataType& rhs ) //-------------------------------------------------------------------------- bool DataType::operator==(const DataType& compared_type ) const { - // Call C routine H5Tequal to determines whether two datatype + // Call C routine H5Tequal to determines whether two datatype // identifiers refer to the same datatype htri_t ret_value = H5Tequal( id, compared_type.getId() ); if( ret_value > 0 ) @@ -161,7 +161,7 @@ bool DataType::operator==(const DataType& compared_type ) const //-------------------------------------------------------------------------- // Function: DataType::commit -///\brief Commits a transient datatype to a file, creating a new +///\brief Commits a transient datatype to a file, creating a new /// named datatype ///\param loc - IN: Either a file or a group ///\param name - IN: Name of the datatype @@ -172,7 +172,7 @@ void DataType::commit(CommonFG& loc, const char* name) const { hid_t loc_id = loc.getLocId(); // get location id for C API - // Call C routine to commit the transient datatype + // Call C routine to commit the transient datatype herr_t ret_value = H5Tcommit( loc_id, name, id ); if( ret_value < 0 ) { @@ -183,7 +183,7 @@ void DataType::commit(CommonFG& loc, const char* name) const //-------------------------------------------------------------------------- // Function: DataType::commit ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of the +/// It differs from the above function only in the type of the /// argument \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -194,8 +194,8 @@ void DataType::commit(CommonFG& loc, const string& name) const //-------------------------------------------------------------------------- // Function: DataType::committed -///\brief Determines whether a datatype is a named type or a -/// transient type. +///\brief Determines whether a datatype is a named type or a +/// transient type. ///\return true if the datatype is a named type, and false, otherwise. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -216,11 +216,11 @@ bool DataType::committed() const //-------------------------------------------------------------------------- // Function: DataType::find -///\brief Finds a conversion function that can handle a conversion +///\brief Finds a conversion function that can handle a conversion /// from this datatype to the specified datatype, \a dest. ///\param dest - IN: Destination datatype ///\param pcdata - IN: Pointer to type conversion data -///\return Pointer to a suitable conversion function +///\return Pointer to a suitable conversion function ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -237,14 +237,14 @@ H5T_conv_t DataType::find( const DataType& dest, H5T_cdata_t **pcdata ) const //-------------------------------------------------------------------------- // Function: DataType::convert -///\brief Converts data from this datatype to the specified datatypes. +///\brief Converts data from this datatype to the specified datatypes. ///\param dest - IN: Destination datatype ///\param nelmts - IN: Size of array \a buf -///\param buf - IN/OUT: Array containing pre- and post-conversion +///\param buf - IN/OUT: Array containing pre- and post-conversion /// values ///\param background - IN: Optional backgroud buffer ///\param plist - IN: Dataset transfer property list -///\return Pointer to a suitable conversion function +///\return Pointer to a suitable conversion function ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -269,8 +269,8 @@ void DataType::convert( const DataType& dest, size_t nelmts, void *buf, void *ba /// ///\exception H5::DataTypeIException ///\par Descrition -/// This is normally done by the library for predefined data -/// types so the application doesn't inadvertently change or +/// This is normally done by the library for predefined data +/// types so the application doesn't inadvertently change or /// delete a predefined type. /// /// Once a data type is locked it can never be unlocked unless @@ -289,7 +289,7 @@ void DataType::lock() const //-------------------------------------------------------------------------- // Function: DataType::getClass -///\brief Returns the datatype class identifier. +///\brief Returns the datatype class identifier. ///\return Datatype class identifier ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -308,7 +308,7 @@ H5T_class_t DataType::getClass() const //-------------------------------------------------------------------------- // Function: DataType::getSize -///\brief Returns the size of a datatype. +///\brief Returns the size of a datatype. ///\return Datatype size in bytes ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -326,7 +326,7 @@ size_t DataType::getSize() const //-------------------------------------------------------------------------- // Function: DataType::getSuper -///\brief Returns the base datatype from which a datatype is derived. +///\brief Returns the base datatype from which a datatype is derived. ///\return DataType object ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -334,7 +334,7 @@ size_t DataType::getSize() const DataType DataType::getSuper() const { // Call C routine to get the base datatype from which the specified - // datatype is derived. + // datatype is derived. hid_t base_type_id = H5Tget_super( id ); // If H5Tget_super returns a valid datatype id, create and return @@ -352,14 +352,14 @@ DataType DataType::getSuper() const //-------------------------------------------------------------------------- // Function: DataType::registerFunc -///\brief Registers the specified conversion function. +///\brief Registers the specified conversion function. ///\param pers - IN: Conversion option /// \li \c H5T_PERS_HARD for hard conversion functions -/// \li \c H5T_PERS_SOFT for soft conversion functions. -///\param name - IN: Name displayed in diagnostic output. +/// \li \c H5T_PERS_SOFT for soft conversion functions. +///\param name - IN: Name displayed in diagnostic output. ///\param dest - IN: Destination datatype. -///\param func - IN: Function to convert between source and -/// destination datatypes. +///\param func - IN: Function to convert between source and +/// destination datatypes. ///\exception H5::DataTypeIException ///\par Description /// For more information, please see: @@ -381,7 +381,7 @@ void DataType::registerFunc( H5T_pers_t pers, const char* name, const DataType& //-------------------------------------------------------------------------- // Function: DataType::registerFunc ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of the +/// It differs from the above function only in the type of the /// argument \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -392,14 +392,14 @@ void DataType::registerFunc( H5T_pers_t pers, const string& name, const DataType //-------------------------------------------------------------------------- // Function: DataType::unregister -///\brief Removes a conversion function from all conversion paths. +///\brief Removes a conversion function from all conversion paths. ///\param pers - IN: Conversion option /// \li \c H5T_PERS_HARD for hard conversion functions -/// \li \c H5T_PERS_SOFT for soft conversion functions. -///\param name - IN: Name displayed in diagnostic output. +/// \li \c H5T_PERS_SOFT for soft conversion functions. +///\param name - IN: Name displayed in diagnostic output. ///\param dest - IN: Destination datatype. -///\param func - IN: Function to convert between source and -/// destination datatypes. +///\param func - IN: Function to convert between source and +/// destination datatypes. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -407,7 +407,7 @@ void DataType::unregister( H5T_pers_t pers, const char* name, const DataType& de { hid_t dest_id = dest.getId(); // get id of the dest datatype for C API - // Call C routine H5Tunregister to remove the conversion function + // Call C routine H5Tunregister to remove the conversion function herr_t ret_value = H5Tunregister( pers, name, id, dest_id, func ); if( ret_value < 0 ) { @@ -418,7 +418,7 @@ void DataType::unregister( H5T_pers_t pers, const char* name, const DataType& de //-------------------------------------------------------------------------- // Function: DataType::unregister ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of the +/// It differs from the above function only in the type of the /// argument \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -429,15 +429,15 @@ void DataType::unregister( H5T_pers_t pers, const string& name, const DataType& //-------------------------------------------------------------------------- // Function: DataType::setTag -///\brief Tags an opaque datatype. -///\param tag - IN: Descriptive ASCII string with which the opaque -/// datatype is to be tagged. +///\brief Tags an opaque datatype. +///\param tag - IN: Descriptive ASCII string with which the opaque +/// datatype is to be tagged. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void DataType::setTag( const char* tag ) const { - // Call C routine H5Tset_tag to tag an opaque datatype. + // Call C routine H5Tset_tag to tag an opaque datatype. herr_t ret_value = H5Tset_tag( id, tag ); if( ret_value < 0 ) { @@ -448,7 +448,7 @@ void DataType::setTag( const char* tag ) const //-------------------------------------------------------------------------- // Function: DataType::setTag ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of the +/// It differs from the above function only in the type of the /// argument \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -459,7 +459,7 @@ void DataType::setTag( const string& tag ) const //-------------------------------------------------------------------------- // Function: DataType::getTag -///\brief Gets the tag associated with an opaque datatype. +///\brief Gets the tag associated with an opaque datatype. ///\return Tag associated with the opaque datatype ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -473,8 +473,8 @@ string DataType::getTag() const if( tag_Cstr != NULL ) { string tag = string(tag_Cstr); // convert C string to string object - HDfree(tag_Cstr); // free the C string - return (tag); // return the tag + HDfree(tag_Cstr); // free the C string + return (tag); // return the tag } else { @@ -486,7 +486,7 @@ string DataType::getTag() const // Function: DataType::detectClass ///\brief Checks whether a datatype contains (or is) a certain type of /// datatype. -///\return true if this datatype contains or is the specified type, +///\return true if this datatype contains or is the specified type, /// and false, otherwise. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May, 2004 @@ -507,7 +507,7 @@ bool DataType::detectClass(H5T_class_t cls) const //-------------------------------------------------------------------------- // Function: DataType::isVariableStr ///\brief Check whether this datatype is a variable-length string. -///\return true if this datatype is a variable-length string, and +///\return true if this datatype is a variable-length string, and /// false, otherwise. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May, 2004 @@ -554,7 +554,7 @@ void* DataType::Reference(const char* name, DataSpace& dataspace, H5R_type_t ref ///\return A reference ///\exception H5::DataTypeIException ///\par Description -// This function passes H5R_OBJECT and -1 to the protected +// This function passes H5R_OBJECT and -1 to the protected // function for it to pass to the C API H5Rcreate // to create a reference to the named object. // Programmer Binh-Minh Ribler - May, 2004 @@ -589,10 +589,10 @@ void* DataType::Reference(const string& name) const ///\param ref - IN: Reference to query ///\param ref_type - IN: Type of reference to query ///\return Object type, which can be one of the following: -/// \li \c H5G_LINK Object is a symbolic link. -/// \li \c H5G_GROUP Object is a group. -/// \li \c H5G_DATASET Object is a dataset. -/// \li \c H5G_TYPE Object is a named datatype +/// \li \c H5G_LINK Object is a symbolic link. +/// \li \c H5G_GROUP Object is a group. +/// \li \c H5G_DATASET Object is a dataset. +/// \li \c H5G_TYPE Object is a named datatype ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- @@ -659,7 +659,7 @@ void DataType::close() // ID reference counting mechanism - June 1, 2004 //-------------------------------------------------------------------------- DataType::~DataType() -{ +{ // The datatype id will be closed properly if( is_predtype == false ) { try { @@ -669,7 +669,7 @@ DataType::~DataType() cerr << inMemFunc("~DataType - ") << close_error.getDetailMsg() << endl; } } -} +} #ifndef H5_NO_NAMESPACE } // end namespace diff --git a/c++/src/H5DataType.h b/c++/src/H5DataType.h index c135845..d685e9d 100644 --- a/c++/src/H5DataType.h +++ b/c++/src/H5DataType.h @@ -34,23 +34,23 @@ class H5_DLLCPP DataType : public H5Object { // Copies an existing datatype to this datatype object void copy( const DataType& like_type ); - // Returns the datatype class identifier. + // Returns the datatype class identifier. H5T_class_t getClass() const; - // Commits a transient datatype to a file; this datatype becomes + // Commits a transient datatype to a file; this datatype becomes // a named datatype which can be accessed from the location. void commit( CommonFG& loc, const string& name ) const; void commit( CommonFG& loc, const char* name ) const; - // Determines whether this datatype is a named datatype or - // a transient datatype. + // Determines whether this datatype is a named datatype or + // a transient datatype. bool committed() const; - // Finds a conversion function that can handle the conversion + // Finds a conversion function that can handle the conversion // this datatype to the given datatype, dest. H5T_conv_t find( const DataType& dest, H5T_cdata_t **pcdata ) const; - // Converts data from between specified datatypes. + // Converts data from between specified datatypes. void convert( const DataType& dest, size_t nelmts, void *buf, void *background, PropList& plist ) const; // Assignment operator @@ -59,29 +59,29 @@ class H5_DLLCPP DataType : public H5Object { // Determines whether two datatypes are the same. bool operator==(const DataType& compared_type ) const; - // Locks a datatype. + // Locks a datatype. void lock() const; - // Returns the size of a datatype. + // Returns the size of a datatype. size_t getSize() const; - // Returns the base datatype from which a datatype is derived. + // Returns the base datatype from which a datatype is derived. // Note: not quite right for specific types yet??? DataType getSuper() const; - // Registers a conversion function. + // Registers a conversion function. void registerFunc(H5T_pers_t pers, const string& name, const DataType& dest, H5T_conv_t func ) const; void registerFunc(H5T_pers_t pers, const char* name, const DataType& dest, H5T_conv_t func ) const; - // Removes a conversion function from all conversion paths. + // Removes a conversion function from all conversion paths. void unregister( H5T_pers_t pers, const string& name, const DataType& dest, H5T_conv_t func ) const; void unregister( H5T_pers_t pers, const char* name, const DataType& dest, H5T_conv_t func ) const; - // Tags an opaque datatype. + // Tags an opaque datatype. void setTag( const string& tag ) const; void setTag( const char* tag ) const; - // Gets the tag associated with an opaque datatype. + // Gets the tag associated with an opaque datatype. string getTag() const; // Checks whether this datatype contains (or is) a certain type class. @@ -106,7 +106,7 @@ class H5_DLLCPP DataType : public H5Object { virtual string fromClass () const { return ("DataType"); } - // Creates a copy of an existing DataType using its id + // Creates a copy of an existing DataType using its id DataType( const hid_t type_id, bool predtype = false ); // Default constructor diff --git a/c++/src/H5DcreatProp.cpp b/c++/src/H5DcreatProp.cpp index 9ecc9a3..74bb19e 100644 --- a/c++/src/H5DcreatProp.cpp +++ b/c++/src/H5DcreatProp.cpp @@ -49,7 +49,7 @@ DSetCreatPropList::DSetCreatPropList( const DSetCreatPropList& orig ) : PropList //-------------------------------------------------------------------------- // Function: DSetCreatPropList overloaded constructor -///\brief Creates a DSetCreatPropList object using the id of an +///\brief Creates a DSetCreatPropList object using the id of an /// existing dataset creation property list. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -93,7 +93,7 @@ int DSetCreatPropList::getChunk( int max_ndims, hsize_t* dim ) const int chunk_size = H5Pget_chunk( id, max_ndims, dim ); if( chunk_size < 0 ) { - throw PropListIException("DSetCreatPropList::getChunk", + throw PropListIException("DSetCreatPropList::getChunk", "H5Pget_chunk returns negative chunk size"); } return( chunk_size ); @@ -140,7 +140,7 @@ H5D_layout_t DSetCreatPropList::getLayout() const H5D_layout_t layout = H5Pget_layout( id ); if( layout == H5D_LAYOUT_ERROR ) { - throw PropListIException("DSetCreatPropList::getLayout", + throw PropListIException("DSetCreatPropList::getLayout", "H5Pget_layout returns H5D_LAYOUT_ERROR"); } return( layout ); @@ -314,10 +314,10 @@ int DSetCreatPropList::getNfilters() const //-------------------------------------------------------------------------- // Function: DSetCreatPropList::getFilter ///\brief Returns information about a filter in a pipeline -///\param filter_number - IN: Filter to get, range [0..N-1], where +///\param filter_number - IN: Filter to get, range [0..N-1], where /// N is returned by H5Pget_nfilters() ///\param flags - OUT: General properties of the filter -///\param cd_nelmts - IN/OUT: Number of elements in \a cd_values /Number +///\param cd_nelmts - IN/OUT: Number of elements in \a cd_values /Number /// of values defined by the filter ///\param cd_values - OUT: Array to hold the data; allocated by the user ///\param namelen - OUT: Length of \a name @@ -333,7 +333,7 @@ H5Z_filter_t DSetCreatPropList::getFilter(int filter_number, unsigned int &flags unsigned int& filter_config) const { H5Z_filter_t filter_id; - filter_id = H5Pget_filter( id, filter_number, &flags, &cd_nelmts, + filter_id = H5Pget_filter( id, filter_number, &flags, &cd_nelmts, cd_values, namelen, name, &filter_config); if( filter_id == H5Z_FILTER_ERROR ) { @@ -350,7 +350,7 @@ H5Z_filter_t DSetCreatPropList::getFilter(int filter_number, unsigned int &flags /// filter id ///\param filter_id - IN: Filter to get ///\param flags - OUT: General properties of the filter -///\param cd_nelmts - IN/OUT: Number of elements in \a cd_values /Number +///\param cd_nelmts - IN/OUT: Number of elements in \a cd_values /Number /// of values defined by the filter ///\param cd_values - OUT: Array to hold the data; allocated by the user ///\param namelen - IN: Length of \a name @@ -363,7 +363,7 @@ void DSetCreatPropList::getFilterById(H5Z_filter_t filter_id, unsigned int &flag unsigned int* cd_values, size_t namelen, char name[], unsigned int &filter_config) const { - herr_t ret_value = H5Pget_filter_by_id(id, filter_id, &flags, &cd_nelmts, + herr_t ret_value = H5Pget_filter_by_id(id, filter_id, &flags, &cd_nelmts, cd_values, namelen, name, &filter_config ); if (ret_value < 0) { diff --git a/c++/src/H5DcreatProp.h b/c++/src/H5DcreatProp.h index fabadc6..b040abf 100644 --- a/c++/src/H5DcreatProp.h +++ b/c++/src/H5DcreatProp.h @@ -21,11 +21,11 @@ namespace H5 { #endif class H5_DLLCPP DSetCreatPropList : public PropList { - public: + public: // Default dataset creation property list. static const DSetCreatPropList DEFAULT; - // Queries whether all the filters set in this property list are + // Queries whether all the filters set in this property list are // available currently. bool allFiltersAvail(); @@ -69,7 +69,7 @@ class H5_DLLCPP DSetCreatPropList : public PropList { // property list. H5D_layout_t getLayout() const; - // Sets the type of storage used to store the raw data for the + // Sets the type of storage used to store the raw data for the // dataset that uses this property list. void setLayout(H5D_layout_t layout) const; @@ -109,7 +109,7 @@ class H5_DLLCPP DSetCreatPropList : public PropList { // Copy constructor: creates a copy of a DSetCreatPropList object. DSetCreatPropList(const DSetCreatPropList& orig); - // Creates a copy of an existing dataset creation property list + // Creates a copy of an existing dataset creation property list // using the property list id. DSetCreatPropList(const hid_t plist_id); diff --git a/c++/src/H5DxferProp.cpp b/c++/src/H5DxferProp.cpp index 379e02e..d6d279d 100644 --- a/c++/src/H5DxferProp.cpp +++ b/c++/src/H5DxferProp.cpp @@ -41,7 +41,7 @@ DSetMemXferPropList::DSetMemXferPropList() : PropList(H5P_DATASET_XFER) {} // Function DSetMemXferPropList copy constructor ///\brief Copy constructor: makes a copy of the original /// DSetMemXferPropList object -///\param orig - IN: The original dataset memory and transfer property +///\param orig - IN: The original dataset memory and transfer property /// list object to copy // Programmer: Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -222,7 +222,7 @@ void DSetMemXferPropList::getTypeConvCB( H5T_conv_except_func_t *op, void **user //-------------------------------------------------------------------------- void DSetMemXferPropList::setVlenMemManager( H5MM_allocate_t alloc_func, void* alloc_info, H5MM_free_t free_func, void* free_info ) const { - herr_t ret_value = H5Pset_vlen_mem_manager( id, alloc_func, alloc_info, + herr_t ret_value = H5Pset_vlen_mem_manager( id, alloc_func, alloc_info, free_func, free_info ); if( ret_value < 0 ) { @@ -233,7 +233,7 @@ void DSetMemXferPropList::setVlenMemManager( H5MM_allocate_t alloc_func, void* a //-------------------------------------------------------------------------- // Function: DSetMemXferPropList::setVlenMemManager -///\brief Sets the memory manager for variable-length datatype +///\brief Sets the memory manager for variable-length datatype /// allocation - system \c malloc and \c free will be used. /// ///\exception H5::PropListIException @@ -246,7 +246,7 @@ void DSetMemXferPropList::setVlenMemManager() const //-------------------------------------------------------------------------- // Function: DSetMemXferPropList::getVlenMemManager -///\brief Gets the memory manager for variable-length datatype allocation +///\brief Gets the memory manager for variable-length datatype allocation ///\param alloc_func - OUT: User's allocate routine ///\param alloc_info - OUT: User's allocation parameters ///\param free_func - OUT: User's free routine @@ -270,7 +270,7 @@ void DSetMemXferPropList::getVlenMemManager( H5MM_allocate_t& alloc_func, void** ///\param memb_dxpl - OUT: Array of data access property lists ///\exception H5::PropListIException ///\par Description -/// This function can only be used after the member map has +/// This function can only be used after the member map has /// been set with FileAccPropList::setMulti (not done - BMR.) // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- @@ -304,7 +304,7 @@ void DSetMemXferPropList::getMulti(hid_t *memb_dxpl) //-------------------------------------------------------------------------- // Function: DSetMemXferPropList::setSmallDataBlockSize ///\brief Sets the size of a contiguous block reserved for small data. -///\param size - IN: Maximum size, in bytes, of the small data block. +///\param size - IN: Maximum size, in bytes, of the small data block. ///\exception H5::PropListIException ///\par Description /// For detail, please refer to the C layer Reference Manual at: @@ -363,7 +363,7 @@ void DSetMemXferPropList::setHyperVectorSize(size_t vector_size) //-------------------------------------------------------------------------- // Function: DSetMemXferPropList::getSmallDataBlockSize -///\brief Returns the number of I/O vectors to be read/written in +///\brief Returns the number of I/O vectors to be read/written in /// hyperslab I/O. ///\return Number of I/O vectors ///\exception H5::PropListIException @@ -389,14 +389,14 @@ size_t DSetMemXferPropList::getHyperVectorSize() /// disabled ///\exception H5::PropListIException ///\par Description -/// The error detection algorithm used is the algorithm previously -/// specified in the corresponding dataset creation property -/// list. This function does not affect the use of error +/// The error detection algorithm used is the algorithm previously +/// specified in the corresponding dataset creation property +/// list. This function does not affect the use of error /// detection in the writing process. ///\par /// Valid values are as follows: -/// \li \c H5Z_ENABLE_EDC (default) -/// \li \c H5Z_DISABLE_EDC +/// \li \c H5Z_ENABLE_EDC (default) +/// \li \c H5Z_DISABLE_EDC // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- void DSetMemXferPropList::setEDCCheck(H5Z_EDC_t check) diff --git a/c++/src/H5DxferProp.h b/c++/src/H5DxferProp.h index 2d00a5b..30dfc73 100644 --- a/c++/src/H5DxferProp.h +++ b/c++/src/H5DxferProp.h @@ -42,7 +42,7 @@ class H5_DLLCPP DSetMemXferPropList : public PropList { // Checks status of the dataset transfer property list bool getPreserve() const; - // Sets B-tree split ratios for a dataset transfer property list + // Sets B-tree split ratios for a dataset transfer property list void setBtreeRatios( double left, double middle, double right ) const; // Gets B-tree split ratios for a dataset transfer property list @@ -54,18 +54,18 @@ class H5_DLLCPP DSetMemXferPropList : public PropList { // Gets the exception handling callback for datatype conversion void getTypeConvCB( H5T_conv_except_func_t *op, void **user_data) const; - // Sets the memory manager for variable-length datatype + // Sets the memory manager for variable-length datatype // allocation in H5Dread and H5Dvlen_reclaim - void setVlenMemManager( H5MM_allocate_t alloc, void* alloc_info, + void setVlenMemManager( H5MM_allocate_t alloc, void* alloc_info, H5MM_free_t free, void* free_info ) const; - // alloc and free are set to NULL, indicating that system + // alloc and free are set to NULL, indicating that system // malloc and free are to be used void setVlenMemManager() const; - // Gets the memory manager for variable-length datatype + // Gets the memory manager for variable-length datatype // allocation in H5Dread and H5Tvlen_reclaim - void getVlenMemManager( H5MM_allocate_t& alloc, void** alloc_info, + void getVlenMemManager( H5MM_allocate_t& alloc, void** alloc_info, H5MM_free_t& free, void** free_info ) const; // Sets the data transfer property list for the multi-file driver. @@ -97,7 +97,7 @@ class H5_DLLCPP DSetMemXferPropList : public PropList { // Returns this class name virtual string fromClass () const { return ("DSetMemXferPropList"); } - // Creates a copy of an existing dataset memory and transfer + // Creates a copy of an existing dataset memory and transfer // property list using the property list id. DSetMemXferPropList (const hid_t plist_id); diff --git a/c++/src/H5EnumType.cpp b/c++/src/H5EnumType.cpp index abd9c51..14ba706 100644 --- a/c++/src/H5EnumType.cpp +++ b/c++/src/H5EnumType.cpp @@ -117,7 +117,7 @@ EnumType::EnumType( const IntType& data_type ) : DataType() //-------------------------------------------------------------------------- void EnumType::insert( const char* name, void *value ) const { - // Calls C routine H5Tenum_insert to insert the new enum datatype member. + // Calls C routine H5Tenum_insert to insert the new enum datatype member. herr_t ret_value = H5Tenum_insert( id, name, value ); if( ret_value < 0 ) { @@ -128,7 +128,7 @@ void EnumType::insert( const char* name, void *value ) const //-------------------------------------------------------------------------- // Function: EnumType::insert ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of +/// It differs from the above function only in the type of /// argument \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -139,8 +139,8 @@ void EnumType::insert( const string& name, void *value ) const //-------------------------------------------------------------------------- // Function: EnumType::nameOf -///\brief Returns the symbol name corresponding to a specified member -/// of this enumeration datatype. +///\brief Returns the symbol name corresponding to a specified member +/// of this enumeration datatype. ///\param value - IN: Pointer to the value of the enum datatype ///\param size - IN: Size for the name ///\exception H5::DataTypeIException @@ -166,8 +166,8 @@ string EnumType::nameOf( void *value, size_t size ) const //-------------------------------------------------------------------------- // Function: EnumType::valueOf -///\brief Retrieves the value corresponding to a member of this -/// enumeration datatype, given the member's name. +///\brief Retrieves the value corresponding to a member of this +/// enumeration datatype, given the member's name. ///\param name - IN: Name of the queried member ///\param value - OUT: Pointer to the retrieved value ///\exception H5::DataTypeIException @@ -186,7 +186,7 @@ void EnumType::valueOf( const char* name, void *value ) const //-------------------------------------------------------------------------- // Function: EnumType::valueOf ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of +/// It differs from the above function only in the type of /// argument \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -200,7 +200,7 @@ void EnumType::valueOf( const string& name, void *value ) const ///\brief Returns the index of a member in this enumeration datatype. ///\param name - IN: Name of the queried member ///\return Index of the member if it exists. Index will have the value -/// between 0 and \c N-1, where \c N is the value returned by the +/// between 0 and \c N-1, where \c N is the value returned by the /// member function \c EnumType::getNmembers. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - May 16, 2002 @@ -219,7 +219,7 @@ int EnumType::getMemberIndex(const char *name) const //-------------------------------------------------------------------------- // Function: EnumType::getMemberIndex ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in the type of +/// It differs from the above function only in the type of /// argument \a name. // Programmer Binh-Minh Ribler - May 16, 2002 //-------------------------------------------------------------------------- @@ -248,7 +248,7 @@ int EnumType::getNmembers() const //-------------------------------------------------------------------------- // Function: EnumType::getMemberValue -///\brief Retrieves the value of a member in this enumeration datatype, +///\brief Retrieves the value of a member in this enumeration datatype, /// given the member's index. ///\param memb_no - IN: Index of the queried member ///\param value - OUT: Pointer to the retrieved value diff --git a/c++/src/H5EnumType.h b/c++/src/H5EnumType.h index 0313acb..58199db 100644 --- a/c++/src/H5EnumType.h +++ b/c++/src/H5EnumType.h @@ -23,7 +23,7 @@ namespace H5 { class H5_DLLCPP EnumType : public DataType { public: - // Creates an empty enumeration datatype based on a native signed + // Creates an empty enumeration datatype based on a native signed // integer type, whose size is given by size. EnumType( size_t size ); @@ -43,16 +43,16 @@ class H5_DLLCPP EnumType : public DataType { // Returns the value of an enumeration datatype member void getMemberValue( unsigned memb_no, void *value ) const; - // Inserts a new member to this enumeration type. + // Inserts a new member to this enumeration type. void insert( const char* name, void *value ) const; void insert( const string& name, void *value ) const; - // Returns the symbol name corresponding to a specified member - // of this enumeration datatype. + // Returns the symbol name corresponding to a specified member + // of this enumeration datatype. string nameOf( void *value, size_t size ) const; - // Returns the value corresponding to a specified member of this - // enumeration datatype. + // Returns the value corresponding to a specified member of this + // enumeration datatype. void valueOf( const char* name, void *value ) const; void valueOf( const string& name, void *value ) const; diff --git a/c++/src/H5Exception.cpp b/c++/src/H5Exception.cpp index 37d0da5..074d734 100644 --- a/c++/src/H5Exception.cpp +++ b/c++/src/H5Exception.cpp @@ -33,7 +33,7 @@ Exception::Exception() : detail_message(""), func_name("") {} //-------------------------------------------------------------------------- // Function: Exception overloaded constructor -///\brief Creates an exception with the name of the function, +///\brief Creates an exception with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -71,7 +71,7 @@ string Exception::getMajorString( hid_t err_major ) const // If H5Eget_msg() returns a negative value, raise an exception, if( mesg_size < 0 ) - throw IdComponentException("Exception::getMajorString", + throw IdComponentException("Exception::getMajorString", "H5Eget_msg failed"); // Call H5Eget_msg again to get the actual message @@ -80,7 +80,7 @@ string Exception::getMajorString( hid_t err_major ) const // Check for failure again if( mesg_size < 0 ) - throw IdComponentException("Exception::getMajorString", + throw IdComponentException("Exception::getMajorString", "H5Eget_msg failed"); // Convert the C error description and return @@ -107,7 +107,7 @@ string Exception::getMinorString( hid_t err_minor ) const // If H5Eget_msg() returns a negative value, raise an exception, if( mesg_size < 0 ) - throw IdComponentException("Exception::getMinorString", + throw IdComponentException("Exception::getMinorString", "H5Eget_msg failed"); // Call H5Eget_msg again to get the actual message @@ -116,7 +116,7 @@ string Exception::getMinorString( hid_t err_minor ) const // Check for failure again if( mesg_size < 0 ) - throw IdComponentException("Exception::getMinorString", + throw IdComponentException("Exception::getMinorString", "H5Eget_msg failed"); // Convert the C error description and return @@ -132,7 +132,7 @@ string Exception::getMinorString( hid_t err_minor ) const ///\param client_data - IN: Data passed to the error function ///\par Description /// When the library is first initialized the auto printing -/// function, \a func, is set to the C API \c H5Eprint and +/// function, \a func, is set to the C API \c H5Eprint and /// \a client_data is the standard error stream pointer, \c stderr. /// Automatic stack traversal is always in the \c H5E_WALK_DOWNWARD /// direction. @@ -168,16 +168,16 @@ void Exception::dontPrint() // Function: Exception::getAutoPrint ///\brief Retrieves the current settings for the automatic error /// stack traversal function and its data. -///\param func - OUT: Current setting for the function to be +///\param func - OUT: Current setting for the function to be /// called upon an error condition -///\param client_data - OUT: Current setting for the data passed to +///\param client_data - OUT: Current setting for the data passed to /// the error function // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void Exception::getAutoPrint( H5E_auto_stack_t& func, void** client_data ) { // calls the C API routine H5Eget_auto to get the current setting of - // the automatic error printing + // the automatic error printing herr_t ret_value = H5Eget_auto_stack( H5E_DEFAULT, &func, client_data ); if( ret_value < 0 ) throw Exception( "Exception::getAutoPrint", "H5Eget_auto failed" ); @@ -325,7 +325,7 @@ Exception::~Exception() {} FileIException::FileIException():Exception(){} //-------------------------------------------------------------------------- // Function: FileIException overloaded constructor -///\brief Creates a FileIException with the name of the function, +///\brief Creates a FileIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -348,7 +348,7 @@ FileIException::~FileIException() {} GroupIException::GroupIException():Exception(){} //-------------------------------------------------------------------------- // Function: GroupIException overloaded constructor -///\brief Creates a GroupIException with the name of the function, +///\brief Creates a GroupIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -371,7 +371,7 @@ GroupIException::~GroupIException() {} DataSpaceIException::DataSpaceIException():Exception(){} //-------------------------------------------------------------------------- // Function: DataSpaceIException overloaded constructor -///\brief Creates a DataSpaceIException with the name of the function, +///\brief Creates a DataSpaceIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -394,7 +394,7 @@ DataSpaceIException::~DataSpaceIException() {} DataTypeIException::DataTypeIException():Exception(){} //-------------------------------------------------------------------------- // Function: DataTypeIException overloaded constructor -///\brief Creates a DataTypeIException with the name of the function, +///\brief Creates a DataTypeIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -417,7 +417,7 @@ DataTypeIException::~DataTypeIException() {} PropListIException::PropListIException():Exception(){} //-------------------------------------------------------------------------- // Function: PropListIException overloaded constructor -///\brief Creates a PropListIException with the name of the function, +///\brief Creates a PropListIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -440,7 +440,7 @@ PropListIException::~PropListIException() {} DataSetIException::DataSetIException():Exception(){} //-------------------------------------------------------------------------- // Function: DataSetIException overloaded constructor -///\brief Creates a DataSetIException with the name of the function, +///\brief Creates a DataSetIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -463,7 +463,7 @@ DataSetIException::~DataSetIException() {} AttributeIException::AttributeIException():Exception(){} //-------------------------------------------------------------------------- // Function: AttributeIException overloaded constructor -///\brief Creates an AttributeIException with the name of the function, +///\brief Creates an AttributeIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -486,7 +486,7 @@ AttributeIException::~AttributeIException() {} ReferenceException::ReferenceException():Exception(){} //-------------------------------------------------------------------------- // Function: ReferenceException overloaded constructor -///\brief Creates a ReferenceException with the name of the function, +///\brief Creates a ReferenceException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -509,7 +509,7 @@ ReferenceException::~ReferenceException() {} LibraryIException::LibraryIException():Exception(){} //-------------------------------------------------------------------------- // Function: LibraryIException overloaded constructor -///\brief Creates a LibraryIException with the name of the function, +///\brief Creates a LibraryIException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure @@ -532,7 +532,7 @@ LibraryIException::~LibraryIException() {} IdComponentException::IdComponentException(): Exception() {} //-------------------------------------------------------------------------- // Function: IdComponentException overloaded constructor -///\brief Creates a IdComponentException with the name of the function, +///\brief Creates a IdComponentException with the name of the function, /// in which the failure occurs, and an optional detailed message. ///\param func_name - IN: Name of the function where failure occurs ///\param message - IN: Message on the failure diff --git a/c++/src/H5Exception.h b/c++/src/H5Exception.h index 4a5bf37..41a6e24 100644 --- a/c++/src/H5Exception.h +++ b/c++/src/H5Exception.h @@ -43,7 +43,7 @@ class H5_DLLCPP Exception { string getDetailMsg() const; const char* getCDetailMsg() const; // C string of detailed message string getFuncName() const; // function name as a string object - const char* getCFuncName() const; // function name as a char string + const char* getCFuncName() const; // function name as a char string // Turns on the automatic error printing. static void setAutoPrint( H5E_auto_stack_t& func, void* client_data); @@ -51,16 +51,16 @@ class H5_DLLCPP Exception { // Turns off the automatic error printing. static void dontPrint(); - // Retrieves the current settings for the automatic error stack + // Retrieves the current settings for the automatic error stack // traversal function and its data. static void getAutoPrint( H5E_auto_stack_t& func, void** client_data); // Clears the error stack for the current thread. static void clearErrorStack(); - // Walks the error stack for the current thread, calling the + // Walks the error stack for the current thread, calling the // specified function. - static void walkErrorStack( H5E_direction_t direction, + static void walkErrorStack( H5E_direction_t direction, H5E_walk_t func, void* client_data); // Prints the error stack in a default manner. @@ -77,7 +77,7 @@ class H5_DLLCPP Exception { private: // Because 'string' is not instantiated at compilation time, this -// warning is displayed when building DLL; but the class is exported +// warning is displayed when building DLL; but the class is exported // so the warning is harmless #if defined(WIN32) #pragma warning(disable: 4251) diff --git a/c++/src/H5FaccProp.cpp b/c++/src/H5FaccProp.cpp index 7e96bc0..4dede63 100644 --- a/c++/src/H5FaccProp.cpp +++ b/c++/src/H5FaccProp.cpp @@ -71,7 +71,7 @@ void FileAccPropList::setStdio() const //-------------------------------------------------------------------------- // Function: FileAccPropList::getDriver ///\brief Return the ID of the low-level file driver. -///\return A low-level driver ID which is the same ID used when the +///\return A low-level driver ID which is the same ID used when the /// driver was set for the property list. The driver ID is /// only valid as long as the file driver remains registered. /// Valid driver identifiers can be found at: @@ -96,7 +96,7 @@ hid_t FileAccPropList::getDriver() const ///\param new_driver_info - IN: Struct containing the driver-specific properites ///\exception H5::PropListIException ///\par Description -/// For a list of valid driver identifiers, please see the C +/// For a list of valid driver identifiers, please see the C /// layer Reference Manual at: /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-GetDriver // Programmer: Binh-Minh Ribler - April, 2004 @@ -148,13 +148,13 @@ hsize_t FileAccPropList::getFamilyOffset() const // Function: FileAccPropList::setCore ///\brief Modifies this file access property list to use the \c H5FD_CORE /// driver. -///\param increment - IN: Specifies how much memory to increase each +///\param increment - IN: Specifies how much memory to increase each /// time more memory is needed, in bytes -///\param backing_store - IN: Indicating whether to write the file +///\param backing_store - IN: Indicating whether to write the file /// contents to disk when the file is closed ///\exception H5::PropListIException ///\par Description -/// For more details on the use of \c H5FD_CORE driver, please +/// For more details on the use of \c H5FD_CORE driver, please /// refer to /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetFaplCore // Programmer: Binh-Minh Ribler - April, 2004 @@ -172,7 +172,7 @@ void FileAccPropList::setCore (size_t increment, hbool_t backing_store) const // Function: FileAccPropList::getCore ///\brief Queries core file driver properties. ///\param increment - OUT: Size of memory increment, in bytes -///\param backing_store - OUT: Indicating whether to write the file +///\param backing_store - OUT: Indicating whether to write the file /// contents to disk when the file is closed ///\exception H5::PropListIException // Programmer: Binh-Minh Ribler - April, 2004 @@ -251,7 +251,7 @@ FileAccPropList FileAccPropList::getFamily(hsize_t& memb_size) const //-------------------------------------------------------------------------- // Function: FileAccPropList::setSplit -///\brief Emulates the old split file driver, which stored meta data +///\brief Emulates the old split file driver, which stored meta data /// in one file and raw data in another file. ///\param meta_plist - IN: File access plist for the metadata file ///\param raw_plist - IN: File access plist for the raw data file @@ -374,7 +374,7 @@ void FileAccPropList::setSieveBufSize(size_t bufsize) const //-------------------------------------------------------------------------- // Function: FileAccPropList::setMetaBlockSize ///\brief Sets the minimum size of metadata block allocations. -///\param block_size - IN: Minimum size, in bytes, of metadata +///\param block_size - IN: Minimum size, in bytes, of metadata /// block allocations ///\exception H5::PropListIException ///\par Description @@ -470,9 +470,9 @@ void FileAccPropList::setSec2() const ///\param alignment - IN: Alignment value ///\exception H5::PropListIException ///\par Description -/// The parameter \a threshold must have a non-negative value. -/// Note that setting the threshold value to 0 (zero) has the -/// effect of a special case, forcing everything to be aligned. +/// The parameter \a threshold must have a non-negative value. +/// Note that setting the threshold value to 0 (zero) has the +/// effect of a special case, forcing everything to be aligned. /// The parameter \a alignment must have a positive value. /// /// For detail on \a setting alignment, please refer to @@ -490,7 +490,7 @@ void FileAccPropList::setAlignment( hsize_t threshold, hsize_t alignment ) const //-------------------------------------------------------------------------- // Function: FileAccPropList::getAlignment -///\brief Returns the current settings for alignment properties from +///\brief Returns the current settings for alignment properties from /// this property list. ///\param threshold - OUT: Retrieved threshold value for file object size ///\param alignment - OUT: Retrieved alignment value @@ -555,12 +555,12 @@ H5FD_mem_t FileAccPropList::getMultiType() const ///\param rdcc_w0 - IN: Preemption policy ///\exception H5::PropListIException ///\par Description -/// The argument \a rdcc_w0 should hold a value between 0 and 1 -/// inclusive. This value indicates how much chunks that have -/// been fully read are favored for preemption. A value of zero -/// means fully read chunks are treated no differently than other -/// chunks (the preemption is strictly LRU) while a value of one -/// means fully read chunks are always preempted before other chunks. +/// The argument \a rdcc_w0 should hold a value between 0 and 1 +/// inclusive. This value indicates how much chunks that have +/// been fully read are favored for preemption. A value of zero +/// means fully read chunks are treated no differently than other +/// chunks (the preemption is strictly LRU) while a value of one +/// means fully read chunks are always preempted before other chunks. // Programmer: Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void FileAccPropList::setCache( int mdc_nelmts, size_t rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0 ) const @@ -594,7 +594,7 @@ void FileAccPropList::getCache( int& mdc_nelmts, size_t& rdcc_nelmts, size_t& rd //-------------------------------------------------------------------------- // Function: FileAccPropList::setFcloseDegree ///\brief Sets the degree for the file close behavior. -///\param degree - IN: +///\param degree - IN: ///\exception H5::PropListIException // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- @@ -628,8 +628,8 @@ H5F_close_degree_t FileAccPropList::getFcloseDegree() //-------------------------------------------------------------------------- // Function: FileAccPropList::setGcReferences ///\brief Sets garbage collecting references flag. -///\param gc_ref - IN: Flag setting reference garbage collection to -/// on (1) or off (0). +///\param gc_ref - IN: Flag setting reference garbage collection to +/// on (1) or off (0). ///\exception H5::PropListIException ///\par Description /// For detail on \a fapl, please refer to diff --git a/c++/src/H5FaccProp.h b/c++/src/H5FaccProp.h index d77fa49..143c3ab 100644 --- a/c++/src/H5FaccProp.h +++ b/c++/src/H5FaccProp.h @@ -58,9 +58,9 @@ class H5_DLLCPP FileAccPropList : public PropList { FileAccPropList getFamily(hsize_t& memb_size) const; // Emulates the old split file driver, - void setSplit( FileAccPropList& meta_plist, FileAccPropList& raw_plist, + void setSplit( FileAccPropList& meta_plist, FileAccPropList& raw_plist, const char* meta_ext = ".meta", const char* raw_ext = ".raw" ) const; - void setSplit( FileAccPropList& meta_plist, FileAccPropList& raw_plist, + void setSplit( FileAccPropList& meta_plist, FileAccPropList& raw_plist, const string& meta_ext, const string& raw_ext ) const; #ifdef H5_HAVE_STREAM // for Stream Virtual File Driver diff --git a/c++/src/H5FcreatProp.cpp b/c++/src/H5FcreatProp.cpp index 0eb9462..b776f6a 100644 --- a/c++/src/H5FcreatProp.cpp +++ b/c++/src/H5FcreatProp.cpp @@ -38,7 +38,7 @@ FileCreatPropList::FileCreatPropList() : PropList( H5P_FILE_CREATE ) {} //-------------------------------------------------------------------------- // Function: FileCreatPropList copy constructor -///\brief Copy constructor: makes a copy of the original +///\brief Copy constructor: makes a copy of the original /// FileCreatPropList object. ///\param original - IN: FileCreatPropList instance to copy // Programmer Binh-Minh Ribler - 2000 @@ -71,7 +71,7 @@ void FileCreatPropList::getVersion(unsigned& super, unsigned& freelist, unsigned herr_t ret_value = H5Pget_version( id, &super, &freelist, &stab, &shhdr ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::getVersion", + throw PropListIException("FileCreatPropList::getVersion", "H5Pget_version failed"); } } @@ -82,7 +82,7 @@ void FileCreatPropList::getVersion(unsigned& super, unsigned& freelist, unsigned ///\param size - IN: User block size to be set, in bytes ///\exception H5::PropListIException ///\par Description -/// The default user block size is 0; it may be set to any power +/// The default user block size is 0; it may be set to any power /// of 2 equal to 512 or greater (512, 1024, 2048, etc.) // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -91,7 +91,7 @@ void FileCreatPropList::setUserblock( hsize_t size ) const herr_t ret_value = H5Pset_userblock( id, size); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::setUserblock", + throw PropListIException("FileCreatPropList::setUserblock", "H5Pset_userblock failed"); } } @@ -109,7 +109,7 @@ hsize_t FileCreatPropList::getUserblock() const herr_t ret_value = H5Pget_userblock( id, &userblock_size ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::getUserblock", + throw PropListIException("FileCreatPropList::getUserblock", "H5Pget_userblock failed"); } return( userblock_size ); @@ -117,10 +117,10 @@ hsize_t FileCreatPropList::getUserblock() const //-------------------------------------------------------------------------- // Function: FileCreatPropList::setSizes -///\brief Sets the byte size of the offsets and lengths used to +///\brief Sets the byte size of the offsets and lengths used to /// address objects in an HDF5 file. ///\param sizeof_addr - IN: Size of an object offset in bytes -///\param sizeof_size - IN: Size of an object length in bytes. +///\param sizeof_size - IN: Size of an object length in bytes. ///\exception H5::PropListIException ///\par Description /// For information on setting sizes, please refer to the @@ -133,14 +133,14 @@ void FileCreatPropList::setSizes( size_t sizeof_addr, size_t sizeof_size ) const herr_t ret_value = H5Pset_sizes( id, sizeof_addr, sizeof_size ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::setSizes", + throw PropListIException("FileCreatPropList::setSizes", "H5Pset_sizes failed"); } } //-------------------------------------------------------------------------- // Function: FileCreatPropList::getSizes -///\brief Retrieves the size of the offsets and lengths used in an +///\brief Retrieves the size of the offsets and lengths used in an /// HDF5 file. /// ///\exception H5::PropListIException @@ -151,14 +151,14 @@ void FileCreatPropList::getSizes( size_t& sizeof_addr, size_t& sizeof_size ) con herr_t ret_value = H5Pget_sizes( id, &sizeof_addr, &sizeof_size ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::getSizes", + throw PropListIException("FileCreatPropList::getSizes", "H5Pget_sizes failed"); } } //-------------------------------------------------------------------------- // Function: FileCreatPropList::setSymk -///\brief Sets the size of parameters used to control the symbol table +///\brief Sets the size of parameters used to control the symbol table /// nodes. ///\param ik - IN: Symbol table tree rank ///\param lk - IN: Symbol table node size @@ -173,14 +173,14 @@ void FileCreatPropList::setSymk( unsigned ik, unsigned lk ) const herr_t ret_value = H5Pset_sym_k( id, ik, lk ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::setSymk", + throw PropListIException("FileCreatPropList::setSymk", "H5Pset_sym_k failed"); } } //-------------------------------------------------------------------------- // Function: FileCreatPropList::getSymk -///\brief Retrieves the size of the symbol table B-tree 1/2 rank and +///\brief Retrieves the size of the symbol table B-tree 1/2 rank and /// the symbol table leaf node 1/2 size. /// ///\exception H5::PropListIException @@ -194,14 +194,14 @@ void FileCreatPropList::getSymk( unsigned& ik, unsigned& lk ) const herr_t ret_value = H5Pget_sym_k( id, &ik, &lk ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::getSymk", + throw PropListIException("FileCreatPropList::getSymk", "H5Pget_sym_k failed"); } } //-------------------------------------------------------------------------- // Function: FileCreatPropList::setIstorek -///\brief Sets the size of the parameter used to control the B-trees +///\brief Sets the size of the parameter used to control the B-trees /// for indexing chunked datasets. ///\param ik - IN: 1/2 rank of chunked storage B-tree ///\exception H5::PropListIException @@ -215,7 +215,7 @@ void FileCreatPropList::setIstorek( unsigned ik ) const herr_t ret_value = H5Pset_istore_k( id, ik ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::setIstorek", + throw PropListIException("FileCreatPropList::setIstorek", "H5Pset_istore_k failed"); } } @@ -236,7 +236,7 @@ unsigned FileCreatPropList::getIstorek() const herr_t ret_value = H5Pget_istore_k( id, &ik ); if( ret_value < 0 ) { - throw PropListIException("FileCreatPropList::getIstorek", + throw PropListIException("FileCreatPropList::getIstorek", "H5Pget_istore_k failed"); } return( ik ); diff --git a/c++/src/H5FcreatProp.h b/c++/src/H5FcreatProp.h index 6b7bfcc..4ed8868 100644 --- a/c++/src/H5FcreatProp.h +++ b/c++/src/H5FcreatProp.h @@ -25,7 +25,7 @@ class H5_DLLCPP FileCreatPropList : public PropList { public: // Default file creation property list. static const FileCreatPropList DEFAULT; - + // Retrieves version information for various parts of a file. void getVersion( unsigned& super, unsigned& freelist, unsigned& stab, unsigned& shhdr ) const; @@ -35,7 +35,7 @@ class H5_DLLCPP FileCreatPropList : public PropList { // Gets the size of a user block in this file creation property list. hsize_t getUserblock() const; - // Retrieves the size-of address and size quantities stored in a + // Retrieves the size-of address and size quantities stored in a // file according to this file creation property list. void getSizes( size_t& sizeof_addr, size_t& sizeof_size ) const; diff --git a/c++/src/H5File.cpp b/c++/src/H5File.cpp index 361d448..54c4f6d 100644 --- a/c++/src/H5File.cpp +++ b/c++/src/H5File.cpp @@ -52,21 +52,21 @@ H5File::H5File() : IdComponent() {} ///\brief Creates or opens an HDF5 file depending on the parameter flags. ///\param name - IN: Name of the file ///\param flags - IN: File access flags -///\param create_plist - IN: File creation property list, used when -/// modifying default file meta-data. Default to +///\param create_plist - IN: File creation property list, used when +/// modifying default file meta-data. Default to /// FileCreatPropList::DEFAULT -///\param access_plist - IN: File access property list. Default to +///\param access_plist - IN: File access property list. Default to /// FileCreatPropList::DEFAULT ///\par Description /// Valid values of \a flags include: -/// \li \c H5F_ACC_TRUNC - Truncate file, if it already exists, -/// erasing all data previously stored in -/// the file. -/// \li \c H5F_ACC_EXCL - Fail if file already exists. +/// \li \c H5F_ACC_TRUNC - Truncate file, if it already exists, +/// erasing all data previously stored in +/// the file. +/// \li \c H5F_ACC_EXCL - Fail if file already exists. /// \c H5F_ACC_TRUNC and \c H5F_ACC_EXCL are mutually exclusive -/// \li \c H5F_ACC_DEBUG - print debug information. This flag is -/// used only by HDF5 library developers; it is neither -/// tested nor supported for use in applications. +/// \li \c H5F_ACC_DEBUG - print debug information. This flag is +/// used only by HDF5 library developers; it is neither +/// tested nor supported for use in applications. ///\par /// For info on file creation in the case of an already-open file, /// please refer to the \b Special \b case section in the C layer @@ -81,14 +81,14 @@ H5File::H5File( const char* name, unsigned int flags, const FileCreatPropList& c //-------------------------------------------------------------------------- // Function: H5File overloaded constructor -///\brief This is another overloaded constructor. It differs from the +///\brief This is another overloaded constructor. It differs from the /// above constructor only in the type of the \a name argument. ///\param name - IN: Name of the file - \c std::string ///\param flags - IN: File access flags -///\param create_plist - IN: File creation property list, used when -/// modifying default file meta-data. Default to +///\param create_plist - IN: File creation property list, used when +/// modifying default file meta-data. Default to /// FileCreatPropList::DEFAULT -///\param access_plist - IN: File access property list. Default to +///\param access_plist - IN: File access property list. Default to /// FileCreatPropList::DEFAULT // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -98,7 +98,7 @@ H5File::H5File( const string& name, unsigned int flags, const FileCreatPropList& } //-------------------------------------------------------------------------- -// This function is private and contains common code between the +// This function is private and contains common code between the // constructors taking a string or a char* // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -145,16 +145,16 @@ H5File::H5File( const H5File& original ) : IdComponent( original ) {} ///\exception H5::FileIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- -bool H5File::isHdf5(const char* name ) +bool H5File::isHdf5(const char* name ) { - // Calls C routine H5Fis_hdf5 to determine whether the file is in + // Calls C routine H5Fis_hdf5 to determine whether the file is in // HDF5 format. It returns positive value, 0, or negative value htri_t ret_value = H5Fis_hdf5( name ); if( ret_value > 0 ) return true; else if( ret_value == 0 ) return false; - else // Raise exception when H5Fis_hdf5 returns a negative value + else // Raise exception when H5Fis_hdf5 returns a negative value { throw FileIException("H5File::isHdf5", "H5Fis_hdf5 returned negative value"); } @@ -167,7 +167,7 @@ bool H5File::isHdf5(const char* name ) ///\param name - IN: Name of the file - \c std::string // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- -bool H5File::isHdf5(const string& name ) +bool H5File::isHdf5(const string& name ) { return( isHdf5( name.c_str()) ); } @@ -288,21 +288,21 @@ hssize_t H5File::getFreeSpace() const //-------------------------------------------------------------------------- // Function: H5File::getObjCount -///\brief Returns the number of opened object IDs (files, datasets, +///\brief Returns the number of opened object IDs (files, datasets, /// groups and datatypes) in the same file. -///\param types - Type of object to retrieve the count +///\param types - Type of object to retrieve the count ///\return Number of opened object IDs ///\exception H5::FileIException ///\par Description /// The valid values for \a types include: -/// \li \c H5F_OBJ_FILE - Files only -/// \li \c H5F_OBJ_DATASET - Datasets only -/// \li \c H5F_OBJ_GROUP - Groups only -/// \li \c H5F_OBJ_DATATYPE - Named datatypes only -/// \li \c H5F_OBJ_ATTR - Attributes only -/// \li \c H5F_OBJ_ALL - All of the above, i.e., \c H5F_OBJ_FILE -/// | \c H5F_OBJ_DATASET | \c H5F_OBJ_GROUP -/// | \c H5F_OBJ_DATATYPE | \c H5F_OBJ_ATTR +/// \li \c H5F_OBJ_FILE - Files only +/// \li \c H5F_OBJ_DATASET - Datasets only +/// \li \c H5F_OBJ_GROUP - Groups only +/// \li \c H5F_OBJ_DATATYPE - Named datatypes only +/// \li \c H5F_OBJ_ATTR - Attributes only +/// \li \c H5F_OBJ_ALL - All of the above, i.e., \c H5F_OBJ_FILE +/// | \c H5F_OBJ_DATASET | \c H5F_OBJ_GROUP +/// | \c H5F_OBJ_DATATYPE | \c H5F_OBJ_ATTR ///\par /// Multiple object types can be combined with the logical OR operator (|). // Programmer Binh-Minh Ribler - May 2004 @@ -320,7 +320,7 @@ int H5File::getObjCount(unsigned types) const //-------------------------------------------------------------------------- // Function: H5File::getObjCount ///\brief This is an overloaded member function, provided for convenience. -/// It takes no parameter and returns the object count of all +/// It takes no parameter and returns the object count of all /// object types. ///\return Number of opened object IDs ///\exception H5::FileIException @@ -338,23 +338,23 @@ int H5File::getObjCount() const //-------------------------------------------------------------------------- // Function: H5File::getObjIDs -///\brief Retrieves a list of opened object IDs (files, datasets, +///\brief Retrieves a list of opened object IDs (files, datasets, /// groups and datatypes) in the same file. -///\param types - Type of object to retrieve the count -///\param max_objs - Maximum number of object identifiers to place +///\param types - Type of object to retrieve the count +///\param max_objs - Maximum number of object identifiers to place /// into obj_id_list. ///\param oid_list - List of open object identifiers ///\exception H5::FileIException ///\par Description /// The valid values for \a types include: -/// \li \c H5F_OBJ_FILE - Files only -/// \li \c H5F_OBJ_DATASET - Datasets only -/// \li \c H5F_OBJ_GROUP - Groups only -/// \li \c H5F_OBJ_DATATYPE - Named datatypes only -/// \li \c H5F_OBJ_ATTR - Attributes only -/// \li \c H5F_OBJ_ALL - All of the above, i.e., \c H5F_OBJ_FILE -/// | \c H5F_OBJ_DATASET | \c H5F_OBJ_GROUP -/// | \c H5F_OBJ_DATATYPE | \c H5F_OBJ_ATTR +/// \li \c H5F_OBJ_FILE - Files only +/// \li \c H5F_OBJ_DATASET - Datasets only +/// \li \c H5F_OBJ_GROUP - Groups only +/// \li \c H5F_OBJ_DATATYPE - Named datatypes only +/// \li \c H5F_OBJ_ATTR - Attributes only +/// \li \c H5F_OBJ_ALL - All of the above, i.e., \c H5F_OBJ_FILE +/// | \c H5F_OBJ_DATASET | \c H5F_OBJ_GROUP +/// | \c H5F_OBJ_DATATYPE | \c H5F_OBJ_ATTR ///\par /// Multiple object types can be combined with the logical OR operator (|). // @@ -379,13 +379,13 @@ void H5File::getObjIDs(unsigned types, int max_objs, hid_t *oid_list) const /// the low-level virtual file driver ///\exception H5::FileIException ///\par Description -/// For the \c FAMILY or \c MULTI drivers, \a fapl should be -/// defined through the property list functions: -/// \c FileAccPropList::setFamilyOffset for the \c FAMILY driver +/// For the \c FAMILY or \c MULTI drivers, \a fapl should be +/// defined through the property list functions: +/// \c FileAccPropList::setFamilyOffset for the \c FAMILY driver /// and \c FileAccPropList::setMultiType for the \c MULTI driver. /// -/// The obtained file handle is dynamic and is valid only while -/// the file remains open; it will be invalid if the file is +/// The obtained file handle is dynamic and is valid only while +/// the file remains open; it will be invalid if the file is /// closed and reopened or opened during a subsequent session. // Programmer Binh-Minh Ribler - May 2004 //-------------------------------------------------------------------------- @@ -466,11 +466,11 @@ void* H5File::Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_t ///\return A reference ///\exception H5::IdComponentException ///\par Description -// This function passes H5R_OBJECT and -1 to the protected +// This function passes H5R_OBJECT and -1 to the protected // function for it to pass to the C API H5Rcreate // to create a reference to the named object. ///\par -/// Note that, for H5File, name must be an absolute path to the +/// Note that, for H5File, name must be an absolute path to the /// object in the file. // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- @@ -503,10 +503,10 @@ void* H5File::Reference(const string& name) const ///\param ref - IN: Reference to query ///\param ref_type - IN: Type of reference to query ///\return Object type, which can be one of the following: -/// \li \c H5G_LINK - Object is a symbolic link. -/// \li \c H5G_GROUP - Object is a group. -/// \li \c H5G_DATASET - Object is a dataset. -/// \li \c H5G_TYPE - Object is a named datatype +/// \li \c H5G_LINK - Object is a symbolic link. +/// \li \c H5G_GROUP - Object is a group. +/// \li \c H5G_DATASET - Object is a dataset. +/// \li \c H5G_TYPE - Object is a named datatype ///\exception H5::IdComponentException // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- @@ -546,7 +546,7 @@ DataSpace H5File::getRegion(void *ref, H5R_type_t ref_type) const ///\return File size ///\exception H5::FileIException ///\par Description -/// This function is called after an existing file is opened in +/// This function is called after an existing file is opened in /// order to learn the true size of the underlying file. // Programmer Raymond Lu - June 24, 2004 //-------------------------------------------------------------------------- @@ -599,30 +599,30 @@ void H5File::close() ///\param msg - Message describing the failure ///\exception H5::FileIException // Description -// This function is used in CommonFG implementation so that -// proper exception can be thrown for file or group. The -// argument func_name is a member of CommonFG and "H5File::" -// will be inserted to indicate the function called is an +// This function is used in CommonFG implementation so that +// proper exception can be thrown for file or group. The +// argument func_name is a member of CommonFG and "H5File::" +// will be inserted to indicate the function called is an // implementation of H5File. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void H5File::throwException(const string func_name, const string msg) const { string full_name = func_name; - full_name.insert(0, "H5File::"); + full_name.insert(0, "H5File::"); throw FileIException(full_name, msg); } //-------------------------------------------------------------------------- // Function: H5File destructor -///\brief Properly terminates access to this file. +///\brief Properly terminates access to this file. // Programmer Binh-Minh Ribler - 2000 // Modification // Replaced resetIdComponent with decRefCount to use C library // ID reference counting mechanism - June 1, 2004 //-------------------------------------------------------------------------- -H5File::~H5File() -{ +H5File::~H5File() +{ // The HDF5 file id will be closed properly try { decRefCount(); @@ -630,7 +630,7 @@ H5File::~H5File() catch (Exception close_error) { cerr << "H5File::~H5File - " << close_error.getDetailMsg() << endl; } -} +} #ifndef H5_NO_NAMESPACE } // end namespace diff --git a/c++/src/H5File.h b/c++/src/H5File.h index 3b7ffaf..0aad671 100644 --- a/c++/src/H5File.h +++ b/c++/src/H5File.h @@ -48,12 +48,12 @@ class H5_DLLCPP H5File : public IdComponent, public CommonFG { // Returns the amount of free space in the file. hssize_t getFreeSpace() const; - // Returns the number of opened object IDs (files, datasets, groups + // Returns the number of opened object IDs (files, datasets, groups // and datatypes) in the same file. int getObjCount(unsigned types) const; int getObjCount() const; - // Retrieves a list of opened object IDs (files, datasets, groups + // Retrieves a list of opened object IDs (files, datasets, groups // and datatypes) in the same file. void getObjIDs(unsigned types, int max_objs, hid_t *oid_list) const; @@ -75,7 +75,7 @@ class H5_DLLCPP H5File : public IdComponent, public CommonFG { void reOpen(); // added for better name void reopen(); - // Creates a reference to a named Hdf5 object or to a dataset region + // Creates a reference to a named Hdf5 object or to a dataset region // in this object. void* Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_type = H5R_DATASET_REGION) const; diff --git a/c++/src/H5FloatType.cpp b/c++/src/H5FloatType.cpp index a5b1c51..530868f 100644 --- a/c++/src/H5FloatType.cpp +++ b/c++/src/H5FloatType.cpp @@ -56,7 +56,7 @@ FloatType::FloatType( const PredType& pred_type ) : AtomType() //-------------------------------------------------------------------------- // Function: FloatType overloaded constructor -///\brief Creates an FloatType object using the id of an existing +///\brief Creates an FloatType object using the id of an existing /// datatype. ///\param existing_id - IN: Id of an existing datatype ///\exception H5::DataTypeIException @@ -74,7 +74,7 @@ FloatType::FloatType( const FloatType& original ) : AtomType( original ){} //-------------------------------------------------------------------------- // Function: EnumType overloaded constructor ///\brief Gets the floating-point datatype of the specified dataset -///\param dataset - IN: Dataset that this floating-point datatype +///\param dataset - IN: Dataset that this floating-point datatype /// associates with ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -92,7 +92,7 @@ FloatType::FloatType( const DataSet& dataset ) : AtomType() //-------------------------------------------------------------------------- // Function: FloatType::getFields -///\brief Retrieves floating point datatype bit field information. +///\brief Retrieves floating point datatype bit field information. ///\param spos - OUT: Retrieved floating-point sign bit ///\param epos - OUT: Retrieved exponent bit-position ///\param esize - OUT: Retrieved size of exponent, in bits @@ -112,8 +112,8 @@ void FloatType::getFields( size_t& spos, size_t& epos, size_t& esize, size_t& mp //-------------------------------------------------------------------------- // Function: FloatType::setFields -///\brief Sets locations and sizes of floating point bit fields. -///\param spos - OUT: Sign position, i.e., the bit offset of the +///\brief Sets locations and sizes of floating point bit fields. +///\param spos - OUT: Sign position, i.e., the bit offset of the /// floating-point sign bit. ///\param epos - OUT: Exponent bit position ///\param esize - OUT: Size of exponent, in bits @@ -133,7 +133,7 @@ void FloatType::setFields( size_t spos, size_t epos, size_t esize, size_t mpos, //-------------------------------------------------------------------------- // Function: FloatType::getEbias -///\brief Retrieves the exponent bias of a floating-point type. +///\brief Retrieves the exponent bias of a floating-point type. ///\return Exponent bias ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -151,7 +151,7 @@ size_t FloatType::getEbias() const //-------------------------------------------------------------------------- // Function: FloatType::setEbias -///\brief Sets the exponent bias of a floating-point type. +///\brief Sets the exponent bias of a floating-point type. ///\param ebias - Exponent bias value ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 @@ -167,16 +167,16 @@ void FloatType::setEbias( size_t ebias ) const //-------------------------------------------------------------------------- // Function: FloatType::getNorm -///\brief Retrieves mantissa normalization of a floating-point datatype. +///\brief Retrieves mantissa normalization of a floating-point datatype. ///\param norm_string - OUT: Text string of the normalization type ///\return Valid normalization type, which can be: /// \li \c H5T_NORM_IMPLIED (0) - MSB of mantissa is not stored -/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 -/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized +/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 +/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized ///\exception H5::DataTypeIException ///\par Description -/// For your convenience, this function also provides the text -/// string of the returned normalization type, via parameter +/// For your convenience, this function also provides the text +/// string of the returned normalization type, via parameter /// \a norm_string. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -199,14 +199,14 @@ H5T_norm_t FloatType::getNorm( string& norm_string ) const //-------------------------------------------------------------------------- // Function: FloatType::setNorm -///\brief Sets the mantissa normalization of a floating-point datatype. +///\brief Sets the mantissa normalization of a floating-point datatype. ///\param norm - IN: Mantissa normalization type ///\exception H5::DataTypeIException ///\par Description /// Valid values for normalization type include: /// \li \c H5T_NORM_IMPLIED (0) - MSB of mantissa is not stored -/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 -/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized +/// \li \c H5T_NORM_MSBSET (1) - MSB of mantissa is always 1 +/// \li \c H5T_NORM_NONE (2) - Mantissa is not normalized // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void FloatType::setNorm( H5T_norm_t norm ) const @@ -220,16 +220,16 @@ void FloatType::setNorm( H5T_norm_t norm ) const //-------------------------------------------------------------------------- // Function: FloatType::getInpad -///\brief Retrieves the internal padding type for unused bits in -/// this floating-point datatypes. +///\brief Retrieves the internal padding type for unused bits in +/// this floating-point datatypes. ///\return Internal padding type, which can be: /// \li \c H5T_PAD_ZERO (0) - Set background to zeros /// \li \c H5T_PAD_ONE (1) - Set background to ones /// \li \c H5T_PAD_BACKGROUND (2) - Leave background alone ///\exception H5::DataTypeIException ///\par Description -/// For your convenience, this function also provides the text -/// string of the returned internal padding type, via parameter +/// For your convenience, this function also provides the text +/// string of the returned internal padding type, via parameter /// \a pad_string. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -252,14 +252,14 @@ H5T_pad_t FloatType::getInpad( string& pad_string ) const //-------------------------------------------------------------------------- // Function: FloatType::setInpad -///\brief Fills unused internal floating point bits. +///\brief Fills unused internal floating point bits. ///\param inpad - IN: Internal padding type ///\exception H5::DataTypeIException ///\par Description -/// If any internal bits of a floating point type are unused -/// (that is, those significant bits which are not part of the -/// sign, exponent, or mantissa), then they will be filled -/// according to the padding value provided by \a inpad. +/// If any internal bits of a floating point type are unused +/// (that is, those significant bits which are not part of the +/// sign, exponent, or mantissa), then they will be filled +/// according to the padding value provided by \a inpad. ///\par /// Valid values for normalization type include: /// \li \c H5T_PAD_ZERO (0) - Set background to zeros diff --git a/c++/src/H5FloatType.h b/c++/src/H5FloatType.h index bc30963..45c992e 100644 --- a/c++/src/H5FloatType.h +++ b/c++/src/H5FloatType.h @@ -25,31 +25,31 @@ class H5_DLLCPP FloatType : public AtomType { // Creates a floating-point type using a predefined type FloatType( const PredType& pred_type ); - // Gets the floating-point datatype of the specified dataset + // Gets the floating-point datatype of the specified dataset FloatType( const DataSet& dataset ); - // Retrieves the exponent bias of a floating-point type. + // Retrieves the exponent bias of a floating-point type. size_t getEbias() const; - // Sets the exponent bias of a floating-point type. + // Sets the exponent bias of a floating-point type. void setEbias( size_t ebias ) const; - // Retrieves floating point datatype bit field information. + // Retrieves floating point datatype bit field information. void getFields( size_t& spos, size_t& epos, size_t& esize, size_t& mpos, size_t& msize ) const; - // Sets locations and sizes of floating point bit fields. + // Sets locations and sizes of floating point bit fields. void setFields( size_t spos, size_t epos, size_t esize, size_t mpos, size_t msize ) const; - // Retrieves the internal padding type for unused bits in floating-point datatypes. + // Retrieves the internal padding type for unused bits in floating-point datatypes. H5T_pad_t getInpad( string& pad_string ) const; - - // Fills unused internal floating point bits. + + // Fills unused internal floating point bits. void setInpad( H5T_pad_t inpad ) const; - // Retrieves mantissa normalization of a floating-point datatype. + // Retrieves mantissa normalization of a floating-point datatype. H5T_norm_t getNorm( string& norm_string ) const; - // Sets the mantissa normalization of a floating-point datatype. + // Sets the mantissa normalization of a floating-point datatype. void setNorm( H5T_norm_t norm ) const; // Returns this class name diff --git a/c++/src/H5Group.cpp b/c++/src/H5Group.cpp index 1d587c8..6bf25a1 100644 --- a/c++/src/H5Group.cpp +++ b/c++/src/H5Group.cpp @@ -103,7 +103,7 @@ void* Group::Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_ty ///\return A reference ///\exception H5::GroupIException ///\par Description -// This function passes H5R_OBJECT and -1 to the protected +// This function passes H5R_OBJECT and -1 to the protected // function for it to pass to the C API H5Rcreate // to create a reference to the named object. // Programmer Binh-Minh Ribler - May, 2004 @@ -137,10 +137,10 @@ void* Group::Reference(const string& name) const ///\param ref - IN: Reference to query ///\param ref_type - IN: Type of reference to query ///\return An object type, which can be one of the following: -// H5G_LINK Object is a symbolic link. -// H5G_GROUP Object is a group. -// H5G_DATASET Object is a dataset. -// H5G_TYPE Object is a named datatype +// H5G_LINK Object is a symbolic link. +// H5G_GROUP Object is a group. +// H5G_DATASET Object is a dataset. +// H5G_TYPE Object is a named datatype ///\exception H5::GroupIException // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- @@ -222,16 +222,16 @@ void Group::throwException(const string func_name, const string msg) const // ID reference counting mechanism - June 1, 2004 //-------------------------------------------------------------------------- Group::~Group() -{ +{ // The group id will be closed properly try { decRefCount(); } - catch (Exception close_error) { + catch (Exception close_error) { cerr << "Group::~Group - " << close_error.getDetailMsg() << endl; } -} +} #ifndef H5_NO_NAMESPACE } // end namespace diff --git a/c++/src/H5IdComponent.cpp b/c++/src/H5IdComponent.cpp index 51bdc02..ee6ea49 100644 --- a/c++/src/H5IdComponent.cpp +++ b/c++/src/H5IdComponent.cpp @@ -79,10 +79,10 @@ void IdComponent::decRefCount(const hid_t obj_id) const if (p_valid_id(obj_id)) if (H5Idec_ref(obj_id) < 0) if (H5Iget_ref(obj_id) <= 0) - throw IdComponentException(inMemFunc("decRefCount"), + throw IdComponentException(inMemFunc("decRefCount"), "object ref count is 0 or negative"); else - throw IdComponentException(inMemFunc("decRefCount"), + throw IdComponentException(inMemFunc("decRefCount"), "decrementing object ref count failed"); } @@ -158,8 +158,8 @@ H5I_type_t IdComponent::getHDFObjType(const hid_t obj_id) // Description // The underlaying reference counting in the C library ensures // that the current valid id of this object is properly closed. -// Copy the id from rhs to this object, then increment the -// reference counter of the id to indicate that another object +// Copy the id from rhs to this object, then increment the +// reference counter of the id to indicate that another object // is referencing it. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -200,7 +200,7 @@ void IdComponent::setId(const hid_t new_id) //-------------------------------------------------------------------------- // Function: IdComponent::getId -///\brief Returns the id of this object +///\brief Returns the id of this object ///\return HDF5 id // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -216,8 +216,8 @@ hid_t IdComponent::getId () const //-------------------------------------------------------------------------- IdComponent::~IdComponent() { -/* uncomment this block and complete it when deciding to use dontAtExit - unless the atexit/global destructor problem is fixed, then +/* uncomment this block and complete it when deciding to use dontAtExit + unless the atexit/global destructor problem is fixed, then remove it- BMR 11/14/00 if( id == NOTATEXIT ) @@ -242,7 +242,7 @@ IdComponent::~IdComponent() { // // Implementation of protected functions for HDF5 Reference Interface. -// +// #ifndef DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- @@ -250,9 +250,9 @@ IdComponent::~IdComponent() { ///\brief Makes and returns string "<class-name>::<func_name>" ///\param func_name - Name of the function where failure occurs // Description -/// Concatenates the class name of this object with the -/// passed-in function name to create a string that indicates -/// where the failure occurs. The class-name is provided by +/// Concatenates the class name of this object with the +/// passed-in function name to create a string that indicates +/// where the failure occurs. The class-name is provided by /// fromClass(). This string will be used by a base class when /// an exception is thrown. // Programmer Binh-Minh Ribler - Aug 6, 2005 @@ -278,7 +278,7 @@ IdComponent::IdComponent() : id(-1) {} // Exception: H5::IdComponentException // Description: // This function is protected so that the user applications can -// only have access to its code via allowable classes, namely, +// only have access to its code via allowable classes, namely, // H5File and H5Object subclasses. // Programmer Binh-Minh Ribler - Jul, 2004 //-------------------------------------------------------------------------- @@ -338,10 +338,10 @@ void* IdComponent::p_reference(const char* name, hid_t space_id, H5R_type_t ref_ // ref - IN: Reference to query // ref_type - IN: Type of reference to query // Return An object type, which can be one of the following: -// H5G_LINK Object is a symbolic link. -// H5G_GROUP Object is a group. -// H5G_DATASET Object is a dataset. -// H5G_TYPE Object is a named datatype +// H5G_LINK Object is a symbolic link. +// H5G_GROUP Object is a group. +// H5G_DATASET Object is a dataset. +// H5G_TYPE Object is a named datatype // Exception H5::IdComponentException // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- @@ -378,7 +378,7 @@ hid_t IdComponent::p_get_region(void *ref, H5R_type_t ref_type) const // // Local functions used in this class -// +// //-------------------------------------------------------------------------- // Function: p_valid_id diff --git a/c++/src/H5IntType.cpp b/c++/src/H5IntType.cpp index f161c13..868785b 100644 --- a/c++/src/H5IntType.cpp +++ b/c++/src/H5IntType.cpp @@ -64,7 +64,7 @@ IntType::IntType( const PredType& pred_type ) : AtomType() //-------------------------------------------------------------------------- // Function: IntType overloaded constructor -///\brief Creates an integer datatype using the id of an existing +///\brief Creates an integer datatype using the id of an existing /// datatype. ///\param existing_id - IN: Id of an existing datatype ///\exception H5::DataTypeIException @@ -80,7 +80,7 @@ IntType::IntType( const hid_t existing_id ) : AtomType( existing_id ) {} // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- IntType::IntType( const DataSet& dataset ) : AtomType() -{ +{ // Calls C function H5Dget_type to get the id of the datatype id = H5Dget_type( dataset.getId() ); @@ -88,7 +88,7 @@ IntType::IntType( const DataSet& dataset ) : AtomType() { throw DataSetIException("IntType constructor", "H5Dget_type failed"); } -} +} //-------------------------------------------------------------------------- // Function: IntType::getSign @@ -104,7 +104,7 @@ H5T_sign_t IntType::getSign() const // Returns a valid sign type if no errors if( type_sign == H5T_SGN_ERROR ) { - throw DataTypeIException("IntType::getSign", + throw DataTypeIException("IntType::getSign", "H5Tget_sign failed - returned H5T_SGN_ERROR for the sign type"); } return( type_sign ); @@ -112,7 +112,7 @@ H5T_sign_t IntType::getSign() const //-------------------------------------------------------------------------- // Function: IntType::getSign -///\brief Sets the sign property for an integer type. +///\brief Sets the sign property for an integer type. ///\param sign - IN: Sign type ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 diff --git a/c++/src/H5IntType.h b/c++/src/H5IntType.h index ab43d0f..6178e3f 100644 --- a/c++/src/H5IntType.h +++ b/c++/src/H5IntType.h @@ -30,7 +30,7 @@ class H5_DLLCPP IntType : public AtomType { // Retrieves the sign type for an integer type H5T_sign_t getSign() const; - // Sets the sign proprety for an integer type. + // Sets the sign proprety for an integer type. void setSign( H5T_sign_t sign ) const; // Returns this class name diff --git a/c++/src/H5Library.cpp b/c++/src/H5Library.cpp index 8c0aace..71fdc7a 100644 --- a/c++/src/H5Library.cpp +++ b/c++/src/H5Library.cpp @@ -14,7 +14,7 @@ #include <string> -#include "H5CppDoc.h" // included only for Doxygen to generate part of RM +#include "H5CppDoc.h" // included only for Doxygen to generate part of RM #include "H5Include.h" #include "H5Exception.h" #include "H5Library.h" @@ -30,7 +30,7 @@ bool H5Library::need_cleanup = false; //-------------------------------------------------------------------------- // Function: H5Library::open -///\brief Initializes the HDF5 library. +///\brief Initializes the HDF5 library. /// ///\exception H5::LibraryIException // Programmer Binh-Minh Ribler - 2000 @@ -46,7 +46,7 @@ void H5Library::open() //-------------------------------------------------------------------------- // Function: H5Library::close -///\brief Flushes all data to disk, closes files, and cleans up memory. +///\brief Flushes all data to disk, closes files, and cleans up memory. /// ///\exception H5::LibraryIException // Programmer Binh-Minh Ribler - 2000 @@ -78,7 +78,7 @@ void H5Library::dontAtExit() //-------------------------------------------------------------------------- // Function: H5Library::getLibVersion -///\brief Returns the HDF library release number. +///\brief Returns the HDF library release number. ///\param majnum - OUT: Major version of the library ///\param minnum - OUT: Minor version of the library ///\param relnum - OUT: Release number of the library @@ -96,7 +96,7 @@ void H5Library::getLibVersion( unsigned& majnum, unsigned& minnum, unsigned& rel //-------------------------------------------------------------------------- // Function: H5Library::checkVersion -///\brief Verifies that the arguments match the version numbers +///\brief Verifies that the arguments match the version numbers /// compiled into the library ///\param majnum - IN: Major version of the library ///\param minnum - IN: Minor version of the library @@ -120,21 +120,21 @@ void H5Library::checkVersion(unsigned majnum, unsigned minnum, unsigned relnum) //-------------------------------------------------------------------------- // Function: H5Library::garbageCollect ///\brief Walks through all the garbage collection routines for the -/// library, which are supposed to free any unused memory they +/// library, which are supposed to free any unused memory they /// have allocated. /// ///\exception H5::LibraryIException ///\par Description -/// It is not required that H5Library::garbageCollect be called -/// at any particular time; it is only necessary in certain -/// situations, such as when the application has performed actions -/// that cause the library to allocate many objects. The -/// application should call H5Library::garbageCollect if it -/// eventually releases those objects and wants to reduce the -/// memory used by the library from the peak usage required. +/// It is not required that H5Library::garbageCollect be called +/// at any particular time; it is only necessary in certain +/// situations, such as when the application has performed actions +/// that cause the library to allocate many objects. The +/// application should call H5Library::garbageCollect if it +/// eventually releases those objects and wants to reduce the +/// memory used by the library from the peak usage required. ///\par -/// The library automatically garbage collects all the free -/// lists when the application ends. +/// The library automatically garbage collects all the free +/// lists when the application ends. // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- void H5Library::garbageCollect() @@ -158,13 +158,13 @@ void H5Library::garbageCollect() ///\exception H5::LibraryIException ///\par Description /// Setting a value of -1 for a limit means no limit of that type. -/// For more information on free list limits, please refer to C +/// For more information on free list limits, please refer to C /// layer Reference Manual at: /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5.html#Library-SetFreeListLimits // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- -void H5Library::setFreeListLimits(int reg_global_lim, int reg_list_lim, - int arr_global_lim, int arr_list_lim, int blk_global_lim, +void H5Library::setFreeListLimits(int reg_global_lim, int reg_list_lim, + int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim) { herr_t ret_value = H5set_free_list_limits(reg_global_lim, reg_list_lim, arr_global_lim, arr_list_lim, blk_global_lim, blk_list_lim); diff --git a/c++/src/H5Library.h b/c++/src/H5Library.h index 4208cfb..58a53ad 100644 --- a/c++/src/H5Library.h +++ b/c++/src/H5Library.h @@ -23,7 +23,7 @@ namespace H5 { #ifndef DOXYGEN_SHOULD_SKIP_THIS #define NOTATEXIT (-10) // just in case the HDF5 library use more // negative constants. Note: the solution used for the atexit/global - // destructors is not reliable, and desperately needs improvement + // destructors is not reliable, and desperately needs improvement // It is not even working, inifiteloop message still printed when // calling H5close #endif // DOXYGEN_SHOULD_SKIP_THIS @@ -34,30 +34,30 @@ class H5_DLLCPP H5Library { static bool need_cleanup; // indicates if H5close should be called #endif // DOXYGEN_SHOULD_SKIP_THIS - // Initializes the HDF5 library. - static void open(); + // Initializes the HDF5 library. + static void open(); - // Flushes all data to disk, closes files, and cleans up memory. - static void close(); + // Flushes all data to disk, closes files, and cleans up memory. + static void close(); // Instructs library not to install atexit cleanup routine - static void dontAtExit(); + static void dontAtExit(); - // Returns the HDF library release number. - static void getLibVersion( unsigned& majnum, unsigned& minnum, unsigned& relnum ); + // Returns the HDF library release number. + static void getLibVersion( unsigned& majnum, unsigned& minnum, unsigned& relnum ); // Verifies that the arguments match the version numbers compiled // into the library - static void checkVersion( unsigned majnum, unsigned minnum, unsigned relnum ); + static void checkVersion( unsigned majnum, unsigned minnum, unsigned relnum ); - // Walks through all the garbage collection routines for the library, + // Walks through all the garbage collection routines for the library, // which are supposed to free any unused memory they have allocated. static void garbageCollect(); // Sets limits on the different kinds of free lists. static void setFreeListLimits(int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim); - + private: // Default constructor - no instance ever created H5Library() {}; diff --git a/c++/src/H5Object.cpp b/c++/src/H5Object.cpp index 27c62ad..7e477ea 100644 --- a/c++/src/H5Object.cpp +++ b/c++/src/H5Object.cpp @@ -32,7 +32,7 @@ namespace H5 { #ifndef DOXYGEN_SHOULD_SKIP_THIS // userAttrOpWrpr simply interfaces between the user's function and the -// C library function H5Aiterate; used to resolve the different prototype +// C library function H5Aiterate; used to resolve the different prototype // problem. May be moved to Iterator later. extern "C" herr_t userAttrOpWrpr( hid_t loc_id, const char* attr_name, void* op_data ) { @@ -49,7 +49,7 @@ extern "C" herr_t userAttrOpWrpr( hid_t loc_id, const char* attr_name, void* op_ //-------------------------------------------------------------------------- // Function: H5Object default constructor (protected) // Description -// The id is set by IdComponent() but subclass constructor will +// The id is set by IdComponent() but subclass constructor will // set it to a valid HDF5 id. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -57,7 +57,7 @@ H5Object::H5Object() : IdComponent() {} //-------------------------------------------------------------------------- // Function: H5Object overloaded constructor (protected) -// Purpose Creates an H5Object object using the id of an existing HDF5 +// Purpose Creates an H5Object object using the id of an existing HDF5 // object. // Parameters object_id - IN: Id of an existing HDF5 object // Programmer Binh-Minh Ribler - 2000 @@ -68,7 +68,7 @@ H5Object::H5Object( const hid_t object_id ) : IdComponent( object_id ) {} //-------------------------------------------------------------------------- // Function: H5Object copy constructor -///\brief Copy constructor: makes a copy of the original H5Object +///\brief Copy constructor: makes a copy of the original H5Object /// instance. ///\param original - IN: H5Object instance to copy // Programmer Binh-Minh Ribler - 2000 @@ -80,18 +80,18 @@ H5Object::H5Object( const H5Object& original ) : IdComponent( original ) {} ///\brief Creates an attribute for a group, dataset, or named datatype. ///\param name - IN: Name of the attribute ///\param data_type - IN: Datatype for the attribute -///\param data_space - IN: Dataspace for the attribute - only simple +///\param data_space - IN: Dataspace for the attribute - only simple /// dataspaces are allowed at this time -///\param create_plist - IN: Creation property list - default to +///\param create_plist - IN: Creation property list - default to /// PropList::DEFAULT ///\return Attribute instance ///\exception H5::AttributeIException ///\par Description -/// The attribute name specified in \a name must be unique. -/// Attempting to create an attribute with the same name as an -/// existing attribute will raise an exception, leaving the -/// pre-existing attribute intact. To overwrite an existing -/// attribute with a new attribute of the same name, first +/// The attribute name specified in \a name must be unique. +/// Attempting to create an attribute with the same name as an +/// existing attribute will raise an exception, leaving the +/// pre-existing attribute intact. To overwrite an existing +/// attribute with a new attribute of the same name, first /// delete the existing one with \c H5Object::removeAttr, then /// recreate it with this function. // Programmer Binh-Minh Ribler - 2000 @@ -118,7 +118,7 @@ Attribute H5Object::createAttribute( const char* name, const DataType& data_type //-------------------------------------------------------------------------- // Function: H5Object::createAttribute ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes +/// It differs from the above function in that it takes /// a reference to an \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -152,7 +152,7 @@ Attribute H5Object::openAttribute( const char* name ) const //-------------------------------------------------------------------------- // Function: H5Object::openAttribute ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes +/// It differs from the above function in that it takes /// a reference to an \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -189,7 +189,7 @@ Attribute H5Object::openAttribute( const unsigned int idx ) const /// object, which may be a group, dataset or named datatype. ///\param user_op - IN: User's function to operate on each attribute ///\param idx - IN/OUT: Starting (IN) and ending (OUT) attribute indices -///\param op_data - IN: User's data to pass to user's operator function +///\param op_data - IN: User's data to pass to user's operator function ///\return Returned value of the last operator if it was non-zero, or /// zero if all attributes were processed ///\exception H5::AttributeIException @@ -233,7 +233,7 @@ int H5Object::getNumAttrs() const int num_attrs = H5Aget_num_attrs( id ); if( num_attrs < 0 ) { - throw AttributeIException(inMemFunc("getNumAttrs"), + throw AttributeIException(inMemFunc("getNumAttrs"), "H5Aget_num_attrs failed - returned negative number of attributes"); } else @@ -259,7 +259,7 @@ void H5Object::removeAttr( const char* name ) const //-------------------------------------------------------------------------- // Function: H5Object::removeAttr ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes +/// It differs from the above function in that it takes /// a reference to an \c std::string for \a name. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -288,7 +288,7 @@ void H5Object::renameAttr(const char* oldname, const char* newname) const //-------------------------------------------------------------------------- // Function: H5Object::renameAttr ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function in that it takes +/// It differs from the above function in that it takes /// a reference to an \c std::string for the names. // Programmer Binh-Minh Ribler - Mar, 2005 //-------------------------------------------------------------------------- diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h index 6b0d0fd..405193f 100644 --- a/c++/src/H5Object.h +++ b/c++/src/H5Object.h @@ -18,8 +18,8 @@ #include "H5Classes.h" // constains forward class declarations -// H5Object is a baseclass. It has these subclasses: -// Group, AbstractDs, and DataType. +// H5Object is a baseclass. It has these subclasses: +// Group, AbstractDs, and DataType. // AbstractDs, in turn, has subclasses DataSet and Attribute. // DataType, in turn, has several specific datatypes as subclasses. @@ -31,8 +31,8 @@ namespace H5 { class H5_DLLCPP H5Object; // forward declaration for UserData4Aiterate // Define the operator function pointer for H5Aiterate(). -typedef void (*attr_operator_t)( H5Object& loc/*in*/, - const string attr_name/*in*/, +typedef void (*attr_operator_t)( H5Object& loc/*in*/, + const string attr_name/*in*/, void *operator_data/*in,out*/); class UserData4Aiterate { // user data for attribute iteration diff --git a/c++/src/H5PredType.cpp b/c++/src/H5PredType.cpp index 183c7d2..d16933c 100644 --- a/c++/src/H5PredType.cpp +++ b/c++/src/H5PredType.cpp @@ -33,17 +33,17 @@ namespace H5 { #ifndef DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- // Function: PredType overloaded constructor -///\brief Creates a PredType object using the id of an existing +///\brief Creates a PredType object using the id of an existing /// predefined datatype. ///\param predtype_id - IN: Id of a predefined datatype // Description -// This constructor creates a predefined datatype, so it sets +// This constructor creates a predefined datatype, so it sets // DataType::is_predtype to true. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- PredType::PredType( const hid_t predtype_id ) : AtomType( predtype_id ) -{ - is_predtype = true; +{ + is_predtype = true; } //-------------------------------------------------------------------------- @@ -64,7 +64,7 @@ PredType::PredType( const PredType& original ) : AtomType( original ) {} const PredType PredType::NotAtexit; // only for atexit/global dest. problem // Definition of pre-defined types -// Note: the parameter E_xxxx_yyyy is the enum value that represents +// Note: the parameter E_xxxx_yyyy is the enum value that represents // the corresponding HDF5 predefined type H5T_xxxx_yyyy. This enum value // is stored in PredType::id since it is a PredType object id, in a way. // In addition, this storage makes things safely simpler. When a PredType @@ -514,18 +514,18 @@ hid_t PredType::getId() const void PredType::commit( H5Object& loc, const char* name ) { throw DataTypeIException("PredType::commit", "Attempting to commit a predefined datatype. This operation is invalid" ); -} +} void PredType::commit( H5Object& loc, const string& name ) { commit( loc, name.c_str()); -} +} bool PredType::committed() { throw DataTypeIException("PredType::committed", "Error: Attempting to check for commit status on a predefined datatype." ); return (0); -} +} #endif // DOXYGEN_SHOULD_SKIP_THIS // Default destructor diff --git a/c++/src/H5PredType.h b/c++/src/H5PredType.h index d444b52..28b1d32 100644 --- a/c++/src/H5PredType.h +++ b/c++/src/H5PredType.h @@ -28,7 +28,7 @@ namespace H5 { class H5_DLLCPP PredType : public AtomType { public: // Makes a copy of the predefined type and stores the new - // id in the left hand side object. + // id in the left hand side object. PredType& operator=( const PredType& rhs ); // Copy constructor - makes copy of the original object @@ -191,7 +191,7 @@ class H5_DLLCPP PredType : public AtomType { #endif // DOXYGEN_SHOULD_SKIP_THIS private: - // added this to work around the atexit/global destructor problem + // added this to work around the atexit/global destructor problem // temporarily - it'll prevent the use of atexit to clean up static const PredType NotAtexit; // not working yet @@ -207,7 +207,7 @@ class H5_DLLCPP PredType : public AtomType { E_STD_I8BE, E_STD_I8LE, E_STD_I16BE, E_STD_I16LE, E_STD_I32BE, E_STD_I32LE, E_STD_I64BE, E_STD_I64LE, E_STD_U8BE, E_STD_U8LE, E_STD_U16BE, E_STD_U16LE, E_STD_U32BE, E_STD_U32LE, E_STD_U64BE, - E_STD_U64LE, E_STD_B8BE, E_STD_B8LE, E_STD_B16BE, E_STD_B16LE, + E_STD_U64LE, E_STD_B8BE, E_STD_B8LE, E_STD_B16BE, E_STD_B16LE, E_STD_B32BE, E_STD_B32LE, E_STD_B64BE, E_STD_B64LE, E_STD_REF_OBJ, E_STD_REF_DSETREG, @@ -223,8 +223,8 @@ class H5_DLLCPP PredType : public AtomType { E_ALPHA_U16, E_ALPHA_U32, E_ALPHA_U64, E_ALPHA_B8, E_ALPHA_B16, E_ALPHA_B32, E_ALPHA_B64, E_ALPHA_F32, E_ALPHA_F64, - E_MIPS_I8, E_MIPS_I16, E_MIPS_I32, E_MIPS_I64, E_MIPS_U8, - E_MIPS_U16, E_MIPS_U32, E_MIPS_U64, E_MIPS_B8, E_MIPS_B16, + E_MIPS_I8, E_MIPS_I16, E_MIPS_I32, E_MIPS_I64, E_MIPS_U8, + E_MIPS_U16, E_MIPS_U32, E_MIPS_U64, E_MIPS_B8, E_MIPS_B16, E_MIPS_B32, E_MIPS_B64, E_MIPS_F32, E_MIPS_F64, E_NATIVE_CHAR, E_NATIVE_INT, E_NATIVE_FLOAT, E_NATIVE_SCHAR, diff --git a/c++/src/H5PropList.cpp b/c++/src/H5PropList.cpp index dc9cfc3..ff46e29 100644 --- a/c++/src/H5PropList.cpp +++ b/c++/src/H5PropList.cpp @@ -54,11 +54,11 @@ PropList::PropList( const PropList& original ) : IdComponent( original ) {} ///\param plist_id - IN: Id of the existing property list ///\exception H5::PropListIException // Description -// This function calls H5Pcreate to create a new property list -// if the given id, plist_id, is that of a property class. If -// the given id is equal to H5P_NO_CLASS, then set this -// property's id to H5P_DEFAULT, otherwise, to the given id. -// Note: someone else added this code without comments and this +// This function calls H5Pcreate to create a new property list +// if the given id, plist_id, is that of a property class. If +// the given id is equal to H5P_NO_CLASS, then set this +// property's id to H5P_DEFAULT, otherwise, to the given id. +// Note: someone else added this code without comments and this // description was what I came up with from reading the code. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -115,7 +115,7 @@ void PropList::copy( const PropList& like_plist ) ///\return Reference to PropList instance ///\exception H5::PropListIException // Description -// Makes a copy of the property list on the right hand side +// Makes a copy of the property list on the right hand side // and stores the new id in the left hand side object. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -146,7 +146,7 @@ void PropList::copyProp(PropList& dest, const char *name) const //-------------------------------------------------------------------------- // Function: PropList::copyProp ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param dest - IN: Destination property list or class ///\param name - IN: Name of the property to copy - \c std::string @@ -182,7 +182,7 @@ void PropList::copyProp( PropList& dest, PropList& src, const char *name ) const //-------------------------------------------------------------------------- // Function: PropList::copyProp ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. - Obsolete ///\param dest - IN: Destination property list or class ///\param src - IN: Source property list or class @@ -229,7 +229,7 @@ hid_t PropList::getClass() const hid_t plist_class = H5Pget_class( id ); if( plist_class == H5P_NO_CLASS ) { - throw PropListIException(inMemFunc("getClass"), + throw PropListIException(inMemFunc("getClass"), "H5Pget_class failed - returned H5P_NO_CLASS"); } return( plist_class ); @@ -243,14 +243,14 @@ hid_t PropList::getClass() const /// false, otherwise. ///\exception H5::PropListIException ///\par Description -/// This routine checks if a property exists within a property +/// This routine checks if a property exists within a property /// list or class. // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- bool PropList::propExist(const char* name ) const { - // Calls C routine H5Pexist to determine whether a property exists - // within a property list or class. It returns a positive value, 0, + // Calls C routine H5Pexist to determine whether a property exists + // within a property list or class. It returns a positive value, 0, // or a negative value htri_t ret_value = H5Pexist(id, name); if( ret_value > 0 ) @@ -265,7 +265,7 @@ bool PropList::propExist(const char* name ) const //-------------------------------------------------------------------------- // Function: PropList::propExist ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to check for - \c std::string // Programmer: Binh-Minh Ribler - April, 2004 @@ -281,7 +281,7 @@ bool PropList::propExist(const string& name ) const /// ///\exception H5::PropListIException ///\par Description -/// Releases memory and detaches a class from the property +/// Releases memory and detaches a class from the property /// list class hierarchy. // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- @@ -301,8 +301,8 @@ void PropList::closeClass() const ///\param value - OUT: Pointer to the buffer for the property value ///\exception H5::PropListIException ///\par Description -/// Retrieves a copy of the value for a property in a property -/// list. The property name must exist or this routine will +/// Retrieves a copy of the value for a property in a property +/// list. The property name must exist or this routine will /// throw an exception. // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- @@ -317,7 +317,7 @@ void PropList::getProperty(const char* name, void* value) const //-------------------------------------------------------------------------- // Function: PropList::getProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to query - \c char pointer ///\return The property that is a \c std::string. @@ -344,7 +344,7 @@ string PropList::getProperty(const char* name) const //-------------------------------------------------------------------------- // Function: PropList::getProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to query - \c std::string ///\param value - OUT: Pointer to the buffer for the property value @@ -357,7 +357,7 @@ void PropList::getProperty(const string& name, void* value) const //-------------------------------------------------------------------------- // Function: PropList::getProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to query - \c std::string ///\return The property that is a \c std::string. @@ -375,9 +375,9 @@ string PropList::getProperty(const string& name) const ///\return Size of the property ///\exception H5::PropListIException ///\par Description -/// This routine retrieves the size of a property's value -/// in bytes. Zero-sized properties are allowed and the return -/// value will be of 0. This function works for both property +/// This routine retrieves the size of a property's value +/// in bytes. Zero-sized properties are allowed and the return +/// value will be of 0. This function works for both property /// lists and classes. // Programmer: Binh-Minh Ribler - April, 2004 //-------------------------------------------------------------------------- @@ -394,7 +394,7 @@ size_t PropList::getPropSize(const char *name) const //-------------------------------------------------------------------------- // Function: PropList::getPropSize ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to query - \c std::string /// @@ -463,7 +463,7 @@ void PropList::setProperty(const char* name, void* value) const //-------------------------------------------------------------------------- // Function: PropList::setProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to set - \c char pointer ///\param charptr - IN: Char pointer to the value for the property @@ -480,7 +480,7 @@ void PropList::setProperty(const char* name, const char* charptr) const //-------------------------------------------------------------------------- // Function: PropList::setProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to set - \c char pointer ///\param strg - IN: Value for the property is a \c std::string @@ -494,7 +494,7 @@ void PropList::setProperty(const char* name, string& strg) const //-------------------------------------------------------------------------- // Function: PropList::setProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to set - \c std::string ///\param value - IN: Void pointer to the value for the property @@ -508,7 +508,7 @@ void PropList::setProperty(const string& name, void* value) const //-------------------------------------------------------------------------- // Function: PropList::setProperty ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to set - \c std::string ///\param strg - IN: Value for the property is a \c std::string @@ -523,7 +523,7 @@ void PropList::setProperty(const string& name, string& strg) const // Function: PropList::isAClass ///\brief Determines whether a property list is a certain class. ///\param prop_class - IN: Property class to query -///\return true if the property list is a member of the property list +///\return true if the property list is a member of the property list /// class, and false, otherwise. ///\exception H5::PropListIException // Programmer: Binh-Minh Ribler - April, 2004 @@ -561,7 +561,7 @@ void PropList::removeProp(const char *name) const //-------------------------------------------------------------------------- // Function: PropList::removeProp ///\brief This is an overloaded member function, provided for convenience. -/// It differs from the above function only in what arguments it +/// It differs from the above function only in what arguments it /// accepts. ///\param name - IN: Name of property to remove - \c std::string // Programmer: Binh-Minh Ribler - April, 2004 @@ -575,7 +575,7 @@ void PropList::removeProp(const string& name) const // Function: PropList::operator== ///\brief Compares this property list or class against the given list or class. ///\param rhs - IN: Reference to the property list to compare -///\return true if the property lists or classes are equal, and +///\return true if the property lists or classes are equal, and /// false, otherwise. ///\exception H5::PropListIException // Programmer: Binh-Minh Ribler - April, 2004 @@ -620,7 +620,7 @@ PropList PropList::getClassParent() const // ID reference counting mechanism - June 1, 2004 //-------------------------------------------------------------------------- PropList::~PropList() -{ +{ // The property list id will be closed properly try { decRefCount(); @@ -628,7 +628,7 @@ PropList::~PropList() catch (Exception close_error) { cerr << "PropList::~PropList - " << close_error.getDetailMsg() << endl; } -} +} #ifndef H5_NO_NAMESPACE } // end namespace diff --git a/c++/src/H5PropList.h b/c++/src/H5PropList.h index 84883ad..35087a0 100644 --- a/c++/src/H5PropList.h +++ b/c++/src/H5PropList.h @@ -25,7 +25,7 @@ class H5_DLLCPP PropList : public IdComponent { // Default property list static const PropList DEFAULT; - // Creates a property list of a given type or creates a copy of an + // Creates a property list of a given type or creates a copy of an // existing property list giving the property list id. PropList(const hid_t plist_id); diff --git a/c++/src/H5StrType.cpp b/c++/src/H5StrType.cpp index 4bd946d..04fb147 100644 --- a/c++/src/H5StrType.cpp +++ b/c++/src/H5StrType.cpp @@ -60,18 +60,18 @@ StrType::StrType( const PredType& pred_type ) : AtomType() ///\param existing_id - IN: Id of an existing datatype ///\exception H5::DataTypeIException // Description -// The 1st argument could have been skipped, but this -// constructor will collide with the one that takes an +// The 1st argument could have been skipped, but this +// constructor will collide with the one that takes an // existing id. // // Update: by passing 'size' by reference will avoid the // clashing problem, so the 1st argument can actually be -// omitted. This constructor should be replaced by the +// omitted. This constructor should be replaced by the // other after announcing. - May, 2004 -///\note +///\note /// This constructor will be obsolete in later releases, /// please use StrType( const size_t& size ) instead. -// Programmer Binh-Minh Ribler - 2000 +// Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- StrType::StrType( const PredType& pred_type, const size_t size ) : AtomType() { @@ -124,7 +124,7 @@ StrType::StrType( const DataSet& dataset ) : AtomType () //-------------------------------------------------------------------------- // Function: StrType::getCset -///\brief Retrieves the character set type of this string datatype. +///\brief Retrieves the character set type of this string datatype. ///\return Character set type, which can be: /// \li \c H5T_CSET_ASCII (0) - Character set is US ASCII. ///\exception H5::DataTypeIException @@ -144,7 +144,7 @@ H5T_cset_t StrType::getCset() const //-------------------------------------------------------------------------- // Function: StrType::setCset -///\brief Sets character set to be used. +///\brief Sets character set to be used. ///\param cset - IN: character set type ///\exception H5::DataTypeIException /// \li \c H5T_CSET_ASCII (0) - Character set is US ASCII. @@ -162,7 +162,7 @@ void StrType::setCset( H5T_cset_t cset ) const //-------------------------------------------------------------------------- // Function: StrType::getCset -///\brief Retrieves the storage mechanism for of this string datatype. +///\brief Retrieves the storage mechanism for of this string datatype. ///\return String storage mechanism, which can be: /// \li \c H5T_STR_NULLTERM (0) - Null terminate (as C does) /// \li \c H5T_STR_NULLPAD (0) - Pad with zeros @@ -177,7 +177,7 @@ H5T_str_t StrType::getStrpad() const // Returns a valid string padding type if successful if( strpad == H5T_STR_ERROR ) { - throw DataTypeIException("StrType::getStrpad", + throw DataTypeIException("StrType::getStrpad", "H5Tget_strpad failed - returned H5T_STR_ERROR"); } return( strpad ); diff --git a/c++/src/H5StrType.h b/c++/src/H5StrType.h index fbf4ac4..aef797d 100644 --- a/c++/src/H5StrType.h +++ b/c++/src/H5StrType.h @@ -31,25 +31,25 @@ class H5_DLLCPP StrType : public AtomType { // Creates a string type with specified length - will be obsolete StrType(const PredType& pred_type, const size_t size); - // Gets the string datatype of the specified dataset + // Gets the string datatype of the specified dataset StrType(const DataSet& dataset); - // Retrieves the character set type of this string datatype. + // Retrieves the character set type of this string datatype. H5T_cset_t getCset() const; - // Sets character set to be used. + // Sets character set to be used. void setCset(H5T_cset_t cset) const; - // Retrieves the string padding method for this string datatype. + // Retrieves the string padding method for this string datatype. H5T_str_t getStrpad() const; - // Defines the storage mechanism for character strings. + // Defines the storage mechanism for character strings. void setStrpad(H5T_str_t strpad) const; // Returns this class name virtual string fromClass () const { return ("StrType"); } - // default constructor + // default constructor StrType(); // Creates a string datatype using an existing id diff --git a/c++/src/H5VarLenType.cpp b/c++/src/H5VarLenType.cpp index 076ba12..547bc8a 100644 --- a/c++/src/H5VarLenType.cpp +++ b/c++/src/H5VarLenType.cpp @@ -58,7 +58,7 @@ VarLenType::VarLenType(const VarLenType& original) : DataType(original) {} ///\param base_type - IN: Pointer to existing datatype ///\exception H5::DataTypeIException // Description -// DataType passed by pointer to avoid clashing with copy +// DataType passed by pointer to avoid clashing with copy // constructor. // Programmer Binh-Minh Ribler - May, 2004 //-------------------------------------------------------------------------- |