summaryrefslogtreecommitdiffstats
path: root/c++/src/H5DataType.h
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2020-09-30 14:27:10 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2020-09-30 14:27:10 (GMT)
commitb2d661b508a7fc7a2592c13bc6bdc175551f075d (patch)
tree13baeb0d83a7c2a4c6299993c182b1227c2f6114 /c++/src/H5DataType.h
parent29ab58b58dce556639ea3154e262895773a8a8df (diff)
downloadhdf5-b2d661b508a7fc7a2592c13bc6bdc175551f075d.zip
hdf5-b2d661b508a7fc7a2592c13bc6bdc175551f075d.tar.gz
hdf5-b2d661b508a7fc7a2592c13bc6bdc175551f075d.tar.bz2
Clang-format of source files
Diffstat (limited to 'c++/src/H5DataType.h')
-rw-r--r--c++/src/H5DataType.h211
1 files changed, 109 insertions, 102 deletions
diff --git a/c++/src/H5DataType.h b/c++/src/H5DataType.h
index e4d9e4b..32badfe 100644
--- a/c++/src/H5DataType.h
+++ b/c++/src/H5DataType.h
@@ -26,152 +26,159 @@ namespace H5 {
*/
// Inheritance: DataType -> H5Object -> H5Location -> IdComponent
class H5_DLLCPP DataType : public H5Object {
- public:
- // Creates a datatype given its class and size
- DataType(const H5T_class_t type_class, size_t size);
+ public:
+ // Creates a datatype given its class and size
+ DataType(const H5T_class_t type_class, size_t size);
- // Copy constructor - same as the original DataType.
- DataType(const DataType& original);
+ // Copy constructor - same as the original DataType.
+ DataType(const DataType &original);
- // Creates a copy of a predefined type
- DataType(const PredType& pred_type);
+ // Creates a copy of a predefined type
+ DataType(const PredType &pred_type);
- // Constructors to open a generic named datatype at a given location.
- DataType(const H5Location& loc, const char* name);
- DataType(const H5Location& loc, const H5std_string& name);
+ // Constructors to open a generic named datatype at a given location.
+ DataType(const H5Location &loc, const char *name);
+ DataType(const H5Location &loc, const H5std_string &name);
- // Creates a datatype by way of dereference.
- DataType(const H5Location& loc, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
-// DataType(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const PropList& plist = PropList::DEFAULT);
+ // Creates a datatype by way of dereference.
+ DataType(const H5Location &loc, const void *ref, H5R_type_t ref_type = H5R_OBJECT,
+ const PropList &plist = PropList::DEFAULT);
+ // DataType(const Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT, const
+ // PropList& plist = PropList::DEFAULT);
- // Closes this datatype.
- virtual void close();
+ // Closes this datatype.
+ virtual void close();
- // Copies an existing datatype to this datatype object.
- void copy(const DataType& like_type);
+ // Copies an existing datatype to this datatype object.
+ void copy(const DataType &like_type);
- // Copies the datatype of dset to this datatype object.
- void copy(const DataSet& dset);
+ // Copies the datatype of dset to this datatype object.
+ void copy(const DataSet &dset);
- // Returns a DataType instance by decoding the binary object
- // description of this datatype.
- virtual DataType* decode() const;
+ // Returns a DataType instance by decoding the binary object
+ // description of this datatype.
+ virtual DataType *decode() const;
- // Creates a binary object description of this datatype.
- void encode();
+ // Creates a binary object description of this datatype.
+ void encode();
- // Returns the datatype class identifier.
- H5T_class_t getClass() const;
+ // Returns the datatype class identifier.
+ H5T_class_t getClass() const;
- // Commits a transient datatype to a file; this datatype becomes
- // a named datatype which can be accessed from the location.
- void commit(const H5Location& loc, const char* name);
- void commit(const H5Location& loc, const H5std_string& name);
+ // Commits a transient datatype to a file; this datatype becomes
+ // a named datatype which can be accessed from the location.
+ void commit(const H5Location &loc, const char *name);
+ void commit(const H5Location &loc, const H5std_string &name);
- // These two overloaded functions are kept for backward compatibility
- // only; they missed the const - removed from 1.8.18 and 1.10.1
- //void commit(H5Location& loc, const char* name);
- //void commit(H5Location& loc, const H5std_string& name);
+ // These two overloaded functions are kept for backward compatibility
+ // only; they missed the const - removed from 1.8.18 and 1.10.1
+ // void commit(H5Location& loc, const char* name);
+ // void commit(H5Location& loc, const H5std_string& name);
- // Determines whether this datatype is a named datatype or
- // a transient datatype.
- bool committed() const;
+ // Determines whether this datatype is a named datatype or
+ // a transient datatype.
+ bool committed() const;
- // 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;
+ // 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.
- void convert(const DataType& dest, size_t nelmts, void *buf, void *background, const PropList& plist=PropList::DEFAULT) const;
+ // Converts data from between specified datatypes.
+ void convert(const DataType &dest, size_t nelmts, void *buf, void *background,
+ const PropList &plist = PropList::DEFAULT) const;
- // Assignment operator
- DataType& operator=(const DataType& rhs);
+ // Assignment operator
+ DataType &operator=(const DataType &rhs);
- // Determines whether two datatypes are the same.
- bool operator==(const DataType& compared_type) const;
+ // Determines whether two datatypes are the same.
+ bool operator==(const DataType &compared_type) const;
- // Determines whether two datatypes are not the same.
- bool operator!=(const DataType& compared_type) const;
+ // Determines whether two datatypes are not the same.
+ bool operator!=(const DataType &compared_type) const;
- // Locks a datatype.
- void lock() const;
+ // Locks a datatype.
+ void lock() const;
- // Returns the size of a datatype.
- size_t getSize() const;
+ // Returns the size of a datatype.
+ size_t getSize() const;
- // Returns the base datatype from which a datatype is derived.
- // Note: not quite right for specific types yet???
- DataType getSuper() const;
+ // 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.
- void registerFunc(H5T_pers_t pers, const char* name, const DataType& dest, H5T_conv_t func) const;
- void registerFunc(H5T_pers_t pers, const H5std_string& name, const DataType& dest, H5T_conv_t func) const;
+ // Registers a conversion function.
+ void registerFunc(H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const;
+ void registerFunc(H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const;
- // Removes a conversion function from all conversion paths.
- void unregister(H5T_pers_t pers, const char* name, const DataType& dest, H5T_conv_t func) const;
- void unregister(H5T_pers_t pers, const H5std_string& name, const DataType& dest, H5T_conv_t func) const;
+ // Removes a conversion function from all conversion paths.
+ void unregister(H5T_pers_t pers, const char *name, const DataType &dest, H5T_conv_t func) const;
+ void unregister(H5T_pers_t pers, const H5std_string &name, const DataType &dest, H5T_conv_t func) const;
- // Tags an opaque datatype.
- void setTag(const char* tag) const;
- void setTag(const H5std_string& tag) const;
+ // Tags an opaque datatype.
+ void setTag(const char *tag) const;
+ void setTag(const H5std_string &tag) const;
- // Gets the tag associated with an opaque datatype.
- H5std_string getTag() const;
+ // Gets the tag associated with an opaque datatype.
+ H5std_string getTag() const;
- // Checks whether this datatype contains (or is) a certain type class.
- bool detectClass(H5T_class_t cls) const;
- static bool detectClass(const PredType& pred_type, H5T_class_t cls);
+ // Checks whether this datatype contains (or is) a certain type class.
+ bool detectClass(H5T_class_t cls) const;
+ static bool detectClass(const PredType &pred_type, H5T_class_t cls);
- // Checks whether this datatype is a variable-length string.
- bool isVariableStr() const;
+ // Checks whether this datatype is a variable-length string.
+ bool isVariableStr() const;
- // Returns a copy of the creation property list of a datatype.
- PropList getCreatePlist() const;
+ // Returns a copy of the creation property list of a datatype.
+ PropList getCreatePlist() const;
- ///\brief Returns this class name.
- virtual H5std_string fromClass () const { return("DataType"); }
+ ///\brief Returns this class name.
+ virtual H5std_string
+ fromClass() const
+ {
+ return ("DataType");
+ }
- // Creates a copy of an existing DataType using its id
- DataType(const hid_t type_id);
+ // Creates a copy of an existing DataType using its id
+ DataType(const hid_t type_id);
- // Default constructor
- DataType();
+ // Default constructor
+ DataType();
- // Determines whether this datatype has a binary object description.
- bool hasBinaryDesc() const;
+ // Determines whether this datatype has a binary object description.
+ bool hasBinaryDesc() const;
- // Gets the datatype id.
- virtual hid_t getId() const;
+ // Gets the datatype id.
+ virtual hid_t getId() const;
- // Destructor: properly terminates access to this datatype.
- virtual ~DataType();
+ // Destructor: properly terminates access to this datatype.
+ virtual ~DataType();
- protected:
+ protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
- hid_t id; // HDF5 datatype id
+ hid_t id; // HDF5 datatype id
- // Returns an id of a type by decoding the binary object
- // description of this datatype.
- hid_t p_decode() const;
+ // Returns an id of a type by decoding the binary object
+ // description of this datatype.
+ hid_t p_decode() const;
- // Sets the datatype id.
- virtual void p_setId(const hid_t new_id);
+ // Sets the datatype id.
+ virtual void p_setId(const hid_t new_id);
- // Opens a datatype and returns the id.
- hid_t p_opentype(const H5Location& loc, const char* dtype_name) const;
+ // Opens a datatype and returns the id.
+ hid_t p_opentype(const H5Location &loc, const char *dtype_name) const;
#endif // DOXYGEN_SHOULD_SKIP_THIS
- private:
- // Buffer for binary object description of this datatype, allocated
- // in DataType::encode and used in DataType::decode
- unsigned char *encoded_buf;
- size_t buf_size;
+ private:
+ // Buffer for binary object description of this datatype, allocated
+ // in DataType::encode and used in DataType::decode
+ unsigned char *encoded_buf;
+ size_t buf_size;
- // Friend function to set DataType id. For library use only.
- friend void f_DataType_setId(DataType* dtype, hid_t new_id);
+ // Friend function to set DataType id. For library use only.
+ friend void f_DataType_setId(DataType *dtype, hid_t new_id);
- void p_commit(hid_t loc_id, const char* name);
+ void p_commit(hid_t loc_id, const char *name);
}; // end of DataType
} // namespace H5