ioda::ObsStore::Has_Variables Class Reference

#include <Variables.hpp>

Public Member Functions
	Has_Variables ()
	~Has_Variables ()
std::shared_ptr< Variable >	create (const std::string &name, const ioda::ObsStore::ObsTypes &dtype, const std::vector< Dimensions_t > &dims, const std::vector< Dimensions_t > &max_dims, const VarCreateParams &params)
	create a new variable More...
std::shared_ptr< Variable >	open (const std::string &name) const
	open an existing variable (throws exception if not found) More...
bool	exists (const std::string &name) const
	returns true if variable exists in the container More...
void	remove (const std::string &name)
	remove variable More...
void	rename (const std::string &oldName, const std::string &newName)
	rename variable More...
std::vector< std::string >	list () const
	returns a list of names of the variables in the container More...
void	setParentGroup (const std::shared_ptr< Group > &parentGroup)
	set parent group pointer More...

Static Private Member Functions
static std::vector< std::string >	splitGroupVar (const std::string &path)
	split a path into groups and variable pieces More...

Private Attributes
std::map< std::string, std::shared_ptr< Variable > >	variables_
	container of variables More...
std::weak_ptr< Group >	parent_group_
	pointer to parent group More...

Detailed Description

Definition at line 150 of file Variables.hpp.

Constructor & Destructor Documentation

Has_Variables()

ioda::ObsStore::Has_Variables::Has_Variables ( )

inline

Definition at line 163 of file Variables.hpp.

~Has_Variables()

ioda::ObsStore::Has_Variables::~Has_Variables ( )

inline

Definition at line 164 of file Variables.hpp.

Member Function Documentation

create()

std::shared_ptr< Variable > ioda::ObsStore::Has_Variables::create	(	const std::string &	name,
		const ioda::ObsStore::ObsTypes &	dtype,
		const std::vector< Dimensions_t > &	dims,
		const std::vector< Dimensions_t > &	max_dims,
		const VarCreateParams &	params
	)

create a new variable

Parameters

name	name of new variable
dtype	ObsStore data type of new variable
dims	dimensions of new variable (length is rank of dimensions)
max_dims	maximum dimensions of new variable (for resizing)
params	parameters for creating new variable

Definition at line 150 of file Variables.cpp.

Here is the call graph for this function:

exists()

bool ioda::ObsStore::Has_Variables::exists

(

const std::string &

name

)

const

returns true if variable exists in the container

Parameters

name	name of variable to check

Definition at line 190 of file Variables.cpp.

Here is the call graph for this function:

list()

std::vector< std::string > ioda::ObsStore::Has_Variables::list

(

)

const

returns a list of names of the variables in the container

Definition at line 229 of file Variables.cpp.

open()

std::shared_ptr< Variable > ioda::ObsStore::Has_Variables::open

(

const std::string &

name

)

const

open an existing variable (throws exception if not found)

Definition at line 174 of file Variables.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

remove()

void ioda::ObsStore::Has_Variables::remove

(

const std::string &

name

)

remove variable

Parameters

name	name of variable to remove

Definition at line 205 of file Variables.cpp.

Here is the call graph for this function:

rename()

void ioda::ObsStore::Has_Variables::rename	(	const std::string &	oldName,
		const std::string &	newName
	)

rename variable

Parameters

oldName	current name of variable
newName	new name of variable

Definition at line 216 of file Variables.cpp.

Here is the call graph for this function:

setParentGroup()

void ioda::ObsStore::Has_Variables::setParentGroup

(

const std::shared_ptr< Group > &

parentGroup

)

set parent group pointer

Parameters

parentGroup

pointer to group that owns this Has_Variables object

Definition at line 237 of file Variables.cpp.

splitGroupVar()

std::vector< std::string > ioda::ObsStore::Has_Variables::splitGroupVar ( const std::string &  path )

staticprivate

split a path into groups and variable pieces

Parameters

path	Hierarchical path

Definition at line 242 of file Variables.cpp.

Here is the caller graph for this function:

Member Data Documentation

parent_group_

std::weak_ptr<Group> ioda::ObsStore::Has_Variables::parent_group_

private

pointer to parent group

Definition at line 156 of file Variables.hpp.

variables_

std::map<std::string, std::shared_ptr<Variable> > ioda::ObsStore::Has_Variables::variables_

private

container of variables

Definition at line 153 of file Variables.hpp.

---

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

• Variables.hpp
• Variables.cpp