1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*!
* \file AlignmentSubsystemForDrivers.h
*
* \author Roger James
* \date 13th November 2013
*
* This file provides a shorthand way for drivers to include all the
* functionality they need to use the INDI Alignment Subsystem
* Clients should inherit this class alongside INDI::Telescope or a similar class
*/
#pragma once
#include "indicom.h"
#include "MapPropertiesToInMemoryDatabase.h"
#include "MathPluginManagement.h"
#include "TelescopeDirectionVectorSupportFunctions.h"
namespace INDI
{
namespace AlignmentSubsystem
{
/*!
* \class AlignmentSubsystemForDrivers
* \brief This class encapsulates all the alignment subsystem classes that are useful to driver implementations.
* Drivers should inherit from this class.
*/
class AlignmentSubsystemForDrivers : public MapPropertiesToInMemoryDatabase,
public MathPluginManagement,
public TelescopeDirectionVectorSupportFunctions
{
public:
/// \brief Default constructor
AlignmentSubsystemForDrivers();
/// \brief Virtual destructor
virtual ~AlignmentSubsystemForDrivers() {}
/** \brief Initialize alignment subsystem properties. It is recommended to call this function within initProperties() of your primary device
* \param[in] pTelescope Pointer to the child INDI::Telecope class
*/
void InitAlignmentProperties(Telescope *pTelescope);
/** \brief Call this function from within the ISNewBlob processing path. The function will
* handle any alignment subsystem related properties.
* \param[in] pTelescope Pointer to the child INDI::Telecope class
* \param[in] name vector property name
* \param[in] sizes
* \param[in] blobsizes
* \param[in] blobs
* \param[in] formats
* \param[in] names
* \param[in] n
*/
void ProcessAlignmentBLOBProperties(Telescope *pTelescope, const char *name, int sizes[], int blobsizes[],
char *blobs[], char *formats[], char *names[], int n);
/** \brief Call this function from within the ISNewNumber processing path. The function will
* handle any alignment subsystem related properties.
* \param[in] pTelescope Pointer to the child INDI::Telecope class
* \param[in] name vector property name
* \param[in] values value as passed by the client
* \param[in] names names as passed by the client
* \param[in] n number of values and names pair to process.
*/
void ProcessAlignmentNumberProperties(Telescope *pTelescope, const char *name, double values[], char *names[],
int n);
/** \brief Call this function from within the ISNewSwitch processing path. The function will
* handle any alignment subsystem related properties.
* \param[in] pTelescope Pointer to the child INDI::Telecope class
* \param[in] name vector property name
* \param[in] states states as passed by the client
* \param[in] names names as passed by the client
* \param[in] n number of values and names pair to process.
*/
void ProcessAlignmentSwitchProperties(Telescope *pTelescope, const char *name, ISState *states, char *names[],
int n);
/** \brief Call this function from within the ISNewText processing path. The function will
* handle any alignment subsystem related properties. This only text property at the moment is contained in the
* config file so this will normally only have work to do when the config file is loaded.
* \param[in] pTelescope Pointer to the child INDI::Telecope class
* \param[in] name vector property name
* \param[in] texts texts as passed by the client
* \param[in] names names as passed by the client
* \param[in] n number of values and names pair to process.
*/
void ProcessAlignmentTextProperties(Telescope *pTelescope, const char *name, char *texts[], char *names[], int n);
/** \brief Call this function to save persistent alignment related properties.
* This function should be called from within the saveConfigItems function of your driver.
* \param[in] fp File pointer passed into saveConfigItems
*/
void SaveAlignmentConfigProperties(FILE *fp);
/** \brief Adds an alignment point to the model database, usually called from Sync.
* \param[in] actualRA actual Right Ascension in decimal hours
* \param[in] actualDec actual Declination in decimal degrees
* \param[in] mountRA Right Ascension where the mount thinks it is in decimal hours
* \param[in] mountDec Declination where the mount thinks it is in decimal degrees
* \return true if the alignment point was added to the database, otherwise false
*
* This will return false if either the alignment point was already added, or if the location
* is not set. Call UpdateLocation to set the current location.
*/
bool AddAlignmentEntryEquatorial(double actualRA, double actualDec, double mountRA, double mountDec);
/** \brief Converts an actual sky location to coordinates to send to the mount, usually called
* in Goto.
* \param[in] actualRA actual Right Ascension in decimal hours
* \param[in] actualDec actual Declination in decimal degrees
* \param[out] mountRA Right Ascension to send to the mount
* \param[out] mountDec Declination to send to the mount
* \return true if we converted actualRA/actualDec to mountRa/mountDec, otherwise false
*
* This will return false if we have fewer than 2 alignment points added, or if the location
* is not set. Call UpdateLocation to set the current location.
*/
bool SkyToTelescopeEquatorial(double actualRA, double actualDec, double &mountRA, double &mountDec);
/** \brief Converts a mount location to actual sky coordinates, usually called in ReadScopeStatus.
* \param[in] mountRA Right Ascension where the mount thinks it is in decimal hours
* \param[in] mountDec Declination where the mount thinks it is in decimal degrees
* \param[out] actualRA actual Right Ascension in decimal hours
* \param[out] actualDec actual Declination in decimal degrees
* \return true if we converted mountRa/mountDec to actualRA/actualDec, otherwise false
*
* This will return false if we have fewer than 2 alignment points added, or if the location
* is not set. Call UpdateLocation to set the current location.
*/
bool TelescopeEquatorialToSky(double mountRA, double mountDec, double &actualRA, double &actualDec);
/** \brief Adds an alignment point to the model database, usually called from Sync.
* \param[in] actualRA actual Right Ascension in decimal hours
* \param[in] actualDec actual Declination in decimal degrees
* \param[in] mountAlt Altitude where the mount thinks it is in decimal degrees
* \param[in] mountAz Azimuth where the mount thinks it is in decimal degrees
* \return true if the alignment point was added to the database, otherwise false
*
* This will return false if either the alignment point was already added, or if the location
* is not set. Call UpdateLocation to set the current location.
*/
bool AddAlignmentEntryAltAz(double actualRA, double actualDec, double mountAlt, double mountAz);
/** \brief Converts an actual sky location to coordinates to send to the mount, usually called
* in Goto.
* \param[in] actualRA actual Right Ascension in decimal hours
* \param[in] actualDec actual Declination in decimal degrees
* \param[out] mountAlt Altitude to send to the mount
* \param[out] mountAz Azimuth to send to the mount
* \return true if we converted actualRA/actualDec to mountAlt/mountAz, otherwise false
*
* This will return false if we have fewer than 2 alignment points added, or if the location
* is not set. Call UpdateLocation to set the current location.
*/
bool SkyToTelescopeAltAz(double actualRA, double actualDec, double &mountAlt, double &mountAz);
/** \brief Converts a mount location to actual sky coordinates, usually called in ReadScopeStatus.
* \param[in] mountAlt Altitude where the mount thinks it is in decimal degrees
* \param[in] mountAz Azimuth where the mount thinks it is in decimal degrees
* \param[out] actualRA actual Right Ascension in decimal hours
* \param[out] actualDec actual Declination in decimal degrees
* \return true if we converted mountRa/mountDec to actualRA/actualDec, otherwise false
*
* This will return false if we have fewer than 2 alignment points added, or if the location
* is not set. Call UpdateLocation to set the current location.
*/
bool TelescopeAltAzToSky(double mountAlt, double mountAz, double &actualRA, double &actualDec);
private:
/** \brief This static function is registered as a load database callback with
* the in memory database module. This registration is performed in the constructor of
* of this class. The callback is called whenever the database is
* is loaded or reloaded, by default it calls the Initialise function of the MathPluginManagment module.
* \param[in] ThisPointer Pointer to the instance of this class which registered the callback
*/
static void MyDatabaseLoadCallback(void *ThisPointer);
};
} // namespace AlignmentSubsystem
} // namespace INDI
|
