[svn-r12404] Purpose: Fix typos/formats

Description:
    Fixed typos and re-arranged some functions to be in sync with 1.6.

Platforms tested:
    Linux 2.4 (heping)
    SunOS 5.9 (shanti)
    AIX 5.1 (copper)
This commit is contained in:
Binh-Minh Ribler
2006-06-05 11:17:36 -05:00
parent f5a16e9bfa
commit 32d3e6f04f
38 changed files with 381 additions and 313 deletions

View File

@@ -24,47 +24,44 @@ class H5_DLLCPP DSetMemXferPropList : public PropList {
public:
static const DSetMemXferPropList DEFAULT;
// Creates a dataset memory and transfer property list
// Creates a dataset memory and transfer property list.
DSetMemXferPropList();
// Copy constructor: creates a copy of a DSetMemXferPropList object
DSetMemXferPropList( const DSetMemXferPropList& orig );
// Sets type conversion and background buffers
// Sets type conversion and background buffers.
void setBuffer( size_t size, void* tconv, void* bkg ) const;
// Reads buffer settings
// Reads buffer settings.
size_t getBuffer( void** tconv, void** bkg ) const;
// Sets the dataset transfer property list status to TRUE or FALSE
void setPreserve( bool status ) const;
// Checks status of the dataset transfer property list
bool getPreserve() const;
// Sets B-tree split ratios for a dataset transfer property list
// Sets B-tree split ratios for a dataset transfer property list.
void setBtreeRatios( double left, double middle, double right ) const;
// Gets B-tree split ratios for a dataset transfer property list
// Gets B-tree split ratios for a dataset transfer property list.
void getBtreeRatios( double& left, double& middle, double& right ) const;
// Sets an exception handling callback for datatype conversion
// Sets the dataset transfer property list status to TRUE or FALSE.
void setPreserve( bool status ) const;
// Checks status of the dataset transfer property list.
bool getPreserve() const;
// Sets an exception handling callback for datatype conversion.
void setTypeConvCB( H5T_conv_except_func_t op, void *user_data) const;
// Gets the exception handling callback for datatype conversion
// Gets the exception handling callback for datatype conversion.
void getTypeConvCB( H5T_conv_except_func_t *op, void **user_data) const;
// Sets the memory manager for variable-length datatype
// allocation in H5Dread and H5Dvlen_reclaim
// allocation in H5Dread and H5Dvlen_reclaim.
void setVlenMemManager( H5MM_allocate_t alloc, void* alloc_info,
H5MM_free_t free, void* free_info ) const;
// alloc and free are set to NULL, indicating that system
// malloc and free are to be used
// malloc and free are to be used.
void setVlenMemManager() const;
// Gets the memory manager for variable-length datatype
// allocation in H5Dread and H5Tvlen_reclaim
// allocation in H5Dread and H5Tvlen_reclaim.
void getVlenMemManager( H5MM_allocate_t& alloc, void** alloc_info,
H5MM_free_t& free, void** free_info ) const;
@@ -94,12 +91,15 @@ class H5_DLLCPP DSetMemXferPropList : public PropList {
// Determines whether error-detection is enabled for dataset reads.
H5Z_EDC_t getEDCCheck();
// Returns this class name
// Returns this class name.
virtual H5std_string fromClass () const { return("DSetMemXferPropList"); }
// Copy constructor: makes a copy of a DSetMemXferPropList object.
DSetMemXferPropList(const DSetMemXferPropList& orig);
// Creates a copy of an existing dataset memory and transfer
// property list using the property list id.
DSetMemXferPropList (const hid_t plist_id);
DSetMemXferPropList(const hid_t plist_id);
// Noop destructor
virtual ~DSetMemXferPropList();