ioda::Group Class Reference
Groups are a new implementation of ObsSpaces. More...
#include <Group.h>
Inheritance diagram for ioda::Group:
Collaboration diagram for ioda::Group:
Public Member Functions | |
| Group () | |
| Group (std::shared_ptr< detail::Group_Backend >) | |
| virtual | ~Group () |
 Public Member Functions inherited from ioda::detail::Group_Base | |
| virtual | ~Group_Base () |
| virtual ::ioda::Engines::Capabilities | getCapabilities () const |
| Get capabilities of the Engine backing this Group. More... | |
| virtual FillValuePolicy | getFillValuePolicy () const |
| Get the fill value policy used for Variables within this Group. More... | |
| std::vector< std::string > | list () const |
| List all one-level child groups in this group. More... | |
| std::vector< std::string > | groups () const |
| Same as list(). Uniform semantics with atts() and vars(). More... | |
| virtual std::map< ObjectType, std::vector< std::string > > | listObjects (ObjectType filter=ObjectType::Ignored, bool recurse=false) const |
| List all objects (groups + variables) within this group. More... | |
| template<ObjectType objectClass> | |
| std::vector< std::string > | listObjects (bool recurse=false) const |
| virtual bool | exists (const std::string &name) const |
| virtual Group | create (const std::string &name) |
| Create a group. More... | |
| virtual Group | open (const std::string &name) const |
| Open a group. More... | |
Additional Inherited Members | |
| Public Attributes inherited from ioda::detail::Group_Base | |
| Has_Attributes | atts |
| Use this to access the metadata for the group / ObsSpace. More... | |
| Has_Variables | vars |
| Use this to access variables. More... | |
| Protected Member Functions inherited from ioda::detail::Group_Base | |
| Group_Base (std::shared_ptr< Group_Backend >) | |
Detailed Description
Groups are a new implementation of ObsSpaces.
- See also
- Groups for a examples.
A group can be thought of as a folder that contains Variables and Metadata. A group can also contain child groups, allowing for our ObsSpaces to exist in a nested tree-like structure, which removes the need for having an ObsSpaceContainer.
Groups are implemented in several backends, such as the in-memory IODA store, the HDF5 disk backend, the HDF5 in-memory backend, the ATLAS backend, et cetera. The root Group is mounted using one of these backends (probably as a File object, which is a special type of Group), and additional backends may be mounted into the tree structure.
- Exceptions
-
std::logic_error if the backend handle points to something other than a group. std::logic_error if the backend handle is invalid. std::logic_error if any error has occurred.
Constructor & Destructor Documentation
◆ Group() [1/2]
◆ Group() [2/2]
| ioda::Group::Group | ( | std::shared_ptr< detail::Group_Backend > | backend | ) |
◆ ~Group()
|
virtualdefault |
The documentation for this class was generated from the following files:
