Provides interface to implement guider (ST4) port functionality. More...

#include <indiguiderinterface.h>

Inheritance diagram for INDI::GuiderInterface:

Public Member Functions
virtual bool	GuideNorth (float ms)=0
	Guide north for ms milliseconds.
virtual bool	GuideSouth (float ms)=0
	Guide south for ms milliseconds.
virtual bool	GuideEast (float ms)=0
	Guide east for ms milliseconds.
virtual bool	GuideWest (float ms)=0
	Guide west for ms milliseconds.

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

Detailed Description

Provides interface to implement guider (ST4) port functionality.

initGuiderProperties() must be called before any other function to initilize the guider properties.

Author: Jasem Mutlaq

Definition at line 34 of file indiguiderinterface.h.

Member Function Documentation

virtual bool INDI::GuiderInterface::GuideEast ( float ms )

pure virtual

Guide east for ms milliseconds.

Returns: True if OK, false otherwise

virtual bool INDI::GuiderInterface::GuideNorth ( float ms )

pure virtual

Guide north for ms milliseconds.

Returns: True if OK, false otherwise

virtual bool INDI::GuiderInterface::GuideSouth ( float ms )

pure virtual

Guide south for ms milliseconds.

Returns: True if OK, false otherwise

virtual bool INDI::GuiderInterface::GuideWest ( float ms )

pure virtual

Guide west for ms milliseconds.

Returns: True if OK, false otherwise

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.

Definition at line 36 of file indiguiderinterface.cpp.

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

protected

Call this function whenever client updates GuideNSP 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.

Definition at line 48 of file indiguiderinterface.cpp.

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

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation