Hdf4Element Class Reference
An Hdf4Element is the most basic base class of an HDF component. More...
#include <Hdf4Element.h>
Inheritance diagram for Hdf4Element:
Public Types | |
| typedef std::map< std::string, Hdf4Attribute * > | AttributeContainer |
Public Member Functions | |
| const std::string & | getName () const |
| Hdf4Attribute * | addAttribute (const std::string &name, const DataVariant &value) |
| const AttributeContainer & | getAttributes () const |
| Hdf4Attribute * | getAttribute (const std::string &name) const |
| size_t | getNumAttributes () const |
| bool | removeAttribute (const std::string &name) |
| virtual | ~Hdf4Element () |
Protected Member Functions | |
| Hdf4Element (const std::string &name) | |
Detailed Description
An Hdf4Element is the most basic base class of an HDF component.It provides access to the name of the item, as well as its attributes.
Definition at line 25 of file Hdf4Element.h.
Member Typedef Documentation
| typedef std::map<std::string, Hdf4Attribute*> Hdf4Element::AttributeContainer |
The type of container that is used internally to store and manage Hdf4Attributes.
Definition at line 31 of file Hdf4Element.h.
Constructor & Destructor Documentation
| virtual Hdf4Element::~Hdf4Element | ( | ) | [virtual] |
Destroys an Hdf5Element and all of its attributes.
| Hdf4Element::Hdf4Element | ( | const std::string & | name | ) | [protected] |
Creates an Hdf4Element object, which is the most basic type of HDF object.
- Parameters:
-
name The name of the HDF object.
Member Function Documentation
| const std::string& Hdf4Element::getName | ( | ) | const |
Returns the name of the HDF Element.
- Returns:
- The name of the element.
| Hdf4Attribute* Hdf4Element::addAttribute | ( | const std::string & | name, | |
| const DataVariant & | value | |||
| ) |
Creates an attribute with a given type and number of elements.
For supported types, see DynamicObject::set().
- Parameters:
-
name The name of the attribute. value The current value of the attribute.
- Returns:
- Returns a new Hdf4Attribute with the given name and value.
| const AttributeContainer& Hdf4Element::getAttributes | ( | ) | const |
Gets the element's attributes.
- Returns:
- Returns the member vector of attributes. NOTE: You cannot call delete on an Hdf4Attribute since its destructor is protected.
| Hdf4Attribute* Hdf4Element::getAttribute | ( | const std::string & | name | ) | const |
Gets an attribute based on its name.
- Parameters:
-
name The name of the attribute to fetch.
- Returns:
- Returns a pointer to the Hdf4Attribute with the matching name. If multiple attributes with that name exist, the first one in the vector of attributes is returned. NOTE: You cannot call delete on this pointer since the Hdf4Attribute destructor is protected.
| size_t Hdf4Element::getNumAttributes | ( | ) | const |
Gets the number of attributes.
- Returns:
- The number of attributes in the element. Equivalent to calling getAttributes().size().
| bool Hdf4Element::removeAttribute | ( | const std::string & | name | ) |
Removes an attribute from the Hdf4Element.
- Parameters:
-
name The name of the attribute to remove from the Hdf4Element. This is the only way to manually delete an attribute from this object since Hdf4Attribute::~Hdf4Attribute is protected.
- Returns:
- Returns true if the operation was successful. False, otherwise.