ioda::detail::CanAddAttributes< DerivedHasAtts > Class Template Reference
Describes the functions that can add attributes. More...
#include <Has_Attributes.h>
Public Member Functions | |
Convenience functions for adding attributes | |
| template<class DataType > | |
| DerivedHasAtts | 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... | |
| template<class DataType > | |
| DerivedHasAtts | 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... | |
| template<class DataType > | |
| DerivedHasAtts | 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... | |
| template<class DataType > | |
| DerivedHasAtts | add (const std::string &attrname, ::std::initializer_list< DataType > data) |
| Create and write an Attribute, for a 1-D initializer list. More... | |
| template<class DataType > | |
| DerivedHasAtts | add (const std::string &attrname, const DataType &data) |
| Create and write a single datum of an Attribute. More... | |
| template<class EigenClass > | |
| DerivedHasAtts | addWithEigenRegular (const std::string &attrname, const EigenClass &data, bool is2D=true) |
| template<class EigenClass > | |
| DerivedHasAtts | addWithEigenTensor (const std::string &attrname, const EigenClass &data) |
Detailed Description
template<class DerivedHasAtts>
class ioda::detail::CanAddAttributes< DerivedHasAtts >
Describes the functions that can add attributes.
Using the (Curiously Recurring Template Pattern)[https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern] to implement this since we want to use the same functions for placeholder attribute construction.
- See also
- Has_Attributes
- Attribute_Creator
Definition at line 45 of file Has_Attributes.h.
Member Function Documentation
◆ add() [1/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Create and write an Attribute, for a single-dimensional span of 1-D data.
- Template Parameters
-
DataType is the type of the data. I.e. float, int, int32_t, uint16_t, std::string, etc.
- Parameters
-
attrname is the name of the Attribute to be created. data is a gsl::span (a pointer-length pair) that contains the data to be written. The new Attribute will be one-dimensional and the length of the overall span.
- Returns
- Another instance of this Has_Attribute. Used for operation chaining.
- See also
- gsl::span for details of how to make a span.
- gsl::make_span
Definition at line 96 of file Has_Attributes.h.
Here is the call graph for this function:
◆ add() [2/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Create and write an Attribute, for arbitrary dimensions.
- Template Parameters
-
DataType is the type of the data. I.e. float, int, int32_t, uint16_t, std::string, etc.
- Parameters
-
attrname is the name of the Attribute to be created. data is a gsl::span (a pointer-length pair) that contains the data to be written. dimensions is an initializer list representing the size of the metadata. Each element is a dimension with a certain size.
- Returns
- Another instance of this Has_Attribute. Used for operation chaining.
- Exceptions
-
jedi::xError if data.size() does not match the number of total elements described by dimensions.
- See also
- gsl::span for details of how to make a span.
Definition at line 61 of file Has_Attributes.h.
Here is the caller graph for this function:
◆ add() [3/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Create and write an Attribute, for a 1-D initializer list.
- Template Parameters
-
DataType is the type of the data. I.e. float, int, int32_t, uint16_t, std::string, etc.
- Parameters
-
attrname is the name of the Attribute to be created. data is an initializer list that contains the data to be written. The new Attribute will be one-dimensional and the length of the overall span.
- Returns
- Another instance of this Has_Attribute. Used for operation chaining.
Definition at line 107 of file Has_Attributes.h.
Here is the call graph for this function:
◆ add() [4/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Create and write an Attribute, for arbitrary dimensions.
- Template Parameters
-
DataType is the type of the data. I.e. float, int, int32_t, uint16_t, std::string, etc.
- Parameters
-
attrname is the name of the Attribute to be created. data is an initializer list that contains the data to be written. dimensions is an initializer list representing the size of the metadata. Each element is a dimension with a certain size.
- Returns
- Another instance of this Has_Attribute. Used for operation chaining.
- Exceptions
-
jedi::xError if data.size() does not match the number of total elements described by dimensions.
Definition at line 79 of file Has_Attributes.h.
◆ add() [5/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Create and write a single datum of an Attribute.
- Template Parameters
-
DataType is the type of the data. I.e. float, int, int32_t, uint16_t, std::string, etc.
- Parameters
-
attrname is the name of the Attribute to be created. data is the data to be written. The new Attribute will be zero-dimensional and will contain only this datum.
- Note
- Even 0-dimensional data have a type, which may be a compound array (i.e. a single string of variable length).
- Returns
- Another instance of this Has_Attribute. Used for operation chaining.
Definition at line 120 of file Has_Attributes.h.
Here is the call graph for this function:
◆ addWithEigenRegular()
template<class DerivedHasAtts >
template<class EigenClass >
|
inline |
◆ addWithEigenTensor()
template<class DerivedHasAtts >
template<class EigenClass >
|
inline |
The documentation for this class was generated from the following file:
