ioda::ObsIoParametersBase Class Reference
Base of classes storing the configuration parameters of ObsIo subclasses. More...
#include <ObsIoParametersBase.h>
Inheritance diagram for ioda::ObsIoParametersBase:
Collaboration diagram for ioda::ObsIoParametersBase:
Public Attributes | |
| oops::OptionalParameter< std::string > | type {"type", this} |
| Identifies the ObsIo subclass to use. More... | |
| oops::Parameter< ObsGroupingParameters > | obsGrouping {"obsgrouping", {}, this} |
| options controlling obs record grouping More... | |
| oops::Parameter< int > | maxFrameSize {"max frame size", DEFAULT_FRAME_SIZE, this} |
| maximum frame size More... | |
Detailed Description
Base of classes storing the configuration parameters of ObsIo subclasses.
Definition at line 38 of file ObsIoParametersBase.h.
Member Data Documentation
◆ maxFrameSize
| oops::Parameter<int> ioda::ObsIoParametersBase::maxFrameSize {"max frame size", DEFAULT_FRAME_SIZE, this} |
maximum frame size
Definition at line 55 of file ObsIoParametersBase.h.
◆ obsGrouping
| oops::Parameter<ObsGroupingParameters> ioda::ObsIoParametersBase::obsGrouping {"obsgrouping", {}, this} |
options controlling obs record grouping
Definition at line 52 of file ObsIoParametersBase.h.
◆ type
| oops::OptionalParameter<std::string> ioda::ObsIoParametersBase::type {"type", this} |
Identifies the ObsIo subclass to use.
- Note
- This parameter is marked as optional because it is only required in certain circumstances (e.g. when ObsIo parameters are deserialized into an ObsIoParametersWrapper and used by ObsIoFactory to instantiate an ObsIo implementation whose type is determined at runtime), but not others (e.g. in tests written with a particular ObsIo subclass in mind). ObsIoParametersWrapper will throw an exception if this parameter is not provided.
Definition at line 49 of file ObsIoParametersBase.h.
The documentation for this class was generated from the following file:
