MsPASS C++ API  2.4.1.dev4+g92330b7a
Defines the C++ API for MsPASS
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mspass::algorithms::TimeWindowCmp Class Reference

Function object used for weak comparison to order TimeWindow objects. More...

#include <TimeWindow.h>

Public Member Functions

bool operator() (const TimeWindow ti1, const TimeWindow ti2) const
 

Detailed Description

Function object used for weak comparison to order TimeWindow objects.

TimeWindow objects are used, among other things, to define real or processed induced data gaps. The set container requires a weak ordering function like to correctly determine if a time is inside a particular time window.

Author
Gary L. Pavlis

Member Function Documentation

◆ operator()()

bool mspass::algorithms::TimeWindowCmp::operator() ( const TimeWindow  ti1,
const TimeWindow  ti2 
) const
inline

Return true when ti1 ends before ti2 starts.

Parameters
ti1first window in the comparison.
ti2second window in the comparison.
Returns
true if ti1 is strictly before ti2 with no overlap.
95 {
96 return (ti1.end < ti2.start);
97 };

References mspass::algorithms::TimeWindow::end, and mspass::algorithms::TimeWindow::start.


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