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
|
/*!
* \file AlignmentSubsystemForClients.h
*
* \author Roger James
* \date 13th November 2013
*
* This file provides a shorthand way for clients to include all the
* functionality they need to use the INDI Alignment Subsystem
* Clients should inherit this class alongside INDI::BaseClient
*/
#pragma once
#include "ClientAPIForAlignmentDatabase.h"
#include "ClientAPIForMathPluginManagement.h"
#include "TelescopeDirectionVectorSupportFunctions.h"
#include "basedevice.h"
namespace INDI
{
namespace AlignmentSubsystem
{
/*!
* \class AlignmentSubsystemForClients
* \brief This class encapsulates all the alignment subsystem classes that are useful to client implementations.
* Clients should inherit from this class.
*/
class AlignmentSubsystemForClients : public ClientAPIForMathPluginManagement,
public ClientAPIForAlignmentDatabase,
public TelescopeDirectionVectorSupportFunctions
{
public:
/// \brief Virtual destructor
virtual ~AlignmentSubsystemForClients() {}
/** \brief This routine should be called before any connections to devices are made.
\param[in] DeviceName The device name of INDI driver instance to be used.
\param[in] BaseClient A pointer to the child INDI::BaseClient class
*/
void Initialise(const char *DeviceName, INDI::BaseClient *BaseClient);
/** \brief Process new BLOB message from driver. This routine should be called from within
the newBLOB handler in the client.
\param[in] BLOBPointer A pointer to the INDI::IBLOB.
*/
void ProcessNewBLOB(IBLOB *BLOBPointer);
/** \brief Process new device message from driver. This routine should be called from within
the newDevice handler in the client.
\param[in] DevicePointer A pointer to the INDI::BaseDevice object.
*/
void ProcessNewDevice(INDI::BaseDevice *DevicePointer);
/** \brief Process new property message from driver. This routine should be called from within
the newProperty handler in the client.
\param[in] PropertyPointer A pointer to the INDI::Property object.
*/
void ProcessNewProperty(INDI::Property *PropertyPointer);
/** \brief Process new number message from driver. This routine should be called from within
the newNumber handler in the client.
\param[in] NumberVectorPropertyPointer A pointer to the INDI::INumberVectorProperty.
*/
void ProcessNewNumber(INumberVectorProperty *NumberVectorPropertyPointer);
/** \brief Process new switch message from driver. This routine should be called from within
the newSwitch handler in the client.
\param[in] SwitchVectorPropertyPointer A pointer to the INDI::ISwitchVectorProperty.
*/
void ProcessNewSwitch(ISwitchVectorProperty *SwitchVectorPropertyPointer);
private:
std::string DeviceName;
};
} // namespace AlignmentSubsystem
} // namespace INDI
|