// 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. *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef _H5PropList_H
#define _H5PropList_H

#ifndef H5_NO_NAMESPACE
namespace H5 {
#endif

class H5_DLLCPP PropList : public IdComponent {
   public:
	// Default property list
        static const PropList DEFAULT;

	// Creates a property list of a given type or creates a copy of an 
	// existing property list giving the property list id
	PropList( const hid_t plist_id );

	// Default constructor: creates a PropList object - this object
	// does not represent any property list yet.
	PropList();

	// Copy constructor: creates a copy of a PropList object.
	PropList( const PropList& original );

	// Makes a copy of the given property list.
	void copy( const PropList& like_plist );

	// Make a copy of the given property list using assignment statement
	PropList& operator=( const PropList& rhs );

	// Copies a property from one property list or property class to another
	void copyProp( PropList& dest, PropList& src, const string& name) const;
	void copyProp( PropList& dest, PropList& src, const char* name) const;

	// Gets the class of this property list, i.e. H5P_FILE_CREATE,
	// H5P_FILE_ACCESS, ...
	hid_t getClass() const;

	/// Query the existance of a property in a property object.
	bool propExist(const char* name) const;
	bool propExist(const string& name) const;

	void closeClass() const;

	void getProperty(const char* name, void* value) const;
	string getProperty(const char* name) const;
	void getProperty(const string& name, void* value) const;
	string getProperty(const string& name) const;

	size_t getPropSize(const char *name) const;
	size_t getPropSize(const string& name) const;

	string getClassName() const;

	size_t getNumProps() const;

	void setProperty(const char* name, void* charptr) const;
	void setProperty(const char* name, const char* value) const;
	void setProperty(const char* name, string& strg) const;
	void setProperty(const string& name, void* value) const;
	void setProperty(const string& name, string& strg) const;

	bool isAClass(const PropList& prop_class) const;

	void removeProp(const char *name) const;
	void removeProp(const string& name) const;

	bool operator==(const PropList& rhs) const;

	PropList getClassParent() const;

	// Used by the API to close the property list
	void p_close() const;

	virtual ~PropList();
};

#ifndef H5_NO_NAMESPACE
}
#endif
#endif  // _H5PropList_H