mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-29 04:09:39 +03:00
Binh-Minh Ribler
f5492ae03b
Add more C++ wrapper and documentation - incrementally check-in
Description
Added another overloaded constructor to StrType.
Added doxygen documentation to H5IdComponent.cpp.
Corrected some comments.
This is an incremental check-in to preserve the code, corresponding
tests will follow in a few weeks.
Platforms:
SunOS 5.7 (arabica)
Linux 2.4 (eirene)
Misc. update:
107 lines
4.8 KiB
C++
107 lines
4.8 KiB
C++
// C++ informative line for the emacs editor: -*- C++ -*-
|
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by the Board of Trustees of the University of Illinois. *
|
|
* All rights reserved. *
|
|
* *
|
|
* This file is part of HDF5. The full HDF5 copyright notice, including *
|
|
* terms governing use, modification, and redistribution, is contained in *
|
|
* the files COPYING and Copyright.html. COPYING can be found at the root *
|
|
* of the source code distribution tree; Copyright.html can be found at the *
|
|
* root level of an installed copy of the electronic HDF5 document set and *
|
|
* is linked from the top-level documents page. It can also be found at *
|
|
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
|
|
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
// Class DataSet inherits from AbstractDs and provides accesses to a dataset.
|
|
|
|
#ifndef _H5DataSet_H
|
|
#define _H5DataSet_H
|
|
|
|
#ifndef H5_NO_NAMESPACE
|
|
namespace H5 {
|
|
#endif
|
|
|
|
class H5_DLLCPP DataSet : public AbstractDs {
|
|
public:
|
|
// Gets the dataspace of this dataset.
|
|
virtual DataSpace getSpace() const;
|
|
|
|
// Gets the creation property list of this dataset.
|
|
DSetCreatPropList getCreatePlist() const;
|
|
|
|
// Gets the storage size of this dataset.
|
|
hsize_t getStorageSize() const;
|
|
|
|
// Returns the address of this dataset in the file.
|
|
haddr_t getOffset() const;
|
|
|
|
// Determines whether space has been allocated for a dataset.
|
|
void getSpaceStatus(H5D_space_status_t& status) const;
|
|
|
|
// not yet implemented??
|
|
hsize_t getVlenBufSize( DataType& type, DataSpace& space ) const;
|
|
void vlenReclaim( DataType& type, DataSpace& space, DSetMemXferPropList& xfer_plist, void* buf ) const;
|
|
|
|
// Reads the data of this dataset and stores it in the provided buffer.
|
|
// The memory and file dataspaces and the transferring property list
|
|
// can be defaults.
|
|
void read( void* buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT ) const;
|
|
void read( string& buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT ) const;
|
|
|
|
// Writes the buffered data to this dataset.
|
|
// The memory and file dataspaces and the transferring property list
|
|
// can be defaults.
|
|
void write( const void* buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT ) const;
|
|
void write( const string& buf, const DataType& mem_type, const DataSpace& mem_space = DataSpace::ALL, const DataSpace& file_space = DataSpace::ALL, const DSetMemXferPropList& xfer_plist = DSetMemXferPropList::DEFAULT ) const;
|
|
|
|
// Iterates the selected elements in the specified dataspace - not implemented in C++ style yet
|
|
int iterateElems( void* buf, const DataType& type, const DataSpace& space, H5D_operator_t op, void* op_data = NULL );
|
|
|
|
// Extends the dataset with unlimited dimension.
|
|
void extend( const hsize_t* size ) const;
|
|
|
|
// Fills a selection in memory with a value
|
|
void fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& space);
|
|
// Fills a selection in memory with zero
|
|
void fillMemBuf(void *buf, DataType& buf_type, DataSpace& space);
|
|
|
|
// Creates a reference to a named Hdf5 object in this object.
|
|
void* Reference(const char* name) const;
|
|
|
|
// Creates a reference to a named Hdf5 object or to a dataset region
|
|
// in this object.
|
|
void* Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_type = H5R_DATASET_REGION) const;
|
|
|
|
// Retrieves the type of object that an object reference points to.
|
|
H5G_obj_t getObjType(void *ref, H5R_type_t ref_type) const;
|
|
|
|
// Retrieves a dataspace with the region pointed to selected.
|
|
DataSpace getRegion(void *ref, H5R_type_t ref_type = H5R_DATASET_REGION) const;
|
|
|
|
// Creates a copy of an existing DataSet using its id.
|
|
DataSet(const hid_t existing_id);
|
|
|
|
// Used by the API to appropriately close a dataset.
|
|
virtual void p_close() const;
|
|
|
|
// Default constructor.
|
|
DataSet();
|
|
|
|
// Copy constructor.
|
|
DataSet( const DataSet& original );
|
|
|
|
virtual ~DataSet();
|
|
|
|
private:
|
|
// This function contains the common code that is used by
|
|
// getTypeClass and various API functions getXxxType
|
|
// defined in AbstractDs for generic datatype and specific
|
|
// sub-types
|
|
virtual hid_t p_getType() const;
|
|
};
|
|
#ifndef H5_NO_NAMESPACE
|
|
}
|
|
#endif
|
|
#endif
|