Hidden base class to prevent constructor confusion. More...
#include <Group.h>
Public Member Functions | |
| 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... | |
Public Attributes | |
| 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 | |
| Group_Base (std::shared_ptr< Group_Backend >) | |
Private Attributes | |
| std::shared_ptr< Group_Backend > | backend_ |
Detailed Description
Hidden base class to prevent constructor confusion.
- Note
- enable_shared_from_this is a hint to pybind11.
Constructor & Destructor Documentation
◆ Group_Base()
|
protected |
◆ ~Group_Base()
|
virtualdefault |
Member Function Documentation
◆ create()
|
virtual |
Create a group.
- Parameters
-
name is the group name.
- Returns
- an invalid handle on failure. (i.e. return.isGroup() == false).
- a scoped handle to the group on success.
Reimplemented in ioda::Engines::ObsStore::ObsStore_Group_Backend, and ioda::detail::Engines::HH::HH_Group.
Definition at line 76 of file Group.cpp.
◆ exists()
|
virtual |
Does a group exist at the specified path?
- Parameters
-
name is the group name.
- Returns
- true if a group does exist.
- false if a group does not exist.
Reimplemented in ioda::Engines::ObsStore::ObsStore_Group_Backend, and ioda::detail::Engines::HH::HH_Group.
Definition at line 65 of file Group.cpp.
◆ getCapabilities()
| Engines::Capabilities ioda::detail::Group_Base::getCapabilities | ( | ) | const |
◆ getFillValuePolicy()
|
virtual |
Get the fill value policy used for Variables within this Group.
The backend has to be consulted for this operation. Storage of this policy is backend-dependent.
Reimplemented in ioda::detail::Group_Backend, and ioda::detail::Engines::HH::HH_Group.
◆ groups()
|
inline |
◆ list()
| std::vector< std::string > ioda::detail::Group_Base::list | ( | ) | const |
List all one-level child groups in this group.
This function exists to provide the same calling semantics as vars.list() and atts.list(). It is useful for human exploration of the contents of a Group.
- Returns
- A vector of strings listing the child groups. The strings are unordered.
- See also
- listObjects if you need to enumerate both Groups and Variables, or if you want to do a recursive search. This function is more sophisticated, and depending on the backend it may be faster than recursive calls to list() and vars.list().
Definition at line 43 of file Group.cpp.
◆ listObjects() [1/2]
|
inline |
◆ listObjects() [2/2]
|
virtual |
List all objects (groups + variables) within this group.
- Parameters
-
recurse indicates whether the search should be one-level or recursive. If multiple possible paths exist for an object, only one is actually returned. filter allows you to search for only a certain type of object, such as a Group or Variable.
- Returns
- a map of ObjectTypes. Each mapping contains a vector of strings indicating object names. If a filter is provided, then this map only contains the filtered object type. Otherwise, the map always has vectors for each element of ObjectType (Group, Variable, etc.), although these vectors may be empty if no object of a certain type is found.
- Todo:
This function should list all distinct objects. In the future, this will mean that 1) hard-linked duplicate objects will only be listed once, 2) soft links pointing to the same object will only be traversed once, and 3) multiple external links to the same object will only be traversed once. If you would want to list indistinct objects, then there will be a listLinks function.
Once links are implemented, add an option to auto-resolve soft and external links.
Reimplemented in ioda::detail::Engines::HH::HH_Group, and ioda::Engines::ObsStore::ObsStore_Group_Backend.
Definition at line 53 of file Group.cpp.
◆ open()
|
virtual |
Open a group.
- Returns
- an invalid handle if an error occurred. (i.e. return.isGroup() == false).
- a scoped handle to the group upon success.
- Note
- It is possible to have multiple handles opened for the group simultaneously.
- Parameters
-
name is the name of the child group to open.
Reimplemented in ioda::Engines::ObsStore::ObsStore_Group_Backend, and ioda::detail::Engines::HH::HH_Group.
Definition at line 87 of file Group.cpp.
Member Data Documentation
◆ atts
| Has_Attributes ioda::detail::Group_Base::atts |
◆ backend_
|
private |
◆ vars
| Has_Variables ioda::detail::Group_Base::vars |
The documentation for this class was generated from the following files:
