X2 Standard  Version 1.24
Public Member Functions | List of all members
TrackingRatesInterface Class Referenceabstract

The TrackingRatesInterface allows X2 mounts to support variable tracking rates. More...

#include <trackingratesinterface.h>

Public Member Functions

virtual int setTrackingRates (const bool &bSiderealTrackingOn, const bool &bIgnoreRates, const double &dRaRateArcSecPerSec, const double &dDecRateArcSecPerSec)=0
 
virtual int trackingOff ()
 
virtual int siderealTrackingOn ()
 
virtual int trackingRates (bool &bSiderialTrackingOn, double &dRaRateArcSecPerSec, double &dDecRateArcSecPerSec)=0
 

Detailed Description

The TrackingRatesInterface allows X2 mounts to support variable tracking rates.

Member Function Documentation

◆ setTrackingRates()

virtual int TrackingRatesInterface::setTrackingRates ( const bool &  bSiderealTrackingOn,
const bool &  bIgnoreRates,
const double &  dRaRateArcSecPerSec,
const double &  dDecRateArcSecPerSec 
)
pure virtual

Set the tracking rates.

By nature the TrackingRatesInterface is for mounts the can support variable tracking rates. There are mounts that only have two rates, sidereal rate and off.
A workaround to accomodate these mounts would be to respond only to those two particular cases of setTrackingRates (to see these cases, on the Telescope Tab, Tools, Turn Sidereal Tracking On and Turn Tracking Off). Otherwise return ERR_COMMANDNOTSUPPORTED for rates that the mount isn't capable of, like tracking a asteroid, comet, etc.

◆ siderealTrackingOn()

virtual int TrackingRatesInterface::siderealTrackingOn ( )
inlinevirtual

Turn on sidereal tracking. Provided for convenience, merely calls setTrackingRates() function.

◆ trackingOff()

virtual int TrackingRatesInterface::trackingOff ( )
inlinevirtual

Turn off tracking. Provided for convenience, merely calls setTrackingRates() function.

◆ trackingRates()

virtual int TrackingRatesInterface::trackingRates ( bool &  bSiderialTrackingOn,
double &  dRaRateArcSecPerSec,
double &  dDecRateArcSecPerSec 
)
pure virtual

Return the current tracking rates.

A special case for mounts that can set rates, but not read them... So the TheSkyX's user interface can know this, set bTrackingOn=false and return both rates as -1000.0.

Another special case convention, for mounts that can read rates, if bTrackingOn=false and the rates are 15.0410681 +- 0.00001 for ra and 0 +- 0.00001 for dec, TheSkyX's mount status will say 'Tracking off'


The documentation for this class was generated from the following file:
X2 Examples
(C) Software Bisque, Inc. All rights reserved.