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

This class provides the client API for driver side math plugin management. It communicates with the driver via the INDI properties interface. More...

#include <ClientAPIForMathPluginManagement.h>

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

Public Types

typedef std::vector< std::string > MathPluginsList
 

Public Member Functions

virtual ~ClientAPIForMathPluginManagement ()
 Virtual destructor. More...
 
bool EnumerateMathPlugins (MathPluginsList &AvailableMathPlugins)
 Return a list of the names of the available math plugins. More...
 
void Initialise (INDI::BaseClient *BaseClient)
 Intialise the API. 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 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 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 is called by the ProcessNewSwitch function in INDI::Alignment::AlignmentSubsystemForClients which filters out calls from unwanted devices. TODO maybe hide this function. More...
 
bool SelectMathPlugin (const std::string &MathPluginName)
 Selects, loads and initialises the named math plugin. More...
 
bool ReInitialiseMathPlugin ()
 Re-initialises the current math plugin. More...
 

Detailed Description

This class provides the client API for driver side math plugin management. It communicates with the driver via the INDI properties interface.

Definition at line 27 of file ClientAPIForMathPluginManagement.h.

Member Typedef Documentation

◆ MathPluginsList

Definition at line 33 of file ClientAPIForMathPluginManagement.h.

Constructor & Destructor Documentation

◆ ~ClientAPIForMathPluginManagement()

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

Virtual destructor.

Definition at line 31 of file ClientAPIForMathPluginManagement.h.

Member Function Documentation

◆ EnumerateMathPlugins()

bool INDI::AlignmentSubsystem::ClientAPIForMathPluginManagement::EnumerateMathPlugins ( MathPluginsList AvailableMathPlugins)

Return a list of the names of the available math plugins.

Parameters
[out]AvailableMathPluginsReference to a list of the names of the available math plugins.
Returns
False on failure

Definition at line 19 of file ClientAPIForMathPluginManagement.cpp.

◆ Initialise()

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

Intialise the API.

Parameters
[in]BaseClientPointer to the INDI:BaseClient class

Definition at line 34 of file ClientAPIForMathPluginManagement.cpp.

◆ ProcessNewDevice()

void INDI::AlignmentSubsystem::ClientAPIForMathPluginManagement::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 39 of file ClientAPIForMathPluginManagement.cpp.

◆ ProcessNewProperty()

void INDI::AlignmentSubsystem::ClientAPIForMathPluginManagement::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 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 44 of file ClientAPIForMathPluginManagement.cpp.

◆ ProcessNewSwitch()

void INDI::AlignmentSubsystem::ClientAPIForMathPluginManagement::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 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 65 of file ClientAPIForMathPluginManagement.cpp.

◆ ReInitialiseMathPlugin()

bool INDI::AlignmentSubsystem::ClientAPIForMathPluginManagement::ReInitialiseMathPlugin ( )

Re-initialises the current math plugin.

Returns
False on failure.

Definition at line 108 of file ClientAPIForMathPluginManagement.cpp.

◆ SelectMathPlugin()

bool INDI::AlignmentSubsystem::ClientAPIForMathPluginManagement::SelectMathPlugin ( const std::string &  MathPluginName)

Selects, loads and initialises the named math plugin.

Parameters
[in]MathPluginNameThe name of the required math plugin.
Returns
False on failure.

Definition at line 79 of file ClientAPIForMathPluginManagement.cpp.


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