Ekos::GuideInterface

Search for usage in LXR

Ekos::GuideInterface Class Referenceabstract

#include <guideinterface.h>

Inheritance diagram for Ekos::GuideInterface:

Public Types

enum  CalibrationUpdateType {
  RA_IN, RA_OUT, BACKLASH, DEC_IN,
  DEC_OUT, CALIBRATION_MESSAGE_ONLY
}
 

Signals

void calibrationUpdate (CalibrationUpdateType type, const QString &message=QString(""), double x=0, double y=0)
 
void frameCaptureRequested ()
 
void guideEquipmentUpdated ()
 
void guideStats (double raError, double decError, int raPulse, int decPulse, double snr, double skyBg, int numStars)
 
void newAxisDelta (double delta_ra, double delta_dec)
 
void newAxisPulse (double pulse_ra, double pulse_dec)
 
void newAxisSigma (double sigma_ra, double sigma_dec)
 
void newLog (const QString &)
 
void newSNR (double snr)
 
void newStarPixmap (QPixmap &)
 
void newStarPosition (const QVector3D &newCenter, bool updateNow)
 
void newStatus (Ekos::GuideState)
 

Public Member Functions

virtual bool abort ()=0
 
virtual bool calibrate ()=0
 
virtual bool clearCalibration ()=0
 
virtual bool Connect ()=0
 
virtual bool Disconnect ()=0
 
virtual bool dither (double pixels)=0
 
virtual bool getFrameParams (uint16_t *x, uint16_t *y, uint16_t *w, uint16_t *h, uint16_t *binX, uint16_t *binY)
 
virtual bool getGuiderParams (double *ccdPixelSizeX, double *ccdPixelSizeY, double *mountAperture, double *mountFocalLength)
 
virtual bool guide ()=0
 
virtual bool isConnected ()=0
 
virtual bool reacquire ()
 
virtual void resetGPG ()
 
virtual bool resume ()=0
 
virtual bool setFrameParams (uint16_t x, uint16_t y, uint16_t w, uint16_t h, uint16_t binX, uint16_t binY)
 
virtual bool setGuiderParams (double ccdPixelSizeX, double ccdPixelSizeY, double mountAperture, double mountFocalLength)
 
virtual void setMountCoords (const SkyPoint &position, ISD::Mount::PierSide side)
 
virtual void setPierSide (ISD::Mount::PierSide newSide)
 
virtual void setStarPosition (QVector3D &starCenter)
 
virtual bool suspend ()=0
 
- 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 Attributes

double ccdPixelSizeX { 0 }
 
double ccdPixelSizeY { 0 }
 
dms mountAltitude
 
double mountAperture { 0 }
 
dms mountAzimuth
 
dms mountDEC
 
double mountFocalLength { 0 }
 
dms mountRA
 
ISD::Mount::PierSide pierSide { ISD::Mount::PIER_UNKNOWN }
 
Ekos::GuideState state { GUIDE_IDLE }
 
uint16_t subBinX { 1 }
 
uint16_t subBinY { 1 }
 
uint16_t subH { 0 }
 
uint16_t subW { 0 }
 
uint16_t subX { 0 }
 
uint16_t subY { 0 }
 

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
 
- 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)
 

Detailed Description

Interface skeleton for implementation of different guiding applications and/or routines.

Author
Jasem Mutlaq
Version
1.0

Definition at line 27 of file guideinterface.h.


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 Fri Aug 12 2022 04:01:02 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.