siderust-cpp 0.8.0
Header-only C++ wrapper for siderust
Loading...
Searching...
No Matches
siderust::sgp4::Propagator Class Reference

Move-only RAII wrapper around an initialised SGP4 propagator. More...

#include <siderust/sgp4.hpp>

Public Member Functions

 Propagator (const tle::Tle &tle, GravityModel model=GravityModel::Wgs72)
 Propagator (Propagator &&other) noexcept
Propagator & operator= (Propagator &&other) noexcept
 Propagator (const Propagator &)=delete
Propagator & operator= (const Propagator &)=delete
 ~Propagator ()
double epoch_jd_utc () const
 Return the UTC Julian date of the TLE epoch.
int gravity_model () const
 Return the gravity model used by this propagator (0/1/2).
State propagate_at (double jd_utc) const

Detailed Description

Move-only RAII wrapper around an initialised SGP4 propagator.

Construct from a Tle handle; the TLE is not consumed.

Examples
17_sgp4_from_tle.cpp.

Definition at line 121 of file sgp4.hpp.

Constructor & Destructor Documentation

◆ Propagator() [1/3]

siderust::sgp4::Propagator::Propagator ( const tle::Tle & tle,
GravityModel model = GravityModel::Wgs72 )
inlineexplicit

Create an SGP4 propagator from a parsed TLE.

Parameters
tleParsed TLE handle.
modelGravity model (default: WGS-72).
Exceptions
siderust::InvalidArgumentErroron initialisation failure.

Definition at line 128 of file sgp4.hpp.

References siderust::check_status(), and siderust::sgp4::Wgs72.

Referenced by operator=(), operator=(), Propagator(), and Propagator().

◆ Propagator() [2/3]

siderust::sgp4::Propagator::Propagator ( Propagator && other)
inlinenoexcept

Definition at line 133 of file sgp4.hpp.

References Propagator().

◆ Propagator() [3/3]

siderust::sgp4::Propagator::Propagator ( const Propagator & )
delete

References Propagator().

◆ ~Propagator()

siderust::sgp4::Propagator::~Propagator ( )
inline

Definition at line 145 of file sgp4.hpp.

Member Function Documentation

◆ epoch_jd_utc()

double siderust::sgp4::Propagator::epoch_jd_utc ( ) const
inline

Return the UTC Julian date of the TLE epoch.

Definition at line 148 of file sgp4.hpp.

References siderust::check_status().

◆ gravity_model()

int siderust::sgp4::Propagator::gravity_model ( ) const
inline

Return the gravity model used by this propagator (0/1/2).

Definition at line 155 of file sgp4.hpp.

References siderust::check_status().

◆ operator=() [1/2]

Propagator & siderust::sgp4::Propagator::operator= ( const Propagator & )
delete

References Propagator().

◆ operator=() [2/2]

Propagator & siderust::sgp4::Propagator::operator= ( Propagator && other)
inlinenoexcept

Definition at line 134 of file sgp4.hpp.

References Propagator().

◆ propagate_at()

State siderust::sgp4::Propagator::propagate_at ( double jd_utc) const
inline

Propagate to a UTC Julian date and return the TEME state.

Parameters
jd_utcTarget epoch as a UTC Julian date (days).
Exceptions
siderust::InvalidArgumentErroron propagation failure.

Definition at line 165 of file sgp4.hpp.

References siderust::check_status(), siderust::sgp4::State::pos_km, and siderust::sgp4::State::vel_kms.


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