Hdf4Group Class Reference
The Hdf4Group class is a composite object to hierarchically store groups and datasets. More...
#include <Hdf4Group.h>
Inheritance diagram for Hdf4Group:
Public Member Functions | |
| virtual Hdf4Dataset * | addDataset (const std::string &name) |
| virtual Hdf4Group * | addGroup (const std::string &name) |
| virtual const std::vector < Hdf4Element * > & | getElements () const |
| virtual const Hdf4Element * | getElement (const std::string &name) const |
| virtual size_t | getNumElements () const |
| virtual bool | removeElement (const Hdf4Element *pElement) |
Protected Member Functions | |
| Hdf4Group (const std::string &name) | |
| virtual | ~Hdf4Group () |
Detailed Description
The Hdf4Group class is a composite object to hierarchically store groups and datasets.Definition at line 22 of file Hdf4Group.h.
Constructor & Destructor Documentation
| Hdf4Group::Hdf4Group | ( | const std::string & | name | ) | [explicit, protected] |
Creates an empty HDF group.
| virtual Hdf4Group::~Hdf4Group | ( | ) | [protected, virtual] |
Destroys the HDF group.
Member Function Documentation
| virtual Hdf4Dataset* Hdf4Group::addDataset | ( | const std::string & | name | ) | [virtual] |
Adds a dataset to the HDF group.
- Parameters:
-
name The name of the dataset to add.
- Returns:
- A pointer to the newly added HDF dataset. Returns NULL if the operation failed.
- See also:
- Hdf4Dataset::Hdf4Dataset()
| virtual Hdf4Group* Hdf4Group::addGroup | ( | const std::string & | name | ) | [virtual] |
| virtual const std::vector<Hdf4Element*>& Hdf4Group::getElements | ( | ) | const [virtual] |
Returns a vector of the group's elements.
- Returns:
- A vector of the group's elements.
| virtual const Hdf4Element* Hdf4Group::getElement | ( | const std::string & | name | ) | const [virtual] |
Non-recursively searches the group's element for a dataset matching the input name.
- Parameters:
-
name The name of the Hdf4Element to search for.
- Returns:
- A pointer to the element with the given name; NULL if it does not exist.
| virtual size_t Hdf4Group::getNumElements | ( | ) | const [virtual] |
Returns the number of Hdf4Elements in the group.
- Returns:
- Returns the number of elements in the group. Equivalent to getElements().size().
| virtual bool Hdf4Group::removeElement | ( | const Hdf4Element * | pElement | ) | [virtual] |
Removes an element from the group.
- Parameters:
-
pElement A pointer to the dataset that will be removed.
- Returns:
- TRUE if the operation succeeded, otherwise FALSE.