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.
AXIS_TRACK_RATE	TrackRate ()
	TrackRate returns the AXIS_TRACK_RATE property.
double	getTrackingRateDegSec ()
void	StartGuide (double rate, uint32_t durationMs)
	StartGuide start guiding.
bool	IsGuiding ()
void	update ()
const char *	getDeviceName ()

Public Attributes
const char *	axisName
Angle	position
bool	isSlewing = false
Angle	TrackingRateDegSec
	TrackingRateDegSec.
int	mcRate = 0

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. (TS 5.25: Axis entails the angles of the rotation around the mechanical axes of the mount.) For an AltAz mount the TrackingRateDegSec rate must be set for both axes. (TS 5.25: The tracking rates of the mechanical axes vary with the positions. See "Deriving Field Rotation Rate for an Alt-Az Mounted Telescope" by Russell P. Patera1)

Definition at line 266 of file scopesim_helper.h.

Member Enumeration Documentation

AXIS_TRACK_RATE

enum Axis::AXIS_TRACK_RATE

The AXIS_TRACK_RATE enum defines the common track rates.

Enumerator
OFF
SIDEREAL
SOLAR
LUNAR

Definition at line 272 of file scopesim_helper.h.

Constructor & Destructor Documentation

Axis()

Axis::Axis ( const char *  name )

inline

Definition at line 274 of file scopesim_helper.h.

Member Function Documentation

Abort()

void Axis::Abort ( )

inline

Definition at line 289 of file scopesim_helper.h.

getDeviceName()

const char * Axis::getDeviceName ( )

inline

Definition at line 343 of file scopesim_helper.h.

getTrackingRateDegSec()

double Axis::getTrackingRateDegSec

(

)

Definition at line 120 of file scopesim_helper.cpp.

IsGuiding()

bool Axis::IsGuiding ( )

inline

Definition at line 333 of file scopesim_helper.h.

isTracking()

bool Axis::isTracking ( )

inline

Definition at line 298 of file scopesim_helper.h.

setDegrees()

void Axis::setDegrees

(

double

degrees

)

Definition at line 69 of file scopesim_helper.cpp.

setHours()

void Axis::setHours

(

double

hours

)

Definition at line 75 of file scopesim_helper.cpp.

StartGuide()

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

StartGuide start guiding.

Parameters

rate	as a fraction of the sidereal rate, signed
durationMs

Definition at line 125 of file scopesim_helper.cpp.

StartSlew()

void Axis::StartSlew

(

Angle

angle

)

Definition at line 81 of file scopesim_helper.cpp.

Tracking()

void Axis::Tracking

(

bool

enabled

)

Definition at line 88 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 115 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

rate	as AXIS_TRACK_RATE

use this for the primary axis on an equatorial mount

Definition at line 94 of file scopesim_helper.cpp.

update()

void Axis::update

(

)

Definition at line 134 of file scopesim_helper.cpp.

Member Data Documentation

axisName

const char* Axis::axisName

Definition at line 279 of file scopesim_helper.h.

isSlewing

bool Axis::isSlewing = false

Definition at line 296 of file scopesim_helper.h.

mcRate

int Axis::mcRate = 0

Definition at line 338 of file scopesim_helper.h.

position

Angle Axis::position

Definition at line 285 of file scopesim_helper.h.

TrackingRateDegSec

Angle Axis::TrackingRateDegSec

TrackingRateDegSec.

Definition at line 324 of file scopesim_helper.h.

---

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

• scopesim_helper.h
• scopesim_helper.cpp