Instrument Neutral Distributed Interface INDI  1.9.2
Public Types | Public Member Functions | Public Attributes | List of all members
Axis Class Reference

The Axis class Implements a generic Axis which can be used for equatorial or AltAz mounts for both axes. More...

#include <scopesim_helper.h>

Public Types

enum  AXIS_TRACK_RATE { OFF, SIDEREAL, SOLAR, LUNAR }
 The AXIS_TRACK_RATE enum defines the common track rates. More...
 

Public Member Functions

 Axis (const char *name)
 
void setDegrees (double degrees)
 
void setHours (double hours)
 
void StartSlew (Angle angle)
 
void Abort ()
 
bool isTracking ()
 
void Tracking (bool enabled)
 
void TrackRate (AXIS_TRACK_RATE rate)
 TrackRate set the track rate to one of the standard rates. More...
 
AXIS_TRACK_RATE TrackRate ()
 TrackRate returns the AXIS_TRACK_RATE property. More...
 
void StartGuide (double rate, uint32_t durationMs)
 StartGuide start guiding. More...
 
bool IsGuiding ()
 
void update ()
 
const char * getDeviceName ()
 

Public Attributes

const char * axisName
 
Angle position
 
bool isSlewing
 
Angle TrackingRateDegSec
 TrackingRateDegSec. More...
 
int mcRate
 

Detailed Description

The Axis class Implements a generic Axis which can be used for equatorial or AltAz mounts for both axes.

For an equatorial mount use the TrackRate to set the standard tracking rates. for the primary axis only. For an AltAz mount the TrackingRateDegSec rate must be set for both axes.

Definition at line 243 of file scopesim_helper.h.

Member Enumeration Documentation

◆ AXIS_TRACK_RATE

The AXIS_TRACK_RATE enum defines the common track rates.

Enumerator
OFF 
SIDEREAL 
SOLAR 
LUNAR 

Definition at line 249 of file scopesim_helper.h.

Constructor & Destructor Documentation

◆ Axis()

Axis::Axis ( const char *  name)
inline

Definition at line 251 of file scopesim_helper.h.

Member Function Documentation

◆ Abort()

void Axis::Abort ( )
inline

Definition at line 263 of file scopesim_helper.h.

◆ getDeviceName()

const char* Axis::getDeviceName ( )
inline

Definition at line 304 of file scopesim_helper.h.

◆ IsGuiding()

bool Axis::IsGuiding ( )
inline

Definition at line 297 of file scopesim_helper.h.

◆ isTracking()

bool Axis::isTracking ( )
inline

Definition at line 267 of file scopesim_helper.h.

◆ setDegrees()

void Axis::setDegrees ( double  degrees)

Definition at line 64 of file scopesim_helper.cpp.

◆ setHours()

void Axis::setHours ( double  hours)

Definition at line 70 of file scopesim_helper.cpp.

◆ StartGuide()

void Axis::StartGuide ( double  rate,
uint32_t  durationMs 
)

StartGuide start guiding.

Parameters
rateas a fraction of the sidereal rate, signed
durationMs

Definition at line 115 of file scopesim_helper.cpp.

◆ StartSlew()

void Axis::StartSlew ( Angle  angle)

Definition at line 76 of file scopesim_helper.cpp.

◆ Tracking()

void Axis::Tracking ( bool  enabled)

Definition at line 83 of file scopesim_helper.cpp.

◆ TrackRate() [1/2]

Axis::AXIS_TRACK_RATE Axis::TrackRate ( )

TrackRate returns the AXIS_TRACK_RATE property.

Returns

Definition at line 110 of file scopesim_helper.cpp.

◆ TrackRate() [2/2]

void Axis::TrackRate ( AXIS_TRACK_RATE  rate)

TrackRate set the track rate to one of the standard rates.

Parameters
rateas AXIS_TRACK_RATE

use this for the primary axis on an equatorial mount

Definition at line 89 of file scopesim_helper.cpp.

◆ update()

void Axis::update ( )

Definition at line 124 of file scopesim_helper.cpp.

Member Data Documentation

◆ axisName

const char* Axis::axisName

Definition at line 253 of file scopesim_helper.h.

◆ isSlewing

bool Axis::isSlewing

Definition at line 265 of file scopesim_helper.h.

◆ mcRate

int Axis::mcRate

Definition at line 299 of file scopesim_helper.h.

◆ position

Angle Axis::position

Definition at line 259 of file scopesim_helper.h.

◆ TrackingRateDegSec

Angle Axis::TrackingRateDegSec

TrackingRateDegSec.

Definition at line 288 of file scopesim_helper.h.


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