h5gt 0.2.0
C++ wrapper for HDF5 library (based on HighFive project)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
h5gt::DataSetCreateProps Class Reference
Inheritance diagram for h5gt::DataSetCreateProps:
h5gt::PropertyList< PropertyType::DATASET_CREATE >

Public Member Functions

void addExternalFile (const std::string &file, off_t offset=0, hsize_t size=0)
 map external binary file to a dataset
 
void addVirtualDataSet (const DataSpace &vSpace, const DataSet &srcDset, const DataSpace &srcSpace)
 map source dataset Spaces must have equal number of selected elements Spaces may be given from selection: Selection.getSpace() srcDset may be mapped external file
 
void setShuffle ()
 
void setDeflate (const unsigned &level)
 
void setChunk (const std::initializer_list< hsize_t > &items)
 
template<typename... Args>
void setChunk (hsize_t item, Args... args)
 
void setChunk (const std::vector< hsize_t > &dims)
 
size_t getExternalCount ()
 return number of external files
 
std::string getExternal (unsigned idx, off_t &offset, hsize_t &fileSize)
 retrieve info about external file under index 'idx'
 
size_t getVirtualCount ()
 return number of virtual datasets
 
std::string getVirtualDataSetName (size_t idx)
 resturn virtual (source) dataset name
 
std::string getVirtualFileName (size_t idx)
 
DataSpace getVirtualSrcSpace (size_t idx)
 
DataSpace getVirtualVSpace (size_t idx)
 
std::vector< hsize_t > getChunk (int max_ndims)
 
LayoutType getLayoutType ()
 
bool isCompact ()
 
bool isContiguous ()
 
bool isChunked ()
 
bool isVirtual ()
 
 PropertyList (const PropertyList< T > &other)
 
 PropertyList () noexcept
 
 PropertyList (PropertyList &&other) noexcept
 
 PropertyList (const hid_t &hid) noexcept
 
- Public Member Functions inherited from h5gt::PropertyList< PropertyType::DATASET_CREATE >
 PropertyList (const PropertyList< T > &other)
 
 PropertyList (PropertyList &&other) noexcept
 
PropertyListoperator= (const PropertyList< T > &other)
 
PropertyListoperator= (PropertyList &&other) noexcept
 
constexpr PropertyType getObjectType () const
 
hid_t getId (const bool &increaseRefCount=false) const
 

Static Public Member Functions

static DataSetCreateProps FromId (const hid_t &id, const bool &increaseRefCount=false)
 

Additional Inherited Members

- Protected Member Functions inherited from h5gt::PropertyList< PropertyType::DATASET_CREATE >
 PropertyList (const hid_t &hid) noexcept
 
void setExternalLinkPrefix (const std::string &prefix)
 setExternalLinkPrefix Let’s say you’ve created an external link in foo.h5 and the external link refers to a path name in file bar.h5. If (by intention or accident) the relative location of foo.h5 and bar.h5 changes, the external link becomes invalid, because the HDF5 library can’t locate the file bar.h5. To deal with a situation like that, you can create a prefix that you’d like to apply to the file names of external links before the library attempts to traverse them.
 
std::vector< hsize_t > getChunk (int max_ndims)
 
void initializeId ()
 
- Protected Attributes inherited from h5gt::PropertyList< PropertyType::DATASET_CREATE >
hid_t _hid
 

Member Function Documentation

◆ addExternalFile()

void h5gt::DataSetCreateProps::addExternalFile ( const std::string & file,
off_t offset = 0,
hsize_t size = 0 )
inline

map external binary file to a dataset

Parameters
filepath to the file
offsetoffset in bytes
sizeis the size of the part that is to be mapped (offset+size=fileSize) leave it as 0 to to map everything starting from the offset size == H5F_UNLIMITED means the external file can be of unlimited size and no more files can be added to the external files list

The documentation for this class was generated from the following files: