mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
[svn-r29322] Purpose: Remove obsoletes
Description:
Removed obsolete functions from the documentation. They are still
in the code, however, until the next two releases, just in case.
Platforms tested:
Linux/32 2.6 (jam)
Linux/64 (platypus)
Darwin (osx1010test)
This commit is contained in:
Binh-Minh Ribler
parent
767520bfe2
commit
36c4634606
@ -451,17 +451,18 @@ ssize_t Attribute::getName(H5std_string& attr_name, size_t len) const
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: Attribute::getName
|
||||
///\brief This function is replaced by the previous function, which
|
||||
/// provides more convenient prototype. It will be removed
|
||||
/// in future release.
|
||||
///\param len - IN: Desired length of the name
|
||||
///\param attr_name - OUT: Buffer for the name string
|
||||
///\return Actual length of the attribute name
|
||||
///\exception H5::AttributeIException
|
||||
// Programmer Binh-Minh Ribler - Nov, 2001
|
||||
// Function: Attribute::getName
|
||||
// Purpose This function is replaced by the previous function, which
|
||||
// provides more convenient prototype. It will be removed
|
||||
// in future release.
|
||||
// Param len - IN: Desired length of the name
|
||||
// Param attr_name - OUT: Buffer for the name string
|
||||
// Return Actual length of the attribute name
|
||||
// Exception H5::AttributeIException
|
||||
// Programmer Binh-Minh Ribler - Nov, 2001
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
ssize_t Attribute::getName( size_t len, H5std_string& attr_name ) const
|
||||
{
|
||||
|
||||
@ -496,14 +496,17 @@ void CommonFG::mount(const char* name, const H5File& child, const PropList& plis
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: CommonFG::mount
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param name - IN: Name of the group
|
||||
///\param child - IN: File to mount
|
||||
///\param plist - IN: Property list to use
|
||||
///\exception H5::FileIException or H5::GroupIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param name - IN: Name of the group
|
||||
// Param child - IN: File to mount
|
||||
// Param plist - IN: Property list to use
|
||||
// Exception H5::FileIException or H5::GroupIException
|
||||
// Programmer Binh-Minh Ribler - 2000
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void CommonFG::mount(const char* name, H5File& child, PropList& plist) const
|
||||
{
|
||||
@ -523,10 +526,13 @@ void CommonFG::mount(const H5std_string& name, const H5File& child, const PropLi
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: CommonFG::mount
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Programmer Binh-Minh Ribler - 2014
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void CommonFG::mount(const H5std_string& name, H5File& child, PropList& plist) const
|
||||
{
|
||||
|
||||
@ -323,12 +323,15 @@ hsize_t DataSet::getVlenBufSize(const DataType& type, const DataSpace& space ) c
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: DataSet::getVlenBufSize
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\return Amount of storage
|
||||
///\exception H5::DataSetIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Return Amount of storage
|
||||
// Exception H5::DataSetIException
|
||||
// Programmer Binh-Minh Ribler - 2000
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
hsize_t DataSet::getVlenBufSize( DataType& type, DataSpace& space ) const
|
||||
{
|
||||
@ -618,16 +621,19 @@ void DataSet::fillMemBuf(const void *fill, const DataType& fill_type, void *buf,
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: DataSet::fillMemBuf
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param fill - IN: Pointer to fill value to use - default NULL
|
||||
///\param fill_type - IN: Datatype of the fill value
|
||||
///\param buf - IN/OUT: Memory buffer to fill selection within
|
||||
///\param buf_type - IN: Datatype of the elements in buffer
|
||||
///\param space - IN: Dataspace describing memory buffer & containing selection to use
|
||||
///\exception H5::DataSetIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param fill - IN: Pointer to fill value to use - default NULL
|
||||
// Param fill_type - IN: Datatype of the fill value
|
||||
// Param buf - IN/OUT: Memory buffer to fill selection within
|
||||
// Param buf_type - IN: Datatype of the elements in buffer
|
||||
// Param space - IN: Dataspace describing memory buffer & containing selection to use
|
||||
// Exception H5::DataSetIException
|
||||
// Programmer Binh-Minh Ribler - 2000
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void DataSet::fillMemBuf(const void *fill, DataType& fill_type, void *buf, DataType& buf_type, DataSpace& space)
|
||||
{
|
||||
@ -656,14 +662,17 @@ void DataSet::fillMemBuf(void *buf, const DataType& buf_type, const DataSpace& s
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: DataSet::fillMemBuf
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param buf - IN/OUT: Memory buffer to fill selection within
|
||||
///\param buf_type - IN: Datatype of the elements in buffer
|
||||
///\param space - IN: Dataspace describing memory buffer & containing selection to use
|
||||
///\exception H5::DataSetIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param buf - IN/OUT: Memory buffer to fill selection within
|
||||
// Param buf_type - IN: Datatype of the elements in buffer
|
||||
// Param space - IN: Dataspace describing memory buffer & containing selection to use
|
||||
// Exception H5::DataSetIException
|
||||
// Programmer Binh-Minh Ribler - 2000
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void DataSet::fillMemBuf(void *buf, DataType& buf_type, DataSpace& space)
|
||||
{
|
||||
|
||||
@ -340,12 +340,15 @@ void DataSpace::extentCopy (const DataSpace& dest_space) const
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: DataSpace::extentCopy
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const. This wrapper will be removed in future release.
|
||||
///\param dest_space - IN: Dataspace to copy from
|
||||
///\exception H5::DataSpaceIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const. This wrapper will be removed in future release.
|
||||
// Param dest_space - IN: Dataspace to copy from
|
||||
// Exception H5::DataSpaceIException
|
||||
// Programmer Binh-Minh Ribler - 2000
|
||||
// Modification
|
||||
// Modified to call its replacement. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void DataSpace::extentCopy( DataSpace& dest_space ) const
|
||||
{
|
||||
|
||||
@ -304,13 +304,16 @@ void DataType::commit(const H5Location& loc, const char* name)
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: DataType::commit
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param loc - IN: A location (file, dataset, datatype, or group)
|
||||
///\param name - IN: Name of the datatype
|
||||
///\exception H5::DataTypeIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param loc - IN: A location (file, dataset, datatype, or group)
|
||||
// Param name - IN: Name of the datatype
|
||||
// Exception H5::DataTypeIException
|
||||
// Programmer Binh-Minh Ribler - Jan, 2007
|
||||
// Modification
|
||||
// Planned for removal. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void DataType::commit(H5Location& loc, const char* name)
|
||||
{
|
||||
@ -331,13 +334,16 @@ void DataType::commit(const H5Location& loc, const H5std_string& name)
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: DataType::commit
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param loc - IN: A location (file, dataset, datatype, or group)
|
||||
///\param name - IN: Name of the datatype
|
||||
///\exception H5::DataTypeIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param loc - IN: A location (file, dataset, datatype, or group)
|
||||
// Param name - IN: Name of the datatype
|
||||
// Exception H5::DataTypeIException
|
||||
// Programmer Binh-Minh Ribler - Jan, 2007
|
||||
// Modification
|
||||
// Planned for removal. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void DataType::commit(H5Location& loc, const H5std_string& name)
|
||||
{
|
||||
|
||||
@ -330,16 +330,18 @@ void FileAccPropList::setSplit(const FileAccPropList& meta_plist, const FileAccP
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: FileAccPropList::setSplit
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param meta_plist - IN: File access plist for the metadata file
|
||||
///\param raw_plist - IN: File access plist for the raw data file
|
||||
///\param meta_ext - IN: Metadata filename extension as \c char*
|
||||
///\param raw_ext - IN: Raw data filename extension as \c char*
|
||||
///\exception H5::PropListIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param meta_plist - IN: File access plist for the metadata file
|
||||
// Param raw_plist - IN: File access plist for the raw data file
|
||||
// Param meta_ext - IN: Metadata filename extension as \c char*
|
||||
// Param raw_ext - IN: Raw data filename extension as \c char*
|
||||
// Exception H5::PropListIException
|
||||
// Programmer: Binh-Minh Ribler - April, 2004
|
||||
// Note: Retiring April, 2014
|
||||
// Modification
|
||||
// Planned for removal. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void FileAccPropList::setSplit(FileAccPropList& meta_plist, FileAccPropList& raw_plist, const char* meta_ext, const char* raw_ext ) const
|
||||
{
|
||||
@ -364,16 +366,17 @@ void FileAccPropList::setSplit(const FileAccPropList& meta_plist, const FileAccP
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: FileAccPropList::setSplit
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const's. This wrapper will be removed in future release.
|
||||
///\param meta_plist - IN: File access plist for the metadata file
|
||||
///\param raw_plist - IN: File access plist for the raw data file
|
||||
///\param meta_ext - IN: Metadata filename extension as \c string
|
||||
///\param raw_ext - IN: Raw data filename extension as \c string
|
||||
///\exception H5::PropListIException
|
||||
// Programmer: Binh-Minh Ribler - April, 2004
|
||||
// Note: Retiring April, 2014
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param meta_plist - IN: File access plist for the metadata file
|
||||
// Param raw_plist - IN: File access plist for the raw data file
|
||||
// Param meta_ext - IN: Metadata filename extension as \c char*
|
||||
// Param raw_ext - IN: Raw data filename extension as \c char*
|
||||
// Exception H5::PropListIException
|
||||
// Modification
|
||||
// Planned for removal. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void FileAccPropList::setSplit(FileAccPropList& meta_plist, FileAccPropList& raw_plist, const H5std_string& meta_ext, const H5std_string& raw_ext ) const
|
||||
{
|
||||
|
||||
@ -467,15 +467,17 @@ void H5File::getVFDHandle(const FileAccPropList& fapl, void **file_handle) const
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: H5File::getVFDHandle
|
||||
///\brief This is an overloaded member function, kept for backward
|
||||
/// compatibility. It differs from the above function in that it
|
||||
/// misses const. This wrapper will be removed in future release.
|
||||
///\param fapl - File access property list
|
||||
///\param file_handle - Pointer to the file handle being used by
|
||||
/// the low-level virtual file driver
|
||||
///\exception H5::FileIException
|
||||
// Purpose This is an overloaded member function, kept for backward
|
||||
// compatibility. It differs from the above function in that it
|
||||
// misses const's. This wrapper will be removed in future release.
|
||||
// Param fapl - File access property list
|
||||
// Param file_handle - Pointer to the file handle being used by
|
||||
// the low-level virtual file driver
|
||||
// Exception H5::FileIException
|
||||
// Programmer Binh-Minh Ribler - May 2004
|
||||
// Note: Retiring April, 2014
|
||||
// Modification
|
||||
// Planned for removal. -BMR, 2014/04/16
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
void H5File::getVFDHandle(FileAccPropList& fapl, void **file_handle) const
|
||||
{
|
||||
|
||||
@ -58,10 +58,10 @@ StrType::StrType( const PredType& pred_type ) : AtomType()
|
||||
|
||||
//--------------------------------------------------------------------------
|
||||
// Function: StrType overloaded constructor
|
||||
///\brief Creates a string datatype with a specified length
|
||||
///\param pred_type - IN: String predefined type to replicate.
|
||||
///\param size - IN: Length of the new string type
|
||||
///\exception H5::DataTypeIException
|
||||
// Purpose Creates a string datatype with a specified length
|
||||
// Param pred_type - IN: String predefined type to replicate.
|
||||
// Param size - IN: Length of the new string type
|
||||
// Exception H5::DataTypeIException
|
||||
// Description
|
||||
// The 1st argument could have been skipped, but this
|
||||
// constructor will collide with the one that takes an
|
||||
@ -71,10 +71,13 @@ StrType::StrType( const PredType& pred_type ) : AtomType()
|
||||
// avoid the clashing problem, that doesn't eliminate the
|
||||
// the 1st argument but it's simpler for the user to type
|
||||
// a '0' than PredType::C_S1. - Dec 2, 2005
|
||||
///\note
|
||||
/// The use of this constructor can be shortened by using
|
||||
/// its overloaded below as StrType(0, size).
|
||||
// Note
|
||||
// The use of this constructor can be shortened by using
|
||||
// its overloaded below as StrType(0, size).
|
||||
// Programmer Binh-Minh Ribler - 2000
|
||||
// Modification
|
||||
// Planned for removal. -BMR, 2005/12/02
|
||||
// Removed from documentation. -BMR, 2016/03/07
|
||||
//--------------------------------------------------------------------------
|
||||
StrType::StrType( const PredType& pred_type, const size_t& size ) : AtomType()
|
||||
{
|
||||
@ -96,8 +99,8 @@ StrType::StrType( const PredType& pred_type, const size_t& size ) : AtomType()
|
||||
/// previous constructor, such as:
|
||||
/// StrType atype(0, size) instead of
|
||||
/// StrType atype(PredType::C_S1, size)
|
||||
///\note
|
||||
/// This constructor may replace the previous one in the future.
|
||||
// Note
|
||||
// This constructor replaced the previous one.
|
||||
// Programmer Binh-Minh Ribler - Nov 28, 2005
|
||||
//--------------------------------------------------------------------------
|
||||
StrType::StrType( const int dummy, const size_t& size ) : AtomType()
|
||||
|
||||
Loading…
Reference in New Issue
Block a user