ioda::ObsStore::Group Class Reference

#include <Group.hpp>

Public Member Functions
	Group ()
virtual	~Group ()
std::list< std::string >	list () const
	List all groups under this group. More...
void	listObjects (ObjectType filter, bool recurse, std::map< ObjectType, std::list< std::string >> &res, const std::string &prefix="") const
	List child objects. More...
bool	exists (const std::string &name)
	returns true if child group exists More...
std::shared_ptr< Group >	create (const std::string &name)
	create a new group More...
std::shared_ptr< Group >	open (const std::string &name, const bool throwIfNotFound=true)
	open an existing child group More...

Static Public Member Functions
static std::shared_ptr< Group >	createRootGroup ()
	Creates a root group. More...

Public Attributes
std::shared_ptr< Has_Attributes >	atts
	container for attributes More...
std::shared_ptr< Has_Variables >	vars
	container for variables More...

Static Private Member Functions
static std::vector< std::string >	splitFirstLevel (const std::string &path)
	split a path into the first level and remainder of the path More...

Private Attributes
std::map< std::string, std::shared_ptr< Group > >	child_groups_
	container for child groups More...

Detailed Description

Definition at line 30 of file Group.hpp.

Constructor & Destructor Documentation

Group()

ioda::ObsStore::Group::Group

(

)

Definition at line 23 of file Engines/ObsStore/Group.cpp.

~Group()

ioda::ObsStore::Group::~Group ( )

virtualdefault

Member Function Documentation

create()

std::shared_ptr< Group > ioda::ObsStore::Group::create

(

const std::string &

name

)

create a new group

Parameters

name	name of child group

Definition at line 75 of file Engines/ObsStore/Group.cpp.

Here is the call graph for this function:

createRootGroup()

std::shared_ptr< Group > ioda::ObsStore::Group::createRootGroup ( )

static

Creates a root group.

Definition at line 125 of file Engines/ObsStore/Group.cpp.

Here is the caller graph for this function:

exists()

bool ioda::ObsStore::Group::exists

(

const std::string &

name

)

returns true if child group exists

Parameters

name	of child group

Definition at line 70 of file Engines/ObsStore/Group.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

list()

std::list< std::string > ioda::ObsStore::Group::list

(

)

const

List all groups under this group.

Definition at line 27 of file Engines/ObsStore/Group.cpp.

Here is the caller graph for this function:

listObjects()

void ioda::ObsStore::Group::listObjects	(	ObjectType	filter,
		bool	recurse,
		std::map< ObjectType, std::list< std::string >> &	res,
		const std::string &	prefix = ""
	)		const

List child objects.

Parameters

filter	is a filter for the search
recurse	turns off / on recursion
res	are the search results.
prefix	is used with recursion. Start with "". Each new element gets a new "group/" prefix added.

Definition at line 35 of file Engines/ObsStore/Group.cpp.

Here is the call graph for this function:

open()

std::shared_ptr< Group > ioda::ObsStore::Group::open	(	const std::string &	name,
		const bool	throwIfNotFound = true
	)

open an existing child group

Parameters

name	name of child group

Definition at line 99 of file Engines/ObsStore/Group.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

splitFirstLevel()

std::vector< std::string > ioda::ObsStore::Group::splitFirstLevel ( const std::string &  path )

staticprivate

split a path into the first level and remainder of the path

Parameters

path	Hierarchical path

Definition at line 132 of file Engines/ObsStore/Group.cpp.

Here is the caller graph for this function:

Member Data Documentation

atts

std::shared_ptr<Has_Attributes> ioda::ObsStore::Group::atts

container for attributes

Definition at line 44 of file Group.hpp.

child_groups_

std::map<std::string, std::shared_ptr<Group> > ioda::ObsStore::Group::child_groups_

private

container for child groups

Definition at line 33 of file Group.hpp.

vars

std::shared_ptr<Has_Variables> ioda::ObsStore::Group::vars

container for variables

Definition at line 47 of file Group.hpp.

---

The documentation for this class was generated from the following files:

• Group.hpp
• Engines/ObsStore/Group.cpp