#include <indiguiderinterface.h>

Inheritance diagram for INDI::GuiderInterface:

Collaboration diagram for INDI::GuiderInterface:

Public Member Functions
virtual IPState	GuideNorth (uint32_t ms)=0
	Guide north for ms milliseconds. More...

virtual IPState	GuideSouth (uint32_t ms)=0
	Guide south for ms milliseconds. More...

virtual IPState	GuideEast (uint32_t ms)=0
	Guide east for ms milliseconds. More...

virtual IPState	GuideWest (uint32_t ms)=0
	Guide west for ms milliseconds. More...

virtual void	GuideComplete (INDI_EQ_AXIS axis)
	Call GuideComplete once the guiding pulse is complete. More...

virtual IPState	GuideNorth (uint32_t ms)=0
	Guide north for ms milliseconds. More...

virtual IPState	GuideSouth (uint32_t ms)=0
	Guide south for ms milliseconds. More...

virtual IPState	GuideEast (uint32_t ms)=0
	Guide east for ms milliseconds. More...

virtual IPState	GuideWest (uint32_t ms)=0
	Guide west for ms milliseconds. 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. 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. More...

	GuiderInterface ()

	~GuiderInterface ()

void	initGuiderProperties (const char deviceName, const char groupName)
	Initilize guider properties. 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. More...

Protected Attributes
INumber	GuideNSN [2]

INumberVectorProperty	GuideNSNP

INumber	GuideWEN [2]

INumberVectorProperty	GuideWENP

Constructor & Destructor Documentation

◆ GuiderInterface() [1/2]

GuiderInterface::GuiderInterface ( )

protected

◆ ~GuiderInterface() [1/2]

GuiderInterface::~GuiderInterface ( )

protected

◆ GuiderInterface() [2/2]

INDI::GuiderInterface::GuiderInterface ( )

protected

◆ ~GuiderInterface() [2/2]

INDI::GuiderInterface::~GuiderInterface ( )

protected

Member Function Documentation

◆ GuideComplete() [1/2]

void GuiderInterface::GuideComplete ( INDI_EQ_AXIS axis )

virtual

Call GuideComplete once the guiding pulse is complete.

Parameters

axis	Axis of completed guiding operation.

Reimplemented in INDI::CCD, and INDI::CCD.

◆ GuideComplete() [2/2]

virtual void INDI::GuiderInterface::GuideComplete ( INDI_EQ_AXIS axis )

virtual

Call GuideComplete once the guiding pulse is complete.

Parameters

axis	Axis of completed guiding operation.

Reimplemented in INDI::CCD, and INDI::CCD.

◆ GuideEast() [1/2]

virtual IPState INDI::GuiderInterface::GuideEast ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, IOptronV3, PMC8, SXCCD, IEQPro, LX200Telescope, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, GuideSim, SSAGCCD, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, LX200Pulsar2, SXAO, and INovaCCD.

◆ GuideEast() [2/2]

virtual IPState INDI::GuiderInterface::GuideEast ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, IOptronV3, PMC8, SXCCD, IEQPro, LX200Telescope, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, GuideSim, SSAGCCD, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, LX200Pulsar2, SXAO, and INovaCCD.

◆ GuideNorth() [1/2]

virtual IPState INDI::GuiderInterface::GuideNorth ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, SXCCD, IOptronV3, PMC8, IEQPro, LX200Telescope, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, SSAGCCD, GuideSim, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, INovaCCD, LX200Pulsar2, and SXAO.

◆ GuideNorth() [2/2]

virtual IPState INDI::GuiderInterface::GuideNorth ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, SXCCD, IOptronV3, PMC8, IEQPro, LX200Telescope, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, SSAGCCD, GuideSim, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, INovaCCD, LX200Pulsar2, and SXAO.

◆ GuideSouth() [1/2]

virtual IPState INDI::GuiderInterface::GuideSouth ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, SXCCD, IOptronV3, PMC8, IEQPro, LX200Telescope, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, SSAGCCD, GuideSim, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, INovaCCD, LX200Pulsar2, and SXAO.

◆ GuideSouth() [2/2]

virtual IPState INDI::GuiderInterface::GuideSouth ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, SXCCD, IOptronV3, PMC8, IEQPro, LX200Telescope, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, SSAGCCD, GuideSim, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, INovaCCD, LX200Pulsar2, and SXAO.

◆ GuideWest() [1/2]

virtual IPState INDI::GuiderInterface::GuideWest ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, IOptronV3, PMC8, IEQPro, LX200Telescope, SXCCD, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, GuideSim, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, SSAGCCD, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, LX200Pulsar2, SXAO, and INovaCCD.

◆ GuideWest() [2/2]

virtual IPState INDI::GuiderInterface::GuideWest ( uint32_t 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, INDI::CCD, EQMod, SBIGCCD, IOptronV3, PMC8, IEQPro, LX200Telescope, SXCCD, CCDSim, QSICCD, QHYCCD, LX200AstroPhysicsExperimental, SkywatcherAPIMount, Paramount, GuideSim, CelestronGPS, TemmaMount, FishCampCCD, SkywatcherAltAzSimple, SSAGCCD, ScopeSim, GenericCCD, ASICCD, ArduinoST4, STAR2000, GPUSB, MICCD, ASIST4, LX200Pulsar2, SXAO, and INovaCCD.

◆ initGuiderProperties() [1/2]

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

deviceName	Name of the primary device
groupName	Group or tab name to be used to define guider properties.

◆ initGuiderProperties() [2/2]

void INDI::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

deviceName	Name of the primary device
groupName	Group or tab name to be used to define guider properties.

◆ processGuiderProperties() [1/2]

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

name	device name
values	value as passed by the client
names	names as passed by the client
n	number of values and names pair to process.

◆ processGuiderProperties() [2/2]

void INDI::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

name	device name
values	value as passed by the client
names	names as passed by the client
n	number of values and names pair to process.

Member Data Documentation

◆ GuideNSN

INumber GuiderInterface::GuideNSN

protected

◆ GuideNSNP

INumberVectorProperty GuiderInterface::GuideNSNP

protected

◆ GuideWEN

INumber GuiderInterface::GuideWEN

protected

◆ GuideWENP

INumberVectorProperty GuiderInterface::GuideWENP

protected

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

/home/nirva/insroot/include/libindi/indiguiderinterface.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/indiguiderinterface.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ GuiderInterface() [1/2]

◆ ~GuiderInterface() [1/2]

◆ GuiderInterface() [2/2]

◆ ~GuiderInterface() [2/2]

Member Function Documentation

◆ GuideComplete() [1/2]

◆ GuideComplete() [2/2]

◆ GuideEast() [1/2]

◆ GuideEast() [2/2]

◆ GuideNorth() [1/2]

◆ GuideNorth() [2/2]

◆ GuideSouth() [1/2]

◆ GuideSouth() [2/2]

◆ GuideWest() [1/2]

◆ GuideWest() [2/2]

◆ initGuiderProperties() [1/2]

◆ initGuiderProperties() [2/2]

◆ processGuiderProperties() [1/2]

◆ processGuiderProperties() [2/2]

Member Data Documentation

◆ GuideNSN

◆ GuideNSNP

◆ GuideWEN

◆ GuideWENP