Skip to content

Commit 1674897

Browse files
update documentation
- update documentation for `writeAttribute()` - add documentation for `exists()` (thx @ax3l)
1 parent d31a7f1 commit 1674897

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

src/include/splash/DataCollector.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,7 @@ namespace splash
366366
* @param type Type information for data.
367367
* @param dataName Name of the dataset in group \p id to write attribute to.
368368
* If dataName is NULL, the attribute is written for the iteration group.
369+
* If the path dataName does not yet exist, missing groups will be created.
369370
* @param attrName Name of the attribute.
370371
* @param buf Buffer to be written as attribute.
371372
*/

src/include/splash/core/DCGroup.hpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ namespace splash
5959
H5Handle openCreate(H5Handle base, std::string path) throw (DCException);
6060
void close() throw (DCException);
6161

62+
/** Check if a Group or Dataset Within a Group exist
63+
*
64+
* @param base open file handle
65+
* @param path to either a group or data set
66+
* @return true if either a dataset or a group exists at path
67+
*/
6268
static bool exists(H5Handle base, std::string path);
6369
static void remove(H5Handle base, std::string path) throw (DCException);
6470

0 commit comments

Comments
 (0)