IODA
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ioda::ObsDataVector< DATATYPE > Class Template Reference

ObsDataVector<DATATYPE> handles vectors of data of type DATATYPE in observation space. More...

#include <ObsDataVector.h>

Inheritance diagram for ioda::ObsDataVector< DATATYPE >:
Inheritance graph
[legend]
Collaboration diagram for ioda::ObsDataVector< DATATYPE >:
Collaboration graph
[legend]

Public Member Functions

 ObsDataVector (ObsSpace &, const oops::Variables &, const std::string &grp="", const bool fail=true)
 
 ObsDataVector (ObsSpace &, const std::string &, const std::string &grp="", const bool fail=true)
 
 ObsDataVector (const ObsDataVector &)
 
 ~ObsDataVector ()
 
ObsDataVector & operator= (const ObsDataVector &)
 
void zero ()
 
void mask (const ObsDataVector< int > &)
 
void read (const std::string &, const bool fail=true)
 
void save (const std::string &) const
 
size_t nvars () const
 
size_t nlocs () const
 
bool has (const std::string &vargrp) const
 
const ObsDataRow< DATATYPE > & operator[] (const size_t ii) const
 
ObsDataRow< DATATYPE > & operator[] (const size_t ii)
 
const ObsDataRow< DATATYPE > & operator[] (const std::string var) const
 
ObsDataRow< DATATYPE > & operator[] (const std::string var)
 
const std::string & obstype () const
 
const oops::Variables & varnames () const
 

Static Public Member Functions

static const std::string classname ()
 

Private Member Functions

void print (std::ostream &) const
 

Private Attributes

ObsSpace & obsdb_
 
oops::Variables obsvars_
 
size_t nvars_
 
size_t nlocs_
 
std::vector< ObsDataRow< DATATYPE > > rows_
 
const DATATYPE missing_
 

Detailed Description

template<typename DATATYPE>
class ioda::ObsDataVector< DATATYPE >

ObsDataVector<DATATYPE> handles vectors of data of type DATATYPE in observation space.

Definition at line 40 of file ObsDataVector.h.

Constructor & Destructor Documentation

◆ ObsDataVector() [1/3]

template<typename DATATYPE >
ioda::ObsDataVector< DATATYPE >::ObsDataVector ( ObsSpace &  obsdb,
const oops::Variables &  vars,
const std::string &  grp = "",
const bool  fail = true 
)

Definition at line 88 of file ObsDataVector.h.

Here is the call graph for this function:

◆ ObsDataVector() [2/3]

template<typename DATATYPE >
ioda::ObsDataVector< DATATYPE >::ObsDataVector ( ObsSpace &  obsdb,
const std::string &  var,
const std::string &  grp = "",
const bool  fail = true 
)

Definition at line 103 of file ObsDataVector.h.

Here is the call graph for this function:

◆ ObsDataVector() [3/3]

template<typename DATATYPE >
ioda::ObsDataVector< DATATYPE >::ObsDataVector ( const ObsDataVector< DATATYPE > &  other)

Definition at line 116 of file ObsDataVector.h.

◆ ~ObsDataVector()

template<typename DATATYPE >
ioda::ObsDataVector< DATATYPE >::~ObsDataVector

Definition at line 123 of file ObsDataVector.h.

Member Function Documentation

◆ classname()

template<typename DATATYPE >
static const std::string ioda::ObsDataVector< DATATYPE >::classname ( )
inlinestatic

Definition at line 43 of file ObsDataVector.h.

◆ has()

template<typename DATATYPE >
bool ioda::ObsDataVector< DATATYPE >::has ( const std::string &  vargrp) const
inline

Definition at line 63 of file ObsDataVector.h.

◆ mask()

template<typename DATATYPE >
void ioda::ObsDataVector< DATATYPE >::mask ( const ObsDataVector< int > &  flags)

Definition at line 147 of file ObsDataVector.h.

Here is the call graph for this function:

◆ nlocs()

template<typename DATATYPE >
size_t ioda::ObsDataVector< DATATYPE >::nlocs ( ) const
inline

Definition at line 62 of file ObsDataVector.h.

Here is the caller graph for this function:

◆ nvars()

template<typename DATATYPE >
size_t ioda::ObsDataVector< DATATYPE >::nvars ( ) const
inline

Definition at line 61 of file ObsDataVector.h.

Here is the caller graph for this function:

◆ obstype()

template<typename DATATYPE >
const std::string& ioda::ObsDataVector< DATATYPE >::obstype ( ) const
inline

Definition at line 72 of file ObsDataVector.h.

Here is the call graph for this function:

◆ operator=()

template<typename DATATYPE >
ObsDataVector< DATATYPE > & ioda::ObsDataVector< DATATYPE >::operator= ( const ObsDataVector< DATATYPE > &  rhs)

Definition at line 126 of file ObsDataVector.h.

◆ operator[]() [1/4]

template<typename DATATYPE >
ObsDataRow<DATATYPE>& ioda::ObsDataVector< DATATYPE >::operator[] ( const size_t  ii)
inline

Definition at line 66 of file ObsDataVector.h.

◆ operator[]() [2/4]

template<typename DATATYPE >
const ObsDataRow<DATATYPE>& ioda::ObsDataVector< DATATYPE >::operator[] ( const size_t  ii) const
inline

Definition at line 65 of file ObsDataVector.h.

◆ operator[]() [3/4]

template<typename DATATYPE >
ObsDataRow<DATATYPE>& ioda::ObsDataVector< DATATYPE >::operator[] ( const std::string  var)
inline

Definition at line 70 of file ObsDataVector.h.

◆ operator[]() [4/4]

template<typename DATATYPE >
const ObsDataRow<DATATYPE>& ioda::ObsDataVector< DATATYPE >::operator[] ( const std::string  var) const
inline

Definition at line 68 of file ObsDataVector.h.

◆ print()

template<typename DATATYPE >
void ioda::ObsDataVector< DATATYPE >::print ( std::ostream &  os) const
private

Definition at line 186 of file ObsDataVector.h.

◆ read()

template<typename DATATYPE >
void ioda::ObsDataVector< DATATYPE >::read ( const std::string &  name,
const bool  fail = true 
)

Definition at line 158 of file ObsDataVector.h.

Here is the caller graph for this function:

◆ save()

template<typename DATATYPE >
void ioda::ObsDataVector< DATATYPE >::save ( const std::string &  name) const

Definition at line 174 of file ObsDataVector.h.

◆ varnames()

template<typename DATATYPE >
const oops::Variables& ioda::ObsDataVector< DATATYPE >::varnames ( ) const
inline

Definition at line 73 of file ObsDataVector.h.

◆ zero()

template<typename DATATYPE >
void ioda::ObsDataVector< DATATYPE >::zero

Definition at line 138 of file ObsDataVector.h.

Member Data Documentation

◆ missing_

template<typename DATATYPE >
const DATATYPE ioda::ObsDataVector< DATATYPE >::missing_
private

Definition at line 83 of file ObsDataVector.h.

◆ nlocs_

template<typename DATATYPE >
size_t ioda::ObsDataVector< DATATYPE >::nlocs_
private

Definition at line 81 of file ObsDataVector.h.

◆ nvars_

template<typename DATATYPE >
size_t ioda::ObsDataVector< DATATYPE >::nvars_
private

Definition at line 80 of file ObsDataVector.h.

◆ obsdb_

template<typename DATATYPE >
ObsSpace& ioda::ObsDataVector< DATATYPE >::obsdb_
private

Definition at line 78 of file ObsDataVector.h.

◆ obsvars_

template<typename DATATYPE >
oops::Variables ioda::ObsDataVector< DATATYPE >::obsvars_
private

Definition at line 79 of file ObsDataVector.h.

◆ rows_

template<typename DATATYPE >
std::vector<ObsDataRow<DATATYPE> > ioda::ObsDataVector< DATATYPE >::rows_
private

Definition at line 82 of file ObsDataVector.h.

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