Instrument Neutral Distributed Interface INDI  1.9.5
Classes | Typedefs | Enumerations | Functions | Variables
INDI::AlignmentSubsystem Namespace Reference

Namespace to encapsulate the INDI Alignment Subsystem classes. For more information see "INDI Alignment Subsystem" in "Related Pages" accessible via the banner at the top of this page. More...

Classes

struct  AlignmentDatabaseEntry
 Entry in the in memory alignment database. More...
 
class  AlignmentSubsystemForClients
 This class encapsulates all the alignment subsystem classes that are useful to client implementations. Clients should inherit from this class. More...
 
class  AlignmentSubsystemForDrivers
 This class encapsulates all the alignment subsystem classes that are useful to driver implementations. Drivers should inherit from this class. More...
 
class  AlignmentSubsystemForMathPlugins
 This class encapsulates all the alignment subsystem classes that are useful to math plugin implementations. Math plugins should inherit from this class. More...
 
class  BasicMathPlugin
 This class implements the common functionality for the built in and SVD math plugins. More...
 
class  BuiltInMathPlugin
 This class implements the default math plugin. More...
 
class  ClientAPIForAlignmentDatabase
 This class provides the client API to the driver side alignment database. It communicates with the driver via the INDI properties interface. More...
 
class  ClientAPIForMathPluginManagement
 This class provides the client API for driver side math plugin management. It communicates with the driver via the INDI properties interface. More...
 
class  ConvexHull
 This class computes the convex hull of a set of 3d points. More...
 
class  DummyMathPlugin
 
struct  ExtendedAlignmentDatabaseEntry
 
class  InMemoryDatabase
 This class provides the driver side API to the in memory alignment database. More...
 
class  MapPropertiesToInMemoryDatabase
 An entry in the sync point database is defined by the following INDI properties. More...
 
class  MathPlugin
 Provides alignment subsystem functions to INDI alignment math plugins. More...
 
class  MathPluginManagement
 The following INDI properties are used to manage math plugins. More...
 
class  NearestMathPlugin
 
class  SVDMathPlugin
 This class implements the SVD math plugin. More...
 
struct  TelescopeDirectionVector
 Holds a nomalised direction vector (direction cosines) More...
 
class  TelescopeDirectionVectorSupportFunctions
 These functions are used to convert different coordinate systems to and from the telescope direction vectors (normalised vector/direction cosines) used for telescope coordinates in the alignment susbsystem. More...
 

Typedefs

typedef enum INDI::AlignmentSubsystem::MountAlignment MountAlignment_t
 

Enumerations

enum  MountAlignment { ZENITH, NORTH_CELESTIAL_POLE, SOUTH_CELESTIAL_POLE }
 Describe the alignment of a telescope axis. This is normally used to differentiate between equatorial mounts in differnet hemispheres and altaz or dobsonian mounts. More...
 
enum  AlignmentDatabaseActions {
  APPEND, INSERT, EDIT, DELETE,
  CLEAR, READ, READ_INCREMENT, LOAD_DATABASE,
  SAVE_DATABASE
}
 Action to perform on Alignment Database. More...
 
enum  AlignmentPointSetEnum {
  ENTRY_OBSERVATION_JULIAN_DATE, ENTRY_RA, ENTRY_DEC, ENTRY_VECTOR_X,
  ENTRY_VECTOR_Y, ENTRY_VECTOR_Z
}
 The offsets to the fields in the alignment point set property. More...
 

Functions

DummyMathPluginCreate ()
 
void Destroy (DummyMathPlugin *pPlugin)
 
const char * GetDisplayName ()
 
void Destroy (NearestMathPlugin *pPlugin)
 
void Destroy (SVDMathPlugin *pPlugin)
 

Variables

int DBG_ALIGNMENT = INDI::Logger::getInstance().addDebugLevel("Alignment Subsystem", "ALIGNMENT")
 

Detailed Description

Namespace to encapsulate the INDI Alignment Subsystem classes. For more information see "INDI Alignment Subsystem" in "Related Pages" accessible via the banner at the top of this page.

Typedef Documentation

◆ MountAlignment_t

Enumeration Type Documentation

◆ AlignmentDatabaseActions

Action to perform on Alignment Database.

Enumerator
APPEND 
INSERT 
EDIT 
DELETE 
CLEAR 
READ 
READ_INCREMENT 
LOAD_DATABASE 
SAVE_DATABASE 

Definition at line 34 of file Common.h.

◆ AlignmentPointSetEnum

The offsets to the fields in the alignment point set property.

Note
This must match the definitions given to INDI
Enumerator
ENTRY_OBSERVATION_JULIAN_DATE 
ENTRY_RA 
ENTRY_DEC 
ENTRY_VECTOR_X 
ENTRY_VECTOR_Y 
ENTRY_VECTOR_Z 

Definition at line 50 of file Common.h.

◆ MountAlignment

Describe the alignment of a telescope axis. This is normally used to differentiate between equatorial mounts in differnet hemispheres and altaz or dobsonian mounts.

Enumerator
ZENITH 
NORTH_CELESTIAL_POLE 
SOUTH_CELESTIAL_POLE 

Definition at line 30 of file Common.h.

Function Documentation

◆ Create()

SVDMathPlugin * INDI::AlignmentSubsystem::Create ( )

Definition at line 13 of file DummyMathPlugin.cpp.

◆ Destroy() [1/3]

void INDI::AlignmentSubsystem::Destroy ( DummyMathPlugin pPlugin)

Definition at line 18 of file DummyMathPlugin.cpp.

◆ Destroy() [2/3]

void INDI::AlignmentSubsystem::Destroy ( NearestMathPlugin pPlugin)

Definition at line 79 of file NearestMathPlugin.cpp.

◆ Destroy() [3/3]

void INDI::AlignmentSubsystem::Destroy ( SVDMathPlugin pPlugin)

Definition at line 22 of file SVDMathPlugin.cpp.

◆ GetDisplayName()

const char * INDI::AlignmentSubsystem::GetDisplayName ( )

Definition at line 23 of file DummyMathPlugin.cpp.

Variable Documentation

◆ DBG_ALIGNMENT

int INDI::AlignmentSubsystem::DBG_ALIGNMENT = INDI::Logger::getInstance().addDebugLevel("Alignment Subsystem", "ALIGNMENT")

Definition at line 15 of file DriverCommon.cpp.