ioda::Has_Attributes Class Reference
This class exists inside of ioda::Group or ioda::Variable and provides the interface to manipulating Attributes. More...
#include <Has_Attributes.h>
Inheritance diagram for ioda::Has_Attributes:
Collaboration diagram for ioda::Has_Attributes:
Public Member Functions | |
| Has_Attributes () | |
| Has_Attributes (std::shared_ptr< detail::Has_Attributes_Backend >) | |
| virtual | ~Has_Attributes () |
 Public Member Functions inherited from ioda::detail::CanAddAttributes< Has_Attributes > | |
| Has_Attributes | add (const std::string &attrname, ::gsl::span< const DataType > data, const ::std::vector< Dimensions_t > &dimensions) |
| Create and write an Attribute, for arbitrary dimensions. More... | |
| Has_Attributes | add (const std::string &attrname, ::std::initializer_list< DataType > data, const ::std::vector< Dimensions_t > &dimensions) |
| Create and write an Attribute, for arbitrary dimensions. More... | |
| Has_Attributes | add (const std::string &attrname, ::gsl::span< const DataType > data) |
| Create and write an Attribute, for a single-dimensional span of 1-D data. More... | |
| Has_Attributes | add (const std::string &attrname, ::std::initializer_list< DataType > data) |
| Create and write an Attribute, for a 1-D initializer list. More... | |
| Has_Attributes | add (const std::string &attrname, const DataType &data) |
| Create and write a single datum of an Attribute. More... | |
| Has_Attributes | addWithEigenRegular (const std::string &attrname, const EigenClass &data, bool is2D=true) |
| Has_Attributes | addWithEigenTensor (const std::string &attrname, const EigenClass &data) |
| Public Member Functions inherited from ioda::detail::CanReadAttributes< Has_Attributes > | |
| virtual | ~CanReadAttributes () |
| const Has_Attributes | read (const std::string &attrname, gsl::span< DataType > data) const |
| Open and read an Attribute, for expected dimensions. More... | |
| const Has_Attributes | read (const std::string &attrname, std::vector< DataType > &data) const |
| Open and read an Attribute, with unknown dimensions. More... | |
| const Has_Attributes | read (const std::string &attrname, std::valarray< DataType > &data) const |
| Open and read an Attribute, with unknown dimensions. More... | |
| const Has_Attributes | read (const std::string &attrname, DataType &data) const |
| Read a datum of an Attribute. More... | |
| DataType | read (const std::string &attrname) const |
| Read a datum of an Attribute. More... | |
| Has_Attributes | readWithEigenRegular (const std::string &attrname, EigenClass &data) |
| Has_Attributes | readWithEigenTensor (const std::string &attrname, EigenClass &data) |
| Public Member Functions inherited from ioda::detail::Has_Attributes_Base | |
| virtual | ~Has_Attributes_Base () |
| virtual detail::Type_Provider * | getTypeProvider () const |
| Query the backend and get the type provider. More... | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ioda::detail::CanReadAttributes< Has_Attributes > | |
| CanReadAttributes () | |
| Protected Member Functions inherited from ioda::detail::Has_Attributes_Base | |
| Has_Attributes_Base (std::shared_ptr< Has_Attributes_Backend >) | |
Detailed Description
This class exists inside of ioda::Group or ioda::Variable and provides the interface to manipulating Attributes.
- See also
- Attribute for the class that represents individual attributes.
- Exceptions
-
jedi::xError on all exceptions.
Definition at line 388 of file Has_Attributes.h.
Constructor & Destructor Documentation
◆ Has_Attributes() [1/2]
| ioda::Has_Attributes::Has_Attributes | ( | ) |
Definition at line 140 of file Has_Attributes.cpp.
◆ Has_Attributes() [2/2]
| ioda::Has_Attributes::Has_Attributes | ( | std::shared_ptr< detail::Has_Attributes_Backend > | g | ) |
Definition at line 142 of file Has_Attributes.cpp.
◆ ~Has_Attributes()
|
virtualdefault |
The documentation for this class was generated from the following files:
