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

This class provides the client API to the driver side alignment database. It communicates with the driver via the INDI properties interface. More...

#include <ClientAPIForAlignmentDatabase.h>

Inheritance diagram for INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase:
INDI::AlignmentSubsystem::AlignmentSubsystemForClients LoaderClient MathPluginManagerClient

Public Member Functions

 ClientAPIForAlignmentDatabase ()
 Default constructor. More...
 
virtual ~ClientAPIForAlignmentDatabase ()
 Virtual destructor. More...
 
bool AppendSyncPoint (const AlignmentDatabaseEntry &CurrentValues)
 Append a sync point to the database. More...
 
bool ClearSyncPoints ()
 Delete all sync points from the database. More...
 
bool DeleteSyncPoint (unsigned int Offset)
 Delete a sync point from the database. More...
 
bool EditSyncPoint (unsigned int Offset, const AlignmentDatabaseEntry &CurrentValues)
 Edit a sync point in the database. More...
 
int GetDatabaseSize ()
 Return the number of entries in the database. More...
 
void Initialise (INDI::BaseClient *BaseClient)
 Initialise the API. More...
 
bool InsertSyncPoint (unsigned int Offset, const AlignmentDatabaseEntry &CurrentValues)
 Insert a sync point in the database. More...
 
bool LoadDatabase ()
 Load the database from persistent storage. More...
 
void ProcessNewBLOB (IBLOB *BLOBPointer)
 Process new BLOB message from driver. This routine should be called from within the newBLOB handler in the client. This routine is not normally called directly but is called by the ProcessNewBLOB function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function. More...
 
void ProcessNewDevice (INDI::BaseDevice *DevicePointer)
 Process new device message from driver. This routine should be called from within the newDevice handler in the client. This routine is not normally called directly but is called by the ProcessNewDevice function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function. More...
 
void ProcessNewNumber (INumberVectorProperty *NumberVectorProperty)
 Process new number message from driver. This routine should be called from within the newNumber handler in the client. This routine is not normally called directly but it is called by the ProcessNewNumber function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function. More...
 
void ProcessNewProperty (INDI::Property *PropertyPointer)
 Process new property message from driver. This routine should be called from within the newProperty handler in the client. This routine is not normally called directly but it is called by the ProcessNewProperty function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function. More...
 
void ProcessNewSwitch (ISwitchVectorProperty *SwitchVectorProperty)
 Process new switch message from driver. This routine should be called from within the newSwitch handler in the client. This routine is not normally called directly but it is called by the ProcessNewSwitch function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function. More...
 
bool ReadIncrementSyncPoint (AlignmentDatabaseEntry &CurrentValues)
 Increment the current offset then read a sync point from the database. More...
 
bool ReadSyncPoint (unsigned int Offset, AlignmentDatabaseEntry &CurrentValues)
 Read a sync point from the database. More...
 
bool SaveDatabase ()
 Save the database to persistent storage. More...
 

Detailed Description

This class provides the client API to the driver side alignment database. It communicates with the driver via the INDI properties interface.

Definition at line 26 of file ClientAPIForAlignmentDatabase.h.

Constructor & Destructor Documentation

◆ ClientAPIForAlignmentDatabase()

INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ClientAPIForAlignmentDatabase ( )

Default constructor.

Definition at line 17 of file ClientAPIForAlignmentDatabase.cpp.

◆ ~ClientAPIForAlignmentDatabase()

INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::~ClientAPIForAlignmentDatabase ( )
virtual

Virtual destructor.

Definition at line 23 of file ClientAPIForAlignmentDatabase.cpp.

Member Function Documentation

◆ AppendSyncPoint()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::AppendSyncPoint ( const AlignmentDatabaseEntry CurrentValues)

Append a sync point to the database.

Parameters
[in]CurrentValuesThe entry to append.
Returns
True if successful

Definition at line 29 of file ClientAPIForAlignmentDatabase.cpp.

◆ ClearSyncPoints()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ClearSyncPoints ( )

Delete all sync points from the database.

Returns
True if successful

Definition at line 70 of file ClientAPIForAlignmentDatabase.cpp.

◆ DeleteSyncPoint()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::DeleteSyncPoint ( unsigned int  Offset)

Delete a sync point from the database.

Parameters
[in]OffsetPointer to the entry to delete
Returns
True if successful

Definition at line 108 of file ClientAPIForAlignmentDatabase.cpp.

◆ EditSyncPoint()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::EditSyncPoint ( unsigned int  Offset,
const AlignmentDatabaseEntry CurrentValues 
)

Edit a sync point in the database.

Parameters
[in]OffsetPointer to where to make the edit.
[in]CurrentValuesThe entry to edit.
Returns
True if successful

Definition at line 159 of file ClientAPIForAlignmentDatabase.cpp.

◆ GetDatabaseSize()

int INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::GetDatabaseSize ( )

Return the number of entries in the database.

Returns
The number of entries in the database

Definition at line 213 of file ClientAPIForAlignmentDatabase.cpp.

◆ Initialise()

void INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::Initialise ( INDI::BaseClient BaseClient)

Initialise the API.

Parameters
[in]BaseClientA pointer to the INDI::BaseClient class

Definition at line 218 of file ClientAPIForAlignmentDatabase.cpp.

◆ InsertSyncPoint()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::InsertSyncPoint ( unsigned int  Offset,
const AlignmentDatabaseEntry CurrentValues 
)

Insert a sync point in the database.

Parameters
[in]OffsetPointer to where to make then insertion.
[in]CurrentValuesThe entry to insert.
Returns
True if successful

Definition at line 223 of file ClientAPIForAlignmentDatabase.cpp.

◆ LoadDatabase()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::LoadDatabase ( )

Load the database from persistent storage.

Returns
True if successful

Definition at line 277 of file ClientAPIForAlignmentDatabase.cpp.

◆ ProcessNewBLOB()

void INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ProcessNewBLOB ( IBLOB BLOBPointer)

Process new BLOB message from driver. This routine should be called from within the newBLOB handler in the client. This routine is not normally called directly but is called by the ProcessNewBLOB function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function.

Parameters
[in]BLOBPointerA pointer to the INDI::IBLOB.

Definition at line 316 of file ClientAPIForAlignmentDatabase.cpp.

◆ ProcessNewDevice()

void INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ProcessNewDevice ( INDI::BaseDevice DevicePointer)

Process new device message from driver. This routine should be called from within the newDevice handler in the client. This routine is not normally called directly but is called by the ProcessNewDevice function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function.

Parameters
[in]DevicePointerA pointer to the INDI::BaseDevice object.

Definition at line 330 of file ClientAPIForAlignmentDatabase.cpp.

◆ ProcessNewNumber()

void INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ProcessNewNumber ( INumberVectorProperty NumberVectorProperty)

Process new number message from driver. This routine should be called from within the newNumber handler in the client. This routine is not normally called directly but it is called by the ProcessNewNumber function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function.

Parameters
[in]NumberVectorPropertyA pointer to the INDI::INumberVectorProperty.

Definition at line 335 of file ClientAPIForAlignmentDatabase.cpp.

◆ ProcessNewProperty()

void INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ProcessNewProperty ( INDI::Property PropertyPointer)

Process new property message from driver. This routine should be called from within the newProperty handler in the client. This routine is not normally called directly but it is called by the ProcessNewProperty function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function.

Parameters
[in]PropertyPointerA pointer to the INDI::Property object.

Definition at line 359 of file ClientAPIForAlignmentDatabase.cpp.

◆ ProcessNewSwitch()

void INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ProcessNewSwitch ( ISwitchVectorProperty SwitchVectorProperty)

Process new switch message from driver. This routine should be called from within the newSwitch handler in the client. This routine is not normally called directly but it is called by the ProcessNewSwitch function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function.

Parameters
[in]SwitchVectorPropertyA pointer to the INDI::ISwitchVectorProperty.

Definition at line 393 of file ClientAPIForAlignmentDatabase.cpp.

◆ ReadIncrementSyncPoint()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ReadIncrementSyncPoint ( AlignmentDatabaseEntry CurrentValues)

Increment the current offset then read a sync point from the database.

Parameters
[out]CurrentValuesThe entry read.
Returns
True if successful

Definition at line 407 of file ClientAPIForAlignmentDatabase.cpp.

◆ ReadSyncPoint()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::ReadSyncPoint ( unsigned int  Offset,
AlignmentDatabaseEntry CurrentValues 
)

Read a sync point from the database.

Parameters
[in]OffsetPointer to where to read from.
[out]CurrentValuesThe entry read.
Returns
True if successful

Definition at line 459 of file ClientAPIForAlignmentDatabase.cpp.

◆ SaveDatabase()

bool INDI::AlignmentSubsystem::ClientAPIForAlignmentDatabase::SaveDatabase ( )

Save the database to persistent storage.

Returns
True if successful

Definition at line 521 of file ClientAPIForAlignmentDatabase.cpp.


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