Public Member Functions | Public Attributes | List of all members
gnsstk::WxObsData Struct Reference

Detailed Description

This is a time history weather data from a single site.

Definition at line 118 of file WxObsMap.hpp.

#include <WxObsMap.hpp>

Public Member Functions

void flush (const CommonTime &t) noexcept
 
WxObservation getMostRecent (const CommonTime &t) const noexcept
 
WxObservation getWxObservation (const CommonTime &t, unsigned iv=3600, bool interpolate=true) const
 
void insertObservation (const WxObservation &obs) noexcept
 
 WxObsData () noexcept
 Constructor. More...
 

Public Attributes

CommonTime firstTime
 Time of the oldest data in this object. More...
 
CommonTime lastTime
 Time of the youngest data in this object. More...
 
WxObsMap obs
 The actual data. More...
 
unsigned rxId
 This is the identifier of the site. More...
 

Constructor & Destructor Documentation

◆ WxObsData()

gnsstk::WxObsData::WxObsData ( )
inlinenoexcept

Constructor.

Definition at line 121 of file WxObsMap.hpp.

Member Function Documentation

◆ flush()

void gnsstk::WxObsData::flush ( const CommonTime t)
noexcept

Removes all stored WxObservation objects older than time t.

Parameters
tremove WxObservation objects older than this

Definition at line 83 of file WxObsMap.cpp.

◆ getMostRecent()

WxObservation gnsstk::WxObsData::getMostRecent ( const CommonTime t) const
noexcept

Get the last WxObservation made before time t.

Returns
the WxObservation coming before time t

Definition at line 53 of file WxObsMap.cpp.

◆ getWxObservation()

WxObservation gnsstk::WxObsData::getWxObservation ( const CommonTime t,
unsigned  iv = 3600,
bool  interpolate = true 
) const

Find a WxObservation object for time t. A WxObservation object will be retured. If interpolation is used, the first object immediately before or at time t and the first object immediately after time t will be linearly interpolated between to return a data point at time t. If there is not enough data to interpolate, the nearest real observation will be returned. Any object returned or used in the interpolation scheme must fit within the specified time interval around t (if iv is one hour, a point must be within an hour before or after time t.)

Parameters
tthe time of interest
interpolatetrue if interpolation between points is wanted
ivtime interval (seconds, before and after) around t
Returns
a WxObservation object
Exceptions
ObjectNotFounda WxObservation object not available

Definition at line 102 of file WxObsMap.cpp.

◆ insertObservation()

void gnsstk::WxObsData::insertObservation ( const WxObservation obs)
noexcept

Insert a WxObservation.

Parameters
obsthe WxObservation to insert.

Definition at line 67 of file WxObsMap.cpp.

Member Data Documentation

◆ firstTime

CommonTime gnsstk::WxObsData::firstTime

Time of the oldest data in this object.

Definition at line 126 of file WxObsMap.hpp.

◆ lastTime

CommonTime gnsstk::WxObsData::lastTime

Time of the youngest data in this object.

Definition at line 127 of file WxObsMap.hpp.

◆ obs

WxObsMap gnsstk::WxObsData::obs

The actual data.

Definition at line 133 of file WxObsMap.hpp.

◆ rxId

unsigned gnsstk::WxObsData::rxId

This is the identifier of the site.

Definition at line 130 of file WxObsMap.hpp.


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


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