ioda::detail::CanReadAttributes< DerivedHasAtts > Class Template Reference
Describes the functions that can read attributes. More...
#include <Has_Attributes.h>
Public Member Functions | |
| virtual | ~CanReadAttributes () |
Convenience functions for reading attributes | |
| template<class DataType > | |
| const DerivedHasAtts | read (const std::string &attrname, gsl::span< DataType > data) const |
| Open and read an Attribute, for expected dimensions. More... | |
| template<class DataType > | |
| const DerivedHasAtts | read (const std::string &attrname, std::vector< DataType > &data) const |
| Open and read an Attribute, with unknown dimensions. More... | |
| template<class DataType > | |
| const DerivedHasAtts | read (const std::string &attrname, std::valarray< DataType > &data) const |
| Open and read an Attribute, with unknown dimensions. More... | |
| template<class DataType > | |
| const DerivedHasAtts | read (const std::string &attrname, DataType &data) const |
| Read a datum of an Attribute. More... | |
| template<class DataType > | |
| DataType | read (const std::string &attrname) const |
| Read a datum of an Attribute. More... | |
| template<class EigenClass , bool Resize = detail::EigenCompat::CanResize<EigenClass>::value> | |
| DerivedHasAtts | readWithEigenRegular (const std::string &attrname, EigenClass &data) |
| template<class EigenClass > | |
| DerivedHasAtts | readWithEigenTensor (const std::string &attrname, EigenClass &data) |
Protected Member Functions | |
| CanReadAttributes () | |
Detailed Description
template<class DerivedHasAtts>
class ioda::detail::CanReadAttributes< DerivedHasAtts >
Describes the functions that can read attributes.
Uses the (CRTP)[https://en.wikipedia.org/wiki/Curiously_recurring_template_pattern] to implement this as we use the same functions for placeholder attribute construction.
- See also
- Has_Attributes
Definition at line 172 of file Has_Attributes.h.
Constructor & Destructor Documentation
◆ CanReadAttributes()
template<class DerivedHasAtts >
|
inlineprotected |
Definition at line 174 of file Has_Attributes.h.
◆ ~CanReadAttributes()
template<class DerivedHasAtts >
|
inlinevirtual |
Definition at line 177 of file Has_Attributes.h.
Member Function Documentation
◆ read() [1/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Read a 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 read.
- Returns
- A datum of type DataType.
- Exceptions
-
jedi::xError if the underlying data have size > 1.
Definition at line 239 of file Has_Attributes.h.
Here is the call graph for this function:
◆ read() [2/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Read a 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 read. data is a datum of type DataType.
- Exceptions
-
jedi::xError if the underlying data have size > 1.
Definition at line 227 of file Has_Attributes.h.
Here is the call graph for this function:
◆ read() [3/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Open and read an Attribute, for expected 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 read. data is a pointer-size pair to the data buffer that is filled with the metadata's contents. It should be pre-sized to accomodate all of the matadata. See getDimensions().numElements. Data will be filled in row-major order.
- Exceptions
-
jedi::xError on a size mismatch between Attribute dimensions and data.size().
Definition at line 190 of file Has_Attributes.h.
Here is the call graph for this function:
Here is the caller graph for this function:
◆ read() [4/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Open and read an Attribute, with unknown 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 read. data is a valarray acting as a data buffer that is filled with the metadata's contents. It gets resized as needed. data will be filled in row-major order.
Definition at line 215 of file Has_Attributes.h.
Here is the call graph for this function:
◆ read() [5/5]
template<class DerivedHasAtts >
template<class DataType >
|
inline |
Open and read an Attribute, with unknown 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 read. data is a vector acting as a data buffer that is filled with the metadata's contents. It gets resized as needed. data will be filled in row-major order.
Definition at line 203 of file Has_Attributes.h.
Here is the call graph for this function:
◆ readWithEigenRegular()
template<class DerivedHasAtts >
template<class EigenClass , bool Resize = detail::EigenCompat::CanResize<EigenClass>::value>
|
inline |
◆ readWithEigenTensor()
template<class DerivedHasAtts >
template<class EigenClass >
|
inline |
The documentation for this class was generated from the following file:
