ApproachSolver

Search for usage in LXR

#include <approachsolver.h>

Inheritance diagram for ApproachSolver:

Signals

void solverMadeProgress (int progress)
 

Public Member Functions

 ApproachSolver (QObject *parent=nullptr)
 
QMap< long double, dmsfindClosestApproach (long double startJD, long double stopJD, const std::function< void(long double, dms)> &callback={})
 
GeoLocationgetGeoLocation ()
 
void setGeoLocation (GeoLocation *geo)
 
void setMaxSeparation (dms sep)
 
void setMaxSeparation (double sep)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Member Functions

virtual dms findDistance ()=0
 
virtual double findInitialStep (long double startJD, long double stopJD)=0
 
bool findPrecise (QPair< long double, dms > *out, long double jd, double step, int prevSign)
 
dms findSkyPointDistance (SkyPoint *obj1, SkyPoint *obj2)
 
virtual double getMaxSeparation ()
 
virtual void updatePositions (long double jd)=0
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Protected Attributes

KSPlanet m_Earth
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

Implements algorithms to find close approaches of two objects on the sky. A class that implements a method to compute close approaches between any two solar system objects excluding planetary moons. Given two such objects, this class has implementations of algorithms required to find the time of closest approach in a given range of time. It is meant to be subclassed and provides the boilerplate (+ common interface) for classes like KSKonjunct and EclipseHandler.

Author
Akarsh Simha
Version
2.0

Definition at line 29 of file approachsolver.h.

Member Function Documentation

◆ findClosestApproach()

QMap< long double, dms > ApproachSolver::findClosestApproach ( long double  startJD,
long double  stopJD,
const std::function< void(long double, dms)> &  callback = {} 
)

Compute the closest approach of two planets in the given range.

Parameters
startJDJulian Day corresponding to start of the calculation period
stopJDJulian Day corresponding to end of the calculation period
callbackA callback function
Returns
Hash containing julian days of close conjunctions against separation

Definition at line 26 of file approachsolver.cpp.

◆ findDistance()

virtual dms ApproachSolver::findDistance ( )
protectedpure virtual

Finds the angular distance between two solar system objects.

Returns
The angular distance between the two bodies.

Implemented in LunarEclipseHandler.

◆ findInitialStep()

virtual double ApproachSolver::findInitialStep ( long double  startJD,
long double  stopJD 
)
protectedpure virtual

findStep

Returns
the step size used by findClosestApproach (in Julian Days)

Make this as big as possible. The bigger it is, the more likely is a skip over...

Implemented in LunarEclipseHandler, EclipseHandler, and KSConjunct.

◆ findPrecise()

bool ApproachSolver::findPrecise ( QPair< long double, dms > *  out,
long double  jd,
double  step,
int  prevSign 
)
protected

Compute the precise value of the extremum once the extremum has been detected.

Parameters
outA pointer to a QPair that stores the Julian Day and Separation corresponding to the extremum
jdJulian day corresponding to the endpoint of the interval where extremum was detected.
stepThe step in jd taken during computation earlier. (Defines the interval size)
prevSignThe previous sign of increment in moving from jd - step to jd
Returns
true if the extremum is a minimum

Definition at line 113 of file approachsolver.cpp.

◆ findSkyPointDistance()

dms ApproachSolver::findSkyPointDistance ( SkyPoint obj1,
SkyPoint obj2 
)
protected

findSkyPointDistance

Parameters
obj1
obj2
Returns
the angular distance between two SkyPoints in arcminutes

Definition at line 157 of file approachsolver.cpp.

◆ getGeoLocation()

GeoLocation* ApproachSolver::getGeoLocation ( )
inline

getGeoLocation

Returns
the currently set GeoLocation

Definition at line 58 of file approachsolver.h.

◆ getMaxSeparation()

virtual double ApproachSolver::getMaxSeparation ( )
inlineprotectedvirtual

getMaxSeparation

Returns
the maximum separation allowed, based on the (guaranteed to be up-to-date) parameters of the objects if overwritten. Here it's just a constant.

Reimplemented in LunarEclipseHandler.

Definition at line 83 of file approachsolver.h.

◆ setGeoLocation()

void ApproachSolver::setGeoLocation ( GeoLocation geo)

Sets the geographic location to compute conjunctions at.

Parameters
geoPointer to the GeoLocation object

Definition at line 17 of file approachsolver.cpp.

◆ setMaxSeparation()

void ApproachSolver::setMaxSeparation ( double  sep)
inline

setMaxSeparation

Parameters
sep- maximum allowed anglar separation

Definition at line 65 of file approachsolver.h.

◆ solverMadeProgress

void ApproachSolver::solverMadeProgress ( int  progress)
signal

solverMadeProgress

Parameters
progress- progress in percent

◆ updatePositions()

virtual void ApproachSolver::updatePositions ( long double  jd)
protectedpure virtual

updatePositions

Update the positions of the objects involved.

Parameters
jdJulian Day corresponding to the time of computation

Implemented in LunarEclipseHandler, and KSConjunct.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Aug 18 2022 03:56:46 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.