The FilterWheelMoveToInterface allows moving to a specific filter. More...

#include <filterwheelmovetointerface.h>

Inheritance diagram for FilterWheelMoveToInterface:

Public Member Functions
virtual int	filterCount (int &nCount)=0

virtual int	startFilterWheelMoveTo (const int &nTargetPosition)=0

virtual int	isCompleteFilterWheelMoveTo (bool &bComplete) const =0

virtual int	endFilterWheelMoveTo (void)=0

virtual int	abortFilterWheelMoveTo (void)=0

virtual int	defaultFilterName (const int &nIndex, BasicStringInterface &strFilterNameOut)

virtual void	embeddedFilterWheelInit (const char *psFilterWheelSelection)

Detailed Description

The FilterWheelMoveToInterface allows moving to a specific filter.

This interface is used by TheSkyX to move a filter wheel to a specific filter. By nature this interface supports moving to a filter asyncrhonously, but can also be used to move to a filter synchronously.

Member Function Documentation

◆ abortFilterWheelMoveTo()

virtual int FilterWheelMoveToInterface::abortFilterWheelMoveTo ( void )

pure virtual

Abort any move to operation in progress.

Implemented in FilterWheelDriverInterface, and X2FilterWheel.

◆ defaultFilterName()

virtual int FilterWheelMoveToInterface::defaultFilterName	(	const int &	nIndex,
		BasicStringInterface &	strFilterNameOut
	)

inlinevirtual

Return a default name of the filter associated with nIndex (in the range 0 to nCount-1 returned by filterCount(nCount)).
This is optional and gives X2 drivers a way to provide a default filter name if so desired. The default implemenation does nothing, in which case TheSky will provide a default name for each filter. TheSkyX provides a means for users to edit filter names as well.

Reimplemented in FilterWheelDriverInterface, and X2FilterWheel.

◆ embeddedFilterWheelInit()

virtual void FilterWheelMoveToInterface::embeddedFilterWheelInit ( const char * psFilterWheelSelection )

inlinevirtual

The default implementation of this function does nothing which is correct for most filter wheels. Only consider this function if you are implementing a camera's embedded filter wheel.

If a CameraDriverInterface implements the FilterWheelMoveToInterface (for an embedded filter wheel), TheSkyX calls embeddedFilterWheelInit passing along the name of the filter wheel selection just prior to establishLink for the camera. This serves to provide the camera sufficient information to be prepared for filter wheel control. X2 implementors can give many names to an embedded filter wheel(s) through their hardwarelist.txt, in case that differentiation helps in implementation or there are n filter wheel models to choose from. For more information, see the Embedded Devices page.