#include <Has_Attributes.h>

Inheritance diagram for ioda::detail::Has_Attributes_Base:

[legend]

Public Member Functions
virtual	~Has_Attributes_Base ()

virtual detail::Type_Provider *	getTypeProvider () const
	Query the backend and get the type provider. More...

General Functions
virtual std::vector< std::string >	list () const

std::vector< std::string >	operator() () const

virtual bool	exists (const std::string &attname) const
	Does an Attribute with the specified name exist? More...

virtual void	remove (const std::string &attname)
	Delete an Attribute with the specified name. More...

virtual Attribute	open (const std::string &name) const
	Open an Attribute by name. More...

Attribute	operator[] (const std::string &name) const
	Open Attribute by name. More...

virtual std::vector< std::pair< std::string, Attribute > >	openAll () const
	Open all attributes in an object. More...

virtual Attribute	create (const std::string &attrname, const Type &in_memory_dataType, const std::vector< Dimensions_t > &dimensions={1})
	Create an Attribute without setting its data. More...

Attribute	_create_py (const std::string &attrname, BasicTypes dataType, const std::vector< Dimensions_t > &dimensions={1})
	Python compatability function. More...

template<class DataType , class TypeWrapper = Types::GetType_Wrapper<DataType>>
Attribute	create (const std::string &attrname, const std::vector< Dimensions_t > &dimensions={1})
	Create an Attribute without setting its data. More...

virtual void	rename (const std::string &oldName, const std::string &newName)
	Rename an Attribute. More...

Protected Member Functions
	Has_Attributes_Base (std::shared_ptr< Has_Attributes_Backend >)

Private Attributes
std::shared_ptr< Has_Attributes_Backend >	backend_
	Using an opaque object to implement the backend. More...

Friends
class	Group_Backend

class	Variable_Backend

Detailed Description

Definition at line 271 of file Has_Attributes.h.

Constructor & Destructor Documentation

◆ Has_Attributes_Base()

ioda::detail::Has_Attributes_Base::Has_Attributes_Base ( std::shared_ptr< Has_Attributes_Backend > b )

protected

Definition at line 12 of file Has_Attributes.cpp.

◆ ~Has_Attributes_Base()

ioda::detail::Has_Attributes_Base::~Has_Attributes_Base ( )

virtualdefault

Member Function Documentation

◆ _create_py()

Attribute ioda::detail::Has_Attributes_Base::_create_py	(	const std::string &	attrname,
		BasicTypes	dataType,
		const std::vector< Dimensions_t > &	dimensions = `{1}`
	)

inline

Python compatability function.

Definition at line 333 of file Has_Attributes.h.

Here is the caller graph for this function:

◆ create() [1/2]

template<class DataType , class TypeWrapper = Types::GetType_Wrapper<DataType>>

Attribute ioda::detail::Has_Attributes_Base::create	(	const std::string &	attrname,
		const std::vector< Dimensions_t > &	dimensions = `{1}`
	)

inline

Create an Attribute without setting its data.

Template Parameters

DataType is the type of the data. I.e. float, int, uint16_t, std::string, etc.

Parameters

attrname	is the name of the Attribute.
dimensions	is a vector representing the size of the metadata. Each element of the vector is a dimension with a certain size.

Returns: An instance of Attribute that can be written to.

Definition at line 345 of file Has_Attributes.h.

◆ create() [2/2]

Attribute ioda::detail::Has_Attributes_Base::create	(	const std::string &	attrname,
		const Type &	in_memory_dataType,
		const std::vector< Dimensions_t > &	dimensions = `{1}`
	)

virtual

Create an Attribute without setting its data.

Parameters

attrname	is the name of the Attribute.
dimensions	is a vector representing the size of the metadata. Each element of the vector is a dimension with a certain size.
in_memory_datatype	is the runtime description of the Attribute's data type.

Returns: An instance of Attribute that can be written to.

Reimplemented in ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend, and ioda::detail::Engines::HH::HH_HasAttributes.

Definition at line 114 of file Has_Attributes.cpp.

Here is the caller graph for this function:

◆ exists()

bool ioda::detail::Has_Attributes_Base::exists ( const std::string & attname ) const

virtual

Does an Attribute with the specified name exist?

Parameters

attname is the name of the Attribute that we are looking for.

Returns: true if it exists.; false otherwise.

Reimplemented in ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend, and ioda::detail::Engines::HH::HH_HasAttributes.

Definition at line 30 of file Has_Attributes.cpp.

Here is the caller graph for this function:

◆ getTypeProvider()

detail::Type_Provider * ioda::detail::Has_Attributes_Base::getTypeProvider ( ) const

virtual

Query the backend and get the type provider.

Reimplemented in ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend, and ioda::detail::Engines::HH::HH_HasAttributes.

Definition at line 103 of file Has_Attributes.cpp.

◆ list()

std::vector< std::string > ioda::detail::Has_Attributes_Base::list ( ) const

virtual

List all attributes

Returns: an unordered vector of attribute names for an object.

Reimplemented in ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend, and ioda::detail::Engines::HH::HH_HasAttributes.

Definition at line 18 of file Has_Attributes.cpp.

Here is the caller graph for this function:

◆ open()

Attribute ioda::detail::Has_Attributes_Base::open ( const std::string & name ) const

virtual

Open an Attribute by name.

Parameters

name	is the name of the Attribute to be opened.

Returns: An instance of an Attribute that can be queried (with getDimensions()) and read.

Reimplemented in ioda::detail::Engines::HH::HH_HasAttributes, and ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend.

Definition at line 54 of file Has_Attributes.cpp.

Here is the caller graph for this function:

◆ openAll()

std::vector< std::pair< std::string, Attribute > > ioda::detail::Has_Attributes_Base::openAll ( ) const

virtual

Open all attributes in an object.

This is a collective call, optimized for performance.

Returns: A sequence of (name, Attribute) pairs.

Reimplemented in ioda::detail::Has_Attributes_Backend.

Definition at line 66 of file Has_Attributes.cpp.

Here is the caller graph for this function:

◆ operator()()

std::vector<std::string> ioda::detail::Has_Attributes_Base::operator() ( ) const

inline

List all attributes

Returns: an unordered vector of attribute names for an object.

Definition at line 298 of file Has_Attributes.h.

◆ operator[]()

Attribute ioda::detail::Has_Attributes_Base::operator[] ( const std::string & name ) const

inline

Open Attribute by name.

Parameters

name	is the name of the Attribute to be opened.

Returns: An instance of Attribute that can be queried (with getDimensions()) and read.

Definition at line 316 of file Has_Attributes.h.

◆ remove()

void ioda::detail::Has_Attributes_Base::remove ( const std::string & attname )

virtual

Delete an Attribute with the specified name.

Parameters

attname is the name of the Attribute that we are deleting.

Exceptions

jedi::xError if no such attribute exists.

Reimplemented in ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend, and ioda::detail::Engines::HH::HH_HasAttributes.

Definition at line 42 of file Has_Attributes.cpp.

Here is the caller graph for this function:

◆ rename()

void ioda::detail::Has_Attributes_Base::rename	(	const std::string &	oldName,
		const std::string &	newName
	)

virtual

Rename an Attribute.

Parameters

oldName	is the name of the Attribute to be changed.
newName	is the new name of the Attribute.

Exceptions

jedi::xError	if oldName is not found.
jedi::xError	if newName already exists.

Reimplemented in ioda::Engines::ObsStore::ObsStore_HasAttributes_Backend, and ioda::detail::Engines::HH::HH_HasAttributes.

Definition at line 91 of file Has_Attributes.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Group_Backend

friend class Group_Backend

friend

Definition at line 277 of file Has_Attributes.h.

◆ Variable_Backend

friend class Variable_Backend

friend

Definition at line 278 of file Has_Attributes.h.

Member Data Documentation

◆ backend_

std::shared_ptr<Has_Attributes_Backend> ioda::detail::Has_Attributes_Base::backend_

private

Using an opaque object to implement the backend.

Definition at line 274 of file Has_Attributes.h.

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

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Has_Attributes_Base()

◆ ~Has_Attributes_Base()

Member Function Documentation

◆ _create_py()

◆ create() [1/2]

◆ create() [2/2]

◆ exists()

◆ getTypeProvider()

◆ list()

◆ open()

◆ openAll()

◆ operator()()

◆ operator[]()

◆ remove()

◆ rename()

Friends And Related Function Documentation

◆ Group_Backend

◆ Variable_Backend

Member Data Documentation

◆ backend_