chizeta/cnorxz
chizeta/cnorxz
0
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

hdf5: fix doxy errors + remove some unused code
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details

Browse source
This commit is contained in:
Christian Zimmermann 2024-02-02 15:11:03 +01:00
parent c46d9b1772
commit 27466f6ef1
4 changed files with 27 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/opt/hdf5/include/h5_dataset.h
View file

@ -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);

4
src/opt/hdf5/include/h5_file.h
View file

@ -28,12 +28,10 @@ namespace CNORXZ
class File : public Group
{
public:
typedef URange<String> 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);

23
src/opt/hdf5/include/h5_group.h
View file

@ -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<T>& 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 <class F>
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 <class F>
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 <class F>
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 <class F>
decltype(auto) iterRecursive(F&& f);
@ -147,6 +147,10 @@ namespace CNORXZ
MArray<ContentPtr> mCont; /**< Group elements. */
/** Recursion helper functon.
@param c Group element.
@param f Function to be executed.
*/
template <typename C, class F>
static void recursion(const C& c, F&& f)
{
@ -159,8 +163,17 @@ namespace CNORXZ
}
}
/** Setup group content. */
void mkCont();
/** Get index to requested group element (const).
@param name Element name.
*/
AIndex<ContentPtr> getIndexTo(const String& name) const;
/** Get index to requested group element.
@param name Element name.
*/
BIndex<ContentPtr> getIndexTo(const String& name);
};
}

10
src/opt/hdf5/include/h5_table.h
View file

@ -25,12 +25,12 @@ namespace CNORXZ
class Table : public ContentBase
{
public:
typedef std::pair<SizeT,String> FieldID;
typedef std::pair<SizeT,String> 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<DType> 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 <class F>
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.
*/