Public Member Functions | Private Attributes | List of all members
gnsstk::CorrectionResults Class Reference

Detailed Description

Class for containing a series of computed biases from the GroupPathCorrector classes.

Definition at line 52 of file CorrectionResults.hpp.

#include <CorrectionResults.hpp>

Public Member Functions

void addResult (const CorrectionResult &res)
 
void clear ()
 Empty the contents of results. More...
 
 CorrectionResults ()=default
 Declaring it explicitly so people don't complain. More...
 
double getCorrSum (CorrDupHandling dups) const
 
const CorrectionResultListgetResults () const
 Get the ordered list of results. More...
 

Private Attributes

CorrectionResultList results
 The computed biases. More...
 

Constructor & Destructor Documentation

◆ CorrectionResults()

gnsstk::CorrectionResults::CorrectionResults ( )
default

Declaring it explicitly so people don't complain.

Member Function Documentation

◆ addResult()

void gnsstk::CorrectionResults::addResult ( const CorrectionResult res)

Add a result to the ordered list.

Parameters
[in]resThe result to be added.

Definition at line 45 of file CorrectionResults.cpp.

◆ clear()

void gnsstk::CorrectionResults::clear ( )

Empty the contents of results.

Definition at line 105 of file CorrectionResults.cpp.

◆ getCorrSum()

double gnsstk::CorrectionResults::getCorrSum ( CorrDupHandling  dups) const

Get the sum of results, filtering duplicates as indicated.

Parameters
[in]dupsHow duplicates are filtered.
  • ComputeFirst means the first result of any given type (e.g. Iono) that is contained within results will be incorporated into the final sum, while others of that type will not.
  • UseFirst behaves the same as ComputeFirst
  • ComputeLast means the last result of any given type that is contained within results will be incorporated into the final sum, while others of that type will not.
Returns
The sum of all corrections of unique types.

Definition at line 59 of file CorrectionResults.cpp.

◆ getResults()

const CorrectionResultList & gnsstk::CorrectionResults::getResults ( ) const

Get the ordered list of results.

Definition at line 52 of file CorrectionResults.cpp.

Member Data Documentation

◆ results

CorrectionResultList gnsstk::CorrectionResults::results
private

The computed biases.

Definition at line 78 of file CorrectionResults.hpp.


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


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:44