diff --git a/src/opt/hdf5/include/h5_dataset.h b/src/opt/hdf5/include/h5_dataset.h index ae998d6..671af1b 100644 --- a/src/opt/hdf5/include/h5_dataset.h +++ b/src/opt/hdf5/include/h5_dataset.h @@ -28,7 +28,7 @@ namespace CNORXZ DEFAULT_MEMBERS(Dataset); /**< Default constructors and assignments. */ /** Construct the class. - @param _name Dataset name. + @param name Dataset name. @param _parent Parent content object. */ Dataset(const String& name, const ContentBase* _parent); @@ -79,7 +79,7 @@ namespace CNORXZ DEFAULT_MEMBERS(SDataset); /**< Default constructors and assignments. */ /** Construct the class. - @param _name Dataset name. + @param name Dataset name. @param _parent Parent content object. */ SDataset(const String& name, const ContentBase* _parent); diff --git a/src/opt/hdf5/include/h5_file.h b/src/opt/hdf5/include/h5_file.h index 98a5b91..9ab01b2 100644 --- a/src/opt/hdf5/include/h5_file.h +++ b/src/opt/hdf5/include/h5_file.h @@ -28,12 +28,10 @@ namespace CNORXZ class File : public Group { public: - typedef URange RangeT; - DEFAULT_MEMBERS(File); /**< Default constructors and assignments. */ /** Construct the class. - @param _name Path to the hdf5 file to be handled. + @param fname Path to the hdf5 file to be handled. @param _ro Open in read-only mode if true, otherwise have write access. */ File(const String& fname, bool _ro = true); diff --git a/src/opt/hdf5/include/h5_group.h b/src/opt/hdf5/include/h5_group.h index 41d297a..7fc4629 100644 --- a/src/opt/hdf5/include/h5_group.h +++ b/src/opt/hdf5/include/h5_group.h @@ -28,7 +28,7 @@ namespace CNORXZ DEFAULT_MEMBERS(Group); /**< Default constructors and assignments. */ /** Construct the class. - @param _name Group name. + @param gname Group name. @param _parent Parent content object. */ Group(const String& gname, const ContentBase* _parent); @@ -120,25 +120,25 @@ namespace CNORXZ Group& addDataset(const String& name, const ArrayBase& data); /** Iterate over all group elements (const). - @param F function object to be executed on each group element. + @param f function object to be executed on each group element. */ template decltype(auto) iter(F&& f) const; /** Iterate recursively over all group elements (const). - @param F function object to be executed on each group element. + @param f function object to be executed on each group element. */ template decltype(auto) iterRecursive(F&& f) const; /** Iterate over all group elements. - @param F function object to be executed on each group element. + @param f function object to be executed on each group element. */ template decltype(auto) iter(F&& f); /** Iterate recursively over all group elements. - @param F function object to be executed on each group element. + @param f function object to be executed on each group element. */ template decltype(auto) iterRecursive(F&& f); @@ -147,6 +147,10 @@ namespace CNORXZ MArray mCont; /**< Group elements. */ + /** Recursion helper functon. + @param c Group element. + @param f Function to be executed. + */ template static void recursion(const C& c, F&& f) { @@ -158,9 +162,18 @@ namespace CNORXZ } } } - + + /** Setup group content. */ void mkCont(); + + /** Get index to requested group element (const). + @param name Element name. + */ AIndex getIndexTo(const String& name) const; + + /** Get index to requested group element. + @param name Element name. + */ BIndex getIndexTo(const String& name); }; } diff --git a/src/opt/hdf5/include/h5_table.h b/src/opt/hdf5/include/h5_table.h index 79d193f..cdccc23 100644 --- a/src/opt/hdf5/include/h5_table.h +++ b/src/opt/hdf5/include/h5_table.h @@ -25,12 +25,12 @@ namespace CNORXZ class Table : public ContentBase { public: - typedef std::pair FieldID; + typedef std::pair FieldID; /**< Meta data type of fields range. */ DEFAULT_MEMBERS(Table); /**< Default constructors and assignments. */ /** Construct the class. - @param _name Table name. + @param name Table name. @param _parent Parent content object. */ Table(const String& name, const ContentBase* _parent); @@ -84,7 +84,7 @@ namespace CNORXZ MArray read() const; /** Iterate over table records. - @param F function object to be executed on each table record. + @param f function object to be executed on each table record. */ template decltype(auto) iterRecords(F&& f) const; @@ -128,13 +128,13 @@ namespace CNORXZ DEFAULT_MEMBERS(STable); /**< Default constructors and assignments. */ /** Construct the class. - @param _name Table name. + @param name Table name. @param _parent Parent content object. */ STable(const String& name, const ContentBase* _parent); /** Construct the class. - @param _name Table name. + @param name Table name. @param _parent Parent content object. @param fnames Field names. */