The following INDI properties are used to manage math plugins. More...

#include <MathPluginManagement.h>

Inheritance diagram for INDI::AlignmentSubsystem::MathPluginManagement:

Public Types
enum	MountType { EQUATORIAL , ALTAZ }
	Describes the basic type of the mount. More...

typedef enum INDI::AlignmentSubsystem::MathPluginManagement::MountType	MountType_t

Public Member Functions
	MathPluginManagement ()
	Default constructor.

virtual	~MathPluginManagement ()
	Virtual destructor.

void	InitProperties (Telescope *pTelescope)
	Initialize alignment math plugin properties. It is recommended to call this function within initProperties() of your primary device.

void	ProcessSwitchProperties (Telescope pTelescope, const char name, ISState states, char names[], int n)
	Call this function from within the ISNewSwitch processing path. The function will handle any math plugin switch properties.

void	ProcessTextProperties (Telescope pTelescope, const char name, char texts[], char names[], int n)
	Call this function from within the ISNewText processing path. The function will handle any math plugin text properties. This text property is at the moment only contained in the config file so this will normally only have work to do when the config file is loaded.

void	SaveConfigProperties (FILE *fp)
	Call this function to save persistent math plugin properties. This function should be called from within the saveConfigItems function of your driver.

void	SetApproximateMountAlignmentFromMountType (MountType_t Type)
	Call this function to set the ApproximateMountAlignment property of the current Math Plugin. The alignment database should be initialised before this function is called so that it can use the DatabaseReferencePosition to determine which hemisphere the current observing site is in. For equatorial the ApproximateMountAlignment property will set to NORTH_CELESTIAL_POLE for sites in the northern hemisphere and SOUTH_CELESTIAL_POLE for sites in the southern hemisphere. For altaz mounts the ApproximateMountAlignment will be set to ZENITH.

void	SetCurrentInMemoryDatabase (InMemoryDatabase *pDatabase)
	Set the current in memory database.

void	SetAlignmentSubsystemActive (bool enable)
	SetAlignmentSubsystemActive Enable or Disable alignment subsystem.

bool	IsAlignmentSubsystemActive () const
	Return status of alignment subsystem.

MountAlignment_t	GetApproximateMountAlignment ()
	Get the approximate alignment of the mount.

bool	Initialise (InMemoryDatabase *pInMemoryDatabase)
	Initialise or re-initialise the math plugin. Re-reading the in memory database as necessary.

void	SetApproximateMountAlignment (MountAlignment_t ApproximateAlignment)
	Set the approximate alignment of the mount.

bool	TransformCelestialToTelescopeJD (double RightAscension, double Declination, double JulianDate, TelescopeDirectionVector &ApparentTelescopeDirectionVector)
	TransformCelestialToTelescopeJD Transforms Celestial (Sky) Coords to Mount Coordinates.

bool	TransformTelescopeToCelestialJD (const TelescopeDirectionVector &ApparentTelescopeDirectionVector, double &RightAscension, double &Declination, double JulianDate)
	TransformTelescopeToCelestialJD Transforms Mount Coords to Celestial (Sky) Coordinates.

bool	TransformCelestialToTelescope (const double RightAscension, const double Declination, double JulianOffset, TelescopeDirectionVector &ApparentTelescopeDirectionVector)
	TransformCelestialToTelescope Compat shim - resolves JD and delegates to TransformCelestialToTelescopeJD.

bool	TransformTelescopeToCelestial (const TelescopeDirectionVector &ApparentTelescopeDirectionVector, double &RightAscension, double &Declination, double JulianOffset=0)
	TransformTelescopeToCelestial Compat shim - resolves JD and delegates to TransformTelescopeToCelestialJD.

Detailed Description

The following INDI properties are used to manage math plugins.

ALIGNMENT_SUBSYSTEM_MATH_PLUGINS
A list of available plugins (switch). This also allows the client to select a plugin.
ALIGNMENT_SUBSYSTEM_MATH_PLUGIN_INITIALISE
Initialise or re-initialise the current math plugin.
ALIGNMENT_SUBSYSTEM_CURRENT_MATH_PLUGIN
This is not communicated to the client and only used to save the currently selected plugin name to persistent storage.

This class also provides function links to the currently selected math plugin

Definition at line 34 of file MathPluginManagement.h.

Member Typedef Documentation

◆ MountType_t

typedef enum INDI::AlignmentSubsystem::MathPluginManagement::MountType INDI::AlignmentSubsystem::MathPluginManagement::MountType_t

Member Enumeration Documentation

◆ MountType

enum INDI::AlignmentSubsystem::MathPluginManagement::MountType

Describes the basic type of the mount.

Enumerator
EQUATORIAL
ALTAZ

Definition at line 40 of file MathPluginManagement.h.

Constructor & Destructor Documentation

◆ MathPluginManagement()

INDI::AlignmentSubsystem::MathPluginManagement::MathPluginManagement ( )

Default constructor.

Definition at line 20 of file MathPluginManagement.cpp.

◆ ~MathPluginManagement()

virtual INDI::AlignmentSubsystem::MathPluginManagement::~MathPluginManagement ( )

inlinevirtual

Virtual destructor.

Definition at line 46 of file MathPluginManagement.h.

Member Function Documentation

◆ GetApproximateMountAlignment()

MountAlignment_t INDI::AlignmentSubsystem::MathPluginManagement::GetApproximateMountAlignment ( )

virtual

Get the approximate alignment of the mount.

Returns: the approximate alignment

Reimplemented from INDI::AlignmentSubsystem::MathPlugin.

Definition at line 373 of file MathPluginManagement.cpp.

◆ Initialise()

bool INDI::AlignmentSubsystem::MathPluginManagement::Initialise ( InMemoryDatabase * pInMemoryDatabase )

virtual

Initialise or re-initialise the math plugin. Re-reading the in memory database as necessary.

Returns: True if successful

Reimplemented from INDI::AlignmentSubsystem::MathPlugin.

Definition at line 378 of file MathPluginManagement.cpp.

◆ InitProperties()

void INDI::AlignmentSubsystem::MathPluginManagement::InitProperties ( Telescope * pTelescope )

Initialize alignment math plugin properties. It is recommended to call this function within initProperties() of your primary device.

Parameters

[in] pTelescope Pointer to the child INDI::Telecope class

Definition at line 29 of file MathPluginManagement.cpp.

◆ IsAlignmentSubsystemActive()

bool INDI::AlignmentSubsystem::MathPluginManagement::IsAlignmentSubsystemActive ( ) const

inline

Return status of alignment subsystem.

Returns: True if active

Definition at line 106 of file MathPluginManagement.h.

◆ ProcessSwitchProperties()

void INDI::AlignmentSubsystem::MathPluginManagement::ProcessSwitchProperties	(	Telescope *	pTelescope,
		const char *	name,
		ISState *	states,
		char *	names[],
		int	n
	)

Call this function from within the ISNewSwitch processing path. The function will handle any math plugin switch properties.

Parameters

[in]	pTelescope	Pointer to the child INDI::Telecope class
[in]	name	vector property name
[in]	states	states as passed by the client
[in]	names	names as passed by the client
[in]	n	number of values and names pair to process.

Definition at line 233 of file MathPluginManagement.cpp.

◆ ProcessTextProperties()

void INDI::AlignmentSubsystem::MathPluginManagement::ProcessTextProperties	(	Telescope *	pTelescope,
		const char *	name,
		char *	texts[],
		char *	names[],
		int	n
	)

Call this function from within the ISNewText processing path. The function will handle any math plugin text properties. This text property is at the moment only contained in the config file so this will normally only have work to do when the config file is loaded.

Parameters

[in]	pTelescope	Pointer to the child INDI::Telecope class
[in]	name	vector property name
[in]	texts	texts as passed by the client
[in]	names	names as passed by the client
[in]	n	number of values and names pair to process.

Definition at line 94 of file MathPluginManagement.cpp.

◆ SaveConfigProperties()

void INDI::AlignmentSubsystem::MathPluginManagement::SaveConfigProperties ( FILE * fp )

Call this function to save persistent math plugin properties. This function should be called from within the saveConfigItems function of your driver.

Parameters

[in] fp File pointer passed into saveConfigItems

Definition at line 344 of file MathPluginManagement.cpp.

◆ SetAlignmentSubsystemActive()

void INDI::AlignmentSubsystem::MathPluginManagement::SetAlignmentSubsystemActive ( bool enable )

SetAlignmentSubsystemActive Enable or Disable alignment subsystem.

Parameters

enable True to activate Alignment Subsystem. False to deactivate Alignment subsystem.

Definition at line 337 of file MathPluginManagement.cpp.

◆ SetApproximateMountAlignment()

void INDI::AlignmentSubsystem::MathPluginManagement::SetApproximateMountAlignment ( MountAlignment_t ApproximateAlignment )

virtual

Set the approximate alignment of the mount.

Parameters

[in] ApproximateAlignment - the approximate alignment of the mount

Reimplemented from INDI::AlignmentSubsystem::MathPlugin.

Definition at line 383 of file MathPluginManagement.cpp.

◆ SetApproximateMountAlignmentFromMountType()

void INDI::AlignmentSubsystem::MathPluginManagement::SetApproximateMountAlignmentFromMountType ( MountType_t Type )

Call this function to set the ApproximateMountAlignment property of the current Math Plugin. The alignment database should be initialised before this function is called so that it can use the DatabaseReferencePosition to determine which hemisphere the current observing site is in. For equatorial the ApproximateMountAlignment property will set to NORTH_CELESTIAL_POLE for sites in the northern hemisphere and SOUTH_CELESTIAL_POLE for sites in the southern hemisphere. For altaz mounts the ApproximateMountAlignment will be set to ZENITH.

Parameters

[in] Type the mount type either EQUATORIAL or ALTAZ

Definition at line 351 of file MathPluginManagement.cpp.

◆ SetCurrentInMemoryDatabase()

void INDI::AlignmentSubsystem::MathPluginManagement::SetCurrentInMemoryDatabase ( InMemoryDatabase * pDatabase )

inline

Set the current in memory database.

Parameters

[in] pDatabase A pointer to the current in memory database

Definition at line 93 of file MathPluginManagement.h.

◆ TransformCelestialToTelescope()

bool INDI::AlignmentSubsystem::MathPluginManagement::TransformCelestialToTelescope	(	const double	RightAscension,
		const double	Declination,
		double	JulianOffset,
		TelescopeDirectionVector &	ApparentTelescopeDirectionVector
	)

virtual

TransformCelestialToTelescope Compat shim - resolves JD and delegates to TransformCelestialToTelescopeJD.

Parameters

RightAscension	Sky Right Ascension in hours.
Declination	Sky Declination in degrees
JulianOffset	Julian time Offset in days added to ln_get_julian_from_sys()
ApparentTelescopeDirectionVector	Output Apparent Telescope Direction Vector

Returns: True if transformation is successful, false otherwise.

Deprecated:: Use TransformCelestialToTelescopeJD with an explicit Julian Date

Implements INDI::AlignmentSubsystem::MathPlugin.

Definition at line 410 of file MathPluginManagement.cpp.

◆ TransformCelestialToTelescopeJD()

bool INDI::AlignmentSubsystem::MathPluginManagement::TransformCelestialToTelescopeJD	(	double	RightAscension,
		double	Declination,
		double	JulianDate,
		TelescopeDirectionVector &	ApparentTelescopeDirectionVector
	)

virtual

TransformCelestialToTelescopeJD Transforms Celestial (Sky) Coords to Mount Coordinates.

Parameters

RightAscension	Sky Right Ascension in hours.
Declination	Sky Declination in degrees
JulianDate	Absolute Julian Date (days)
ApparentTelescopeDirectionVector	Output Apparent Telescope Direction Vector

Returns: True if transformation is successful, false otherwise.

Reimplemented from INDI::AlignmentSubsystem::MathPlugin.

Definition at line 388 of file MathPluginManagement.cpp.

◆ TransformTelescopeToCelestial()

bool INDI::AlignmentSubsystem::MathPluginManagement::TransformTelescopeToCelestial	(	const TelescopeDirectionVector &	ApparentTelescopeDirectionVector,
		double &	RightAscension,
		double &	Declination,
		double	JulianOffset = `0`
	)

virtual

TransformTelescopeToCelestial Compat shim - resolves JD and delegates to TransformTelescopeToCelestialJD.

Parameters

ApparentTelescopeDirectionVector	Input Apparent Telescope Direction Vector
RightAscension	Output Celestial Right Ascension
Declination	Output Celestial Declination
JulianOffset	Julian time Offset in days added to ln_get_julian_from_sys() (default 0)

Returns: True if transformation is successful, false otherwise.

Deprecated:: Use TransformTelescopeToCelestialJD with an explicit Julian Date

Implements INDI::AlignmentSubsystem::MathPlugin.

Definition at line 419 of file MathPluginManagement.cpp.

◆ TransformTelescopeToCelestialJD()

bool INDI::AlignmentSubsystem::MathPluginManagement::TransformTelescopeToCelestialJD	(	const TelescopeDirectionVector &	ApparentTelescopeDirectionVector,
		double &	RightAscension,
		double &	Declination,
		double	JulianDate
	)

virtual

TransformTelescopeToCelestialJD Transforms Mount Coords to Celestial (Sky) Coordinates.

Parameters

ApparentTelescopeDirectionVector	Input Apparent Telescope Direction Vector
RightAscension	Output Celestial Right Ascension
Declination	Output Celestial Declination
JulianDate	Absolute Julian Date (days)

Returns: True if transformation is successful, false otherwise.

Reimplemented from INDI::AlignmentSubsystem::MathPlugin.

Definition at line 399 of file MathPluginManagement.cpp.

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ MountType_t

Member Enumeration Documentation

◆ MountType

Constructor & Destructor Documentation

◆ MathPluginManagement()

◆ ~MathPluginManagement()

Member Function Documentation

◆ GetApproximateMountAlignment()

◆ Initialise()

◆ InitProperties()

◆ IsAlignmentSubsystemActive()

◆ ProcessSwitchProperties()

◆ ProcessTextProperties()

◆ SaveConfigProperties()

◆ SetAlignmentSubsystemActive()

◆ SetApproximateMountAlignment()

◆ SetApproximateMountAlignmentFromMountType()

◆ SetCurrentInMemoryDatabase()

◆ TransformCelestialToTelescope()

◆ TransformCelestialToTelescopeJD()

◆ TransformTelescopeToCelestial()

◆ TransformTelescopeToCelestialJD()