IODA
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ioda::ObsIoFileRead Class Reference

Implementation of ObsIo reading data from a file. More...

#include <ObsIoFileRead.h>

Inheritance diagram for ioda::ObsIoFileRead:
Inheritance graph
[legend]
Collaboration diagram for ioda::ObsIoFileRead:
Collaboration graph
[legend]

Public Types

typedef ObsFileInParameters Parameters_
 Type used by ObsIoFactory. More...
 

Public Member Functions

 ObsIoFileRead (const Parameters_ &ioParams, const ObsSpaceParameters &obsSpaceParams)
 
 ~ObsIoFileRead ()
 
bool eachProcessGeneratesSeparateObs () const override
 return true if each process generates a separate series of observations (e.g. read from different files). More...
 
- Public Member Functions inherited from ioda::ObsIo
 ObsIo ()
 
virtual ~ObsIo ()
 
Dimensions_t maxVarSize () const
 return number of maximum variable size (along first dimension) More...
 
Dimensions_t numLocs () const
 return number of locations from the source More...
 
Dimensions_t numVars () const
 return number of regular variables from the source More...
 
Dimensions_t numDimVars () const
 return number of dimension scale variables from the source More...
 
const VarNameObjectList & varList () const
 return list of regular variable names More...
 
const VarNameObjectList & dimVarList () const
 return list of dimension scale variable names More...
 
VarDimMap varDimMap () const
 return map of variables to attached dimension scales More...
 
bool isVarDimByNlocs (const std::string &varName) const
 return true if variable's first dimension is nlocs More...
 
Has_Variables & vars ()
 access to the variables container in the associated ObsGroup More...
 
Has_Attributes & atts ()
 access to the attributes container in the associated ObsGroup More...
 
void updateVarDimInfo ()
 update the variable and dimension information More...
 
const std::vector< std::string > & obsGroupingVars () const
 return the names of variables to be used to group observations into records More...
 
virtual bool applyTimingWindow () const
 return true if only observations within the timing window should be retained, false otherwise. More...
 

Static Public Member Functions

static const std::string classname ()
 classname method for object counter More...
 

Private Member Functions

void print (std::ostream &os) const override
 print routine for oops::Printable base class More...
 
void createObsGroupFromHdf5File (const std::string &fileName)
 Read the contents of an HDF5 file into obs_group_. More...
 
void createObsGroupFromOdbFile (const std::string &fileName, const Parameters_ &ioParams)
 Read the contents of an ODB file into obs_group_. More...
 

Private Attributes

bool read_separate_files_ = false
 

Additional Inherited Members

- Protected Attributes inherited from ioda::ObsIo
ObsGroup obs_group_
 ObsGroup object representing io source/destination. More...
 
Dimensions_t max_var_size_
 maximum variable size (ie, first dimension size) More...
 
Dimensions_t nlocs_
 number of locations from source (file or generator) More...
 
VarNameObjectList var_list_
 list of regular variables from source (file or generator) More...
 
VarNameObjectList dim_var_list_
 list of dimension scale variables from source (file or generator) More...
 
VarDimMap dims_attached_to_vars_
 map containing variables with their attached dimension scales More...
 
std::vector< std::string > obs_grouping_vars_
 names of variables to be used to group observations into records More...
 

Detailed Description

Implementation of ObsIo reading data from a file.

Author
Stephen Herbener (JCSDA)

Definition at line 26 of file ObsIoFileRead.h.

Member Typedef Documentation

◆ Parameters_

typedef ObsFileInParameters ioda::ObsIoFileRead::Parameters_

Type used by ObsIoFactory.

Definition at line 36 of file ObsIoFileRead.h.

Constructor & Destructor Documentation

◆ ObsIoFileRead()

ioda::ObsIoFileRead::ObsIoFileRead ( const Parameters_ &  ioParams,
const ObsSpaceParameters &  obsSpaceParams 
)
explicit

Definition at line 23 of file ObsIoFileRead.cc.

Here is the call graph for this function:

◆ ~ObsIoFileRead()

ioda::ObsIoFileRead::~ObsIoFileRead ( )

Definition at line 56 of file ObsIoFileRead.cc.

Member Function Documentation

◆ classname()

static const std::string ioda::ObsIoFileRead::classname ( )
inlinestatic

classname method for object counter

This method is supplied for the ObjectCounter base class. It defines a name to identify an object of this class for reporting by OOPS.

Definition at line 33 of file ObsIoFileRead.h.

◆ createObsGroupFromHdf5File()

void ioda::ObsIoFileRead::createObsGroupFromHdf5File ( const std::string &  fileName)
private

Read the contents of an HDF5 file into obs_group_.

Definition at line 68 of file ObsIoFileRead.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ createObsGroupFromOdbFile()

void ioda::ObsIoFileRead::createObsGroupFromOdbFile ( const std::string &  fileName,
const Parameters_ &  ioParams 
)
private

Read the contents of an ODB file into obs_group_.

Definition at line 81 of file ObsIoFileRead.cc.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ eachProcessGeneratesSeparateObs()

bool ioda::ObsIoFileRead::eachProcessGeneratesSeparateObs ( ) const
overridevirtual

return true if each process generates a separate series of observations (e.g. read from different files).

Reimplemented from ioda::ObsIo.

Definition at line 58 of file ObsIoFileRead.cc.

◆ print()

void ioda::ObsIoFileRead::print ( std::ostream &  os) const
overrideprivatevirtual

print routine for oops::Printable base class

Parameters
ostreamoutput stream

Implements ioda::ObsIo.

Definition at line 64 of file ObsIoFileRead.cc.

Member Data Documentation

◆ read_separate_files_

bool ioda::ObsIoFileRead::read_separate_files_ = false
private

Definition at line 46 of file ObsIoFileRead.h.

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