Instrument Neutral Distributed Interface INDI  1.6.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
INDI::GuiderInterface Class Referenceabstract

#include <indiguiderinterface.h>

Inheritance diagram for INDI::GuiderInterface:
CelestronGPS GPUSB IEQPro INDI::CCD LX200Generic Paramount ScopeSim SkywatcherAPIMount STAR2000 TemmaMount

Public Member Functions

virtual IPState GuideNorth (float ms)=0
 Guide north for ms milliseconds. North is defined as DEC+. More...
 
virtual IPState GuideSouth (float ms)=0
 Guide south for ms milliseconds. South is defined as DEC-. More...
 
virtual IPState GuideEast (float ms)=0
 Guide east for ms milliseconds. East is defined as RA+. More...
 
virtual IPState GuideWest (float ms)=0
 Guide west for ms milliseconds. West is defined as RA-. More...
 
virtual void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 

Protected Member Functions

 GuiderInterface ()
 
 ~GuiderInterface ()
 
void initGuiderProperties (const char *deviceName, const char *groupName)
 Initilize guider properties. It is recommended to call this function within initProperties() of your primary device. More...
 
void processGuiderProperties (const char *name, double values[], char *names[], int n)
 Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. This function then takes care of issuing the corresponding GuideXXXX function accordingly. More...
 

Protected Attributes

INumber GuideNSN [2]
 
INumberVectorProperty GuideNSNP
 
INumber GuideWEN [2]
 
INumberVectorProperty GuideWENP
 

Detailed Description

Definition at line 47 of file indiguiderinterface.h.

Constructor & Destructor Documentation

GuiderInterface::GuiderInterface ( )
protected

Definition at line 28 of file indiguiderinterface.cpp.

GuiderInterface::~GuiderInterface ( )
protected

Definition at line 32 of file indiguiderinterface.cpp.

Member Function Documentation

void GuiderInterface::GuideComplete ( INDI_EQ_AXIS  axis)
virtual

Call GuideComplete once the guiding pulse is complete.

Parameters
axisAxis of completed guiding operation.

Reimplemented in INDI::CCD.

Definition at line 86 of file indiguiderinterface.cpp.

virtual IPState INDI::GuiderInterface::GuideEast ( float  ms)
pure virtual

Guide east for ms milliseconds. East is defined as RA+.

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implemented in INDI::CCD, IEQPro, CCDSim, LX200Generic, SkywatcherAPIMount, CelestronGPS, Paramount, GuideSim, TemmaMount, ScopeSim, STAR2000, GPUSB, and LX200Pulsar2.

virtual IPState INDI::GuiderInterface::GuideNorth ( float  ms)
pure virtual

Guide north for ms milliseconds. North is defined as DEC+.

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implemented in INDI::CCD, IEQPro, CCDSim, LX200Generic, SkywatcherAPIMount, CelestronGPS, Paramount, GuideSim, TemmaMount, ScopeSim, STAR2000, GPUSB, and LX200Pulsar2.

virtual IPState INDI::GuiderInterface::GuideSouth ( float  ms)
pure virtual

Guide south for ms milliseconds. South is defined as DEC-.

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implemented in INDI::CCD, IEQPro, CCDSim, LX200Generic, SkywatcherAPIMount, CelestronGPS, Paramount, GuideSim, TemmaMount, ScopeSim, STAR2000, GPUSB, and LX200Pulsar2.

virtual IPState INDI::GuiderInterface::GuideWest ( float  ms)
pure virtual

Guide west for ms milliseconds. West is defined as RA-.

Returns
IPS_OK if operation is completed successfully, IPS_BUSY if operation will take take to complete, or IPS_ALERT if operation failed.

Implemented in INDI::CCD, IEQPro, CCDSim, LX200Generic, SkywatcherAPIMount, CelestronGPS, Paramount, GuideSim, TemmaMount, ScopeSim, STAR2000, GPUSB, and LX200Pulsar2.

void GuiderInterface::initGuiderProperties ( const char *  deviceName,
const char *  groupName 
)
protected

Initilize guider properties. It is recommended to call this function within initProperties() of your primary device.

Parameters
deviceNameName of the primary device
groupNameGroup or tab name to be used to define guider properties.

Definition at line 36 of file indiguiderinterface.cpp.

void GuiderInterface::processGuiderProperties ( const char *  name,
double  values[],
char *  names[],
int  n 
)
protected

Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. This function then takes care of issuing the corresponding GuideXXXX function accordingly.

Parameters
namedevice name
valuesvalue as passed by the client
namesnames as passed by the client
nnumber of values and names pair to process.

Definition at line 49 of file indiguiderinterface.cpp.

Member Data Documentation

INumber INDI::GuiderInterface::GuideNSN[2]
protected

Definition at line 107 of file indiguiderinterface.h.

INumberVectorProperty INDI::GuiderInterface::GuideNSNP
protected

Definition at line 108 of file indiguiderinterface.h.

INumber INDI::GuiderInterface::GuideWEN[2]
protected

Definition at line 109 of file indiguiderinterface.h.

INumberVectorProperty INDI::GuiderInterface::GuideWENP
protected

Definition at line 110 of file indiguiderinterface.h.


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