ioda::ObsStore::Attribute Class Reference

#include <Attributes.hpp>

Inheritance diagram for ioda::ObsStore::Attribute:

Collaboration diagram for ioda::ObsStore::Attribute:

Public Member Functions
	Attribute ()
	Attribute (const std::vector< std::size_t > &dimensions, const ObsTypes &dtype)
	~Attribute ()
std::vector< std::size_t >	get_dimensions () const
	returns dimensions vector More...
bool	isOfType (ObsTypes dtype) const
	returns true if requested type matches stored type More...
std::pair< ObsTypes, size_t >	dtype () const
	returns the data type. More...
std::shared_ptr< Attribute >	write (gsl::span< char > data, ObsTypes dtype)
	transfer data into attribute More...
std::shared_ptr< Attribute >	read (gsl::span< char > data, ObsTypes dtype)
	transfer data from attribute More...

Private Attributes
std::vector< std::size_t >	dimensions_
	holds dimension sizes (vector length is rank of dimensions) More...
ObsTypes	dtype_ = ObsTypes::NOTYPE
	holds ObsStore data type More...
std::size_t	dtype_size_ = 0
	ObsStore data type. More...
std::unique_ptr< VarAttrStore_Base >	attr_data_
	container for attribute data values More...

Detailed Description

Definition at line 34 of file Attributes.hpp.

Constructor & Destructor Documentation

Attribute() [1/2]

ioda::ObsStore::Attribute::Attribute ( )

inline

Definition at line 48 of file Attributes.hpp.

Attribute() [2/2]

ioda::ObsStore::Attribute::Attribute	(	const std::vector< std::size_t > &	dimensions,
		const ObsTypes &	dtype
	)

Definition at line 25 of file Attributes.cpp.

Here is the call graph for this function:

~Attribute()

ioda::ObsStore::Attribute::~Attribute ( )

inline

Definition at line 50 of file Attributes.hpp.

Member Function Documentation

dtype()

std::pair<ObsTypes, size_t> ioda::ObsStore::Attribute::dtype ( ) const

inline

returns the data type.

Definition at line 58 of file Attributes.hpp.

Here is the caller graph for this function:

get_dimensions()

std::vector< std::size_t > ioda::ObsStore::Attribute::get_dimensions

(

)

const

returns dimensions vector

Definition at line 36 of file Attributes.cpp.

isOfType()

bool ioda::ObsStore::Attribute::isOfType

(

ObsTypes

dtype

)

const

returns true if requested type matches stored type

Parameters

dtype

ObsStore Type being checked

Definition at line 38 of file Attributes.cpp.

Here is the call graph for this function:

read()

std::shared_ptr< Attribute > ioda::ObsStore::Attribute::read	(	gsl::span< char >	data,
		ObsTypes	dtype
	)

transfer data from attribute

Parameters

data	contiguous block of data to transfer
dtype	ObsStore Type

Definition at line 58 of file Attributes.cpp.

Here is the call graph for this function:

write()

std::shared_ptr< Attribute > ioda::ObsStore::Attribute::write	(	gsl::span< char >	data,
		ObsTypes	dtype
	)

transfer data into attribute

Parameters

data	contiguous block of data to transfer
dtype	ObsStore Type

Definition at line 40 of file Attributes.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

attr_data_

std::unique_ptr<VarAttrStore_Base> ioda::ObsStore::Attribute::attr_data_

private

container for attribute data values

Definition at line 45 of file Attributes.hpp.

dimensions_

std::vector<std::size_t> ioda::ObsStore::Attribute::dimensions_

private

holds dimension sizes (vector length is rank of dimensions)

Definition at line 37 of file Attributes.hpp.

dtype_

ObsTypes ioda::ObsStore::Attribute::dtype_ = ObsTypes::NOTYPE

private

holds ObsStore data type

Definition at line 39 of file Attributes.hpp.

dtype_size_

std::size_t ioda::ObsStore::Attribute::dtype_size_ = 0

private

ObsStore data type.

Note

Unused for now.

Definition at line 42 of file Attributes.hpp.

---

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

• Attributes.hpp
• Attributes.cpp