SatCat5
satcat5::ptp::DebugFilter Class Referencefinal

Detailed Description

DebugFilter remembers the last received call to update.

It can be placed inline with other filters to aid diagnostics.

Definition at line 70 of file ptp_filters.h.

#include <ptp_filters.h>

Inheritance diagram for satcat5::ptp::DebugFilter:
[legend]
Collaboration diagram for satcat5::ptp::DebugFilter:
[legend]

Public Member Functions

void reset () override
 Reset history.
 
s64 update (s64 next, u32 elapsed_usec) override
 Simple passthrough, storing both parameters.
 
virtual void rate (s64 delta_subns, u32 elapsed_usec)
 Optional handler for fast-acquisition; override if required. More...
 
s64 prev () const
 Accessors for received parameters.
 
u32 usec () const
 Accessors for received parameters.
 

Protected Attributes

s64 m_prev
 
u32 m_usec
 

Private Attributes

satcat5::ptp::Filterm_next
 

Member Function Documentation

◆ rate()

virtual void satcat5::ptp::Filter::rate ( s64  delta_subns,
u32  elapsed_usec 
)
inlinevirtualinherited

Optional handler for fast-acquisition; override if required.

Upstream controller provides estimated rate (i.e., rise/run). The "elapsed_usec" parameter will be between 10^5 and 10^7. Child class MAY override this method.

Reimplemented in satcat5::ptp::LinearPrediction, satcat5::ptp::ControllerLR_Inner, satcat5::ptp::ControllerPII, and satcat5::ptp::ControllerPI.

Definition at line 48 of file ptp_filters.h.


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