Calibration Class Reference

Calibrating. More...

#include <activities.h>

Inheritance diagram for Calibration:

Public Member Functions
	Calibration (TelescopeController *, State *)
	Create a calibration instance.
ms_t	start (ms_t)
	The activity will be started by the main loop calling the start function. More...
void	az_click (ms_t t, double)
	The method called when the system detects an azimuthal click. More...
void	alt_click (ms_t t, double)
	The method called when the system detects an altitude click. More...
void	at_endstop (ms_t t, int az_click_count, int alt_click_count)
	The method called when the system detects a timeout, at the limit of an axis's travel. More...
double	clicks_per_sec_az (void)
	Return the relationship between applied motor power and angular speed, for the azimuthal motor. More...
double	clicks_per_sec_alt (void)
	Return the relationship between applied motor power and angular speed, for the azimuthal motor. More...
Public Member Functions inherited from Activity
bool	is_complete (void) const
	Return true if the activity is complete. More...
bool	is_valid (void) const
	Return true if the activity is valid. More...
virtual void	cancel (void)
	Cancel the activity. More...
ActivityTypes	type (void)
	Return the type of Activity.
virtual ms_t	poke (ms_t t)
	From time to time, the main loop will 'poke' this activity, by calling this function. More...

Additional Inherited Members
Public Types inherited from Activity
enum	ActivityTypes {   BaseActivity, CalibrationActivity, ScheduleFollowingActivity, DriveAzAltActivity,   TrackSiderealActivity, TrackAzimuthActivity }
	The activity types here correspond to the this class and its subclasses. More...
Static Public Member Functions inherited from Activity
static void *	operator new (size_t size)
	Allocate space for an Activity. More...
static void	operator delete (void *p)
	Deallocate an Activity.
static int	max_activities (void)
	Return the maximum number of activities it's possible to have allocated at one time. More...
static int	n_activities (void)
	Return the number of currently allocated activities. More...
static void	delete_all_allocations (void)
	Delete all activity allocations. More...
Protected Member Functions inherited from Activity
void	mark_as_complete (void)
	Set to true by a derived class when its work is done. More...
void	mark_as_invalid (void)
	Mark the activity as invalid. More...
	Activity (TelescopeController *, State *, ActivityTypes)
	Construct an activity base-class.
Protected Attributes inherited from Activity
State *const	state
	The state which we are to manipulate.
TelescopeController *const	controller
	The controller object provides methods for physically moving the telescope.
byte	activity_status
	The internal status of the object: complete / invalid. More...

Detailed Description

Calibrating.

Member Function Documentation

void Calibration::alt_click ( ms_t  t, double  altitude  )

virtual

The method called when the system detects an altitude click.

This is for the information of the activity; it should not attempt to update a telescope position.

Parameters

t	the current time
altitude	the estimated angle, in radians north from horizontal

Reimplemented from Activity.

void Calibration::at_endstop ( ms_t  t, int  az_click_count, int  alt_click_count  )

virtual

The method called when the system detects a timeout, at the limit of an axis's travel.

Parameters

t	the current time
az_click_count	the azimuthal click-count at this position
alt_click_count	the altitudinal click-count at this position

Implements Activity.

void Calibration::az_click ( ms_t  t, double  azimuth  )

virtual

The method called when the system detects an azimuthal click.

This is for the information of the activity; it should not attempt to update a telescope position.

Parameters

t	the current time
azimuth	the estimated angle, in radians east from south

Reimplemented from Activity.

double Calibration::clicks_per_sec_alt

(

void

)

Return the relationship between applied motor power and angular speed, for the azimuthal motor.

See also

rad_per_sec_az

double Calibration::clicks_per_sec_az

(

void

)

Return the relationship between applied motor power and angular speed, for the azimuthal motor.

The figure returned here corresponds to the actual angular speed, in clicks per second, when the motor is commanded with TelescopeController::east(1.0). The relationship between this argument and the motor's angular speed is assumed to be otherwise linear.

ms_t Calibration::start ( ms_t  now )

virtual

The activity will be started by the main loop calling the start function.

Returns

the time at which the activity should next be poked (return TIME_NEVER to avoid being poked again).

See also

poke(ms_t)

Reimplemented from Activity.

---

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

• activities.h
• activities.cpp