Ekos::GuideInterface

#include <guideinterface.h>

Inheritance diagram for Ekos::GuideInterface:

[legend]

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

Public Types inherited from QObject
typedef	QObjectList

Signals
void	abortExposure ()

void	calibrationUpdate (CalibrationUpdateType type, const QString &message=QString(""), double x=0, double y=0)

void	frameCaptureRequested ()

void	guideEquipmentUpdated ()

void	guideInfo (const QString &)

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)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () 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 () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, 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

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	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

T	qobject_cast (const QObject *object)

T	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	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () 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)

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

QObject *	sender () 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.

Member Enumeration Documentation

◆ CalibrationUpdateType

enum Ekos::GuideInterface::CalibrationUpdateType

Definition at line 65 of file guideinterface.h.

Member Function Documentation

◆ getFrameParams()

bool Ekos::GuideInterface::getFrameParams	(	uint16_t *	x,
		uint16_t *	y,
		uint16_t *	w,
		uint16_t *	h,
		uint16_t *	binX,
		uint16_t *	binY )

virtual

Definition at line 53 of file guideinterface.cpp.

◆ getGuiderParams()

bool Ekos::GuideInterface::getGuiderParams	(	double *	ccdPixelSizeX,
		double *	ccdPixelSizeY,
		double *	mountAperture,
		double *	mountFocalLength )

virtual

Definition at line 26 of file guideinterface.cpp.

◆ reacquire()

virtual bool Ekos::GuideInterface::reacquire ( )

inlinevirtual

Definition at line 46 of file guideinterface.h.

◆ resetGPG()

virtual void Ekos::GuideInterface::resetGPG ( )

inlinevirtual

Definition at line 63 of file guideinterface.h.

◆ setFrameParams()

bool Ekos::GuideInterface::setFrameParams	(	uint16_t	x,
		uint16_t	y,
		uint16_t	w,
		uint16_t	h,
		uint16_t	binX,
		uint16_t	binY )

virtual

Definition at line 37 of file guideinterface.cpp.

◆ setGuiderParams()

bool Ekos::GuideInterface::setGuiderParams	(	double	ccdPixelSizeX,
		double	ccdPixelSizeY,
		double	mountAperture,
		double	mountFocalLength )

virtual

Definition at line 15 of file guideinterface.cpp.

◆ setMountCoords()

void Ekos::GuideInterface::setMountCoords	(	const SkyPoint &	position,
		ISD::Mount::PierSide	side )

virtual

Definition at line 71 of file guideinterface.cpp.

◆ setPierSide()

void Ekos::GuideInterface::setPierSide ( ISD::Mount::PierSide newSide )

virtual

Definition at line 80 of file guideinterface.cpp.

◆ setStarPosition()

void Ekos::GuideInterface::setStarPosition ( QVector3D & starCenter )

virtual

Definition at line 66 of file guideinterface.cpp.

Member Data Documentation

◆ ccdPixelSizeX

double Ekos::GuideInterface::ccdPixelSizeX { 0 }

protected

Definition at line 94 of file guideinterface.h.

◆ ccdPixelSizeY

double Ekos::GuideInterface::ccdPixelSizeY { 0 }

protected

Definition at line 95 of file guideinterface.h.

◆ mountAltitude

dms Ekos::GuideInterface::mountAltitude

protected

Definition at line 106 of file guideinterface.h.

◆ mountAperture

double Ekos::GuideInterface::mountAperture { 0 }

protected

Definition at line 96 of file guideinterface.h.

◆ mountAzimuth

dms Ekos::GuideInterface::mountAzimuth

protected

Definition at line 106 of file guideinterface.h.

◆ mountDEC

dms Ekos::GuideInterface::mountDEC

protected

Definition at line 106 of file guideinterface.h.

◆ mountFocalLength

double Ekos::GuideInterface::mountFocalLength { 0 }

protected

Definition at line 97 of file guideinterface.h.

◆ mountRA

dms Ekos::GuideInterface::mountRA

protected

Definition at line 106 of file guideinterface.h.

◆ pierSide

ISD::Mount::PierSide Ekos::GuideInterface::pierSide { ISD::Mount::PIER_UNKNOWN }

protected

Definition at line 107 of file guideinterface.h.

◆ state

Ekos::GuideState Ekos::GuideInterface::state { GUIDE_IDLE }

protected

Definition at line 93 of file guideinterface.h.

◆ subBinX

uint16_t Ekos::GuideInterface::subBinX { 1 }

protected

Definition at line 102 of file guideinterface.h.

◆ subBinY

uint16_t Ekos::GuideInterface::subBinY { 1 }

protected

Definition at line 103 of file guideinterface.h.

◆ subH

uint16_t Ekos::GuideInterface::subH { 0 }

protected

Definition at line 101 of file guideinterface.h.

◆ subW

uint16_t Ekos::GuideInterface::subW { 0 }

protected

Definition at line 100 of file guideinterface.h.

◆ subX

uint16_t Ekos::GuideInterface::subX { 0 }

protected

Definition at line 98 of file guideinterface.h.

◆ subY

uint16_t Ekos::GuideInterface::subY { 0 }

protected

Definition at line 99 of file guideinterface.h.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kstars

Ekos::GuideInterface

Public Types

Signals

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CalibrationUpdateType

Member Function Documentation

◆ getFrameParams()

◆ getGuiderParams()

◆ reacquire()

◆ resetGPG()

◆ setFrameParams()

◆ setGuiderParams()

◆ setMountCoords()

◆ setPierSide()

◆ setStarPosition()

Member Data Documentation

◆ ccdPixelSizeX

◆ ccdPixelSizeY

◆ mountAltitude

◆ mountAperture

◆ mountAzimuth

◆ mountDEC

◆ mountFocalLength

◆ mountRA

◆ pierSide

◆ state

◆ subBinX

◆ subBinY

◆ subH

◆ subW

◆ subX

◆ subY