Instrument Neutral Distributed Interface INDI  1.9.5
Public Member Functions | List of all members
INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase Class Reference

An entry in the sync point database is defined by the following INDI properties. More...

#include <MapPropertiesToInMemoryDatabase.h>

Inheritance diagram for INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase:
INDI::AlignmentSubsystem::InMemoryDatabase INDI::AlignmentSubsystem::AlignmentSubsystemForDrivers AstroTrac DSC Scope SkywatcherAPIMount

Public Member Functions

virtual ~MapPropertiesToInMemoryDatabase ()
 Virtual destructor. More...
 
void InitProperties (Telescope *pTelescope)
 Initialize alignment database properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void ProcessBlobProperties (Telescope *pTelescope, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Call this function from within the ISNewBLOB processing path. The function will handle any alignment database related properties. More...
 
void ProcessNumberProperties (Telescope *, const char *name, double values[], char *names[], int n)
 Call this function from within the ISNewNumber processing path. The function will handle any alignment database related properties. More...
 
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 alignment database related properties. More...
 
void UpdateLocation (double latitude, double longitude, double elevation)
 Call this function from within the updateLocation processing path. More...
 
void UpdateSize ()
 Call this function when the number of entries in the database changes. More...
 
- Public Member Functions inherited from INDI::AlignmentSubsystem::InMemoryDatabase
 InMemoryDatabase ()
 Default constructor. More...
 
virtual ~InMemoryDatabase ()
 Virtual destructor. More...
 
bool CheckForDuplicateSyncPoint (const AlignmentDatabaseEntry &CandidateEntry, double Tolerance=0.1) const
 Check if a entry already exists in the database. More...
 
AlignmentDatabaseTypeGetAlignmentDatabase ()
 Get a reference to the in memory database. More...
 
bool GetDatabaseReferencePosition (IGeographicCoordinates &Position)
 Get the database reference position. More...
 
bool LoadDatabase (const char *DeviceName)
 Load the database from persistent storage. More...
 
bool SaveDatabase (const char *DeviceName)
 Save the database to persistent storage. More...
 
void SetDatabaseReferencePosition (double Latitude, double Longitude)
 Set the database reference position. More...
 
void SetLoadDatabaseCallback (LoadDatabaseCallbackPointer_t CallbackPointer, void *ThisPointer)
 Set the function to be called when the database is loaded or reloaded. More...
 

Additional Inherited Members

- Public Types inherited from INDI::AlignmentSubsystem::InMemoryDatabase
typedef std::vector< AlignmentDatabaseEntryAlignmentDatabaseType
 
typedef void(* LoadDatabaseCallbackPointer_t) (void *)
 

Detailed Description

An entry in the sync point database is defined by the following INDI properties.

The database is accessed using the following properties

Definition at line 70 of file MapPropertiesToInMemoryDatabase.h.

Constructor & Destructor Documentation

◆ ~MapPropertiesToInMemoryDatabase()

virtual INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::~MapPropertiesToInMemoryDatabase ( )
inlinevirtual

Virtual destructor.

Definition at line 74 of file MapPropertiesToInMemoryDatabase.h.

Member Function Documentation

◆ InitProperties()

void INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::InitProperties ( Telescope pTelescope)

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

Parameters
[in]pTelescopePointer to the child INDI::Telecope class

Definition at line 17 of file MapPropertiesToInMemoryDatabase.cpp.

◆ ProcessBlobProperties()

void INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::ProcessBlobProperties ( Telescope pTelescope,
const char *  name,
int  sizes[],
int  blobsizes[],
char *  blobs[],
char *  formats[],
char *  names[],
int  n 
)

Call this function from within the ISNewBLOB processing path. The function will handle any alignment database related properties.

Parameters
[in]pTelescopePointer to the child INDI::Telecope class
[in]namevector property name
[in]sizes
[in]blobsizes
[in]blobs
[in]formats
[in]names
[in]n

Definition at line 75 of file MapPropertiesToInMemoryDatabase.cpp.

◆ ProcessNumberProperties()

void INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::ProcessNumberProperties ( Telescope ,
const char *  name,
double  values[],
char *  names[],
int  n 
)

Call this function from within the ISNewNumber processing path. The function will handle any alignment database related properties.

Parameters
[in]pTelescopePointer to the child INDI::Telecope class
[in]namevector property name
[in]valuesvalue as passed by the client
[in]namesnames as passed by the client
[in]nnumber of values and names pair to process.

Definition at line 101 of file MapPropertiesToInMemoryDatabase.cpp.

◆ ProcessSwitchProperties()

void INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::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 alignment database related properties.

Parameters
[in]pTelescopePointer to the child INDI::Telecope class
[in]namevector property name
[in]statesstates as passed by the client
[in]namesnames as passed by the client
[in]nnumber of values and names pair to process.

Definition at line 121 of file MapPropertiesToInMemoryDatabase.cpp.

◆ UpdateLocation()

void INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::UpdateLocation ( double  latitude,
double  longitude,
double  elevation 
)

Call this function from within the updateLocation processing path.

Parameters
[in]latitudeSite latitude in degrees.
[in]longitudeSite latitude in degrees increasing eastward from Greenwich (0 to 360).
[in]elevationSite elevation in meters.

Definition at line 256 of file MapPropertiesToInMemoryDatabase.cpp.

◆ UpdateSize()

void INDI::AlignmentSubsystem::MapPropertiesToInMemoryDatabase::UpdateSize ( )

Call this function when the number of entries in the database changes.

Definition at line 273 of file MapPropertiesToInMemoryDatabase.cpp.


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