#include <x2filterwheel.h>

Inheritance diagram for X2FilterWheel:

Public Member Functions
	X2FilterWheel (const char pszDriverSelection, const int &nInstanceIndex, SerXInterface pSerX, TheSkyXFacadeForDriversInterface pTheSkyX, SleeperInterface pSleeper, BasicIniUtilInterface pIniUtil, LoggerInterface pLogger, MutexInterface pIOMutex, TickCountInterface pTickCount)

DriverRootInterface Implementation
See DriverRootInterface.
virtual DeviceType	deviceType (void)

virtual int	queryAbstraction (const char pszName, void *ppVal)

LinkInterface Implementation
See LinkInterface.
virtual int	establishLink (void)

virtual int	terminateLink (void)

virtual bool	isLinked (void) const

virtual bool	isEstablishLinkAbortable (void) const

DriverInfoInterface Implementation
See DriverInfoInterface.
virtual void	driverInfoDetailedInfo (BasicStringInterface &str) const

virtual double	driverInfoVersion (void) const

HardwareInfoInterface Implementation
See HardwareInfoInterface.
virtual void	deviceInfoNameShort (BasicStringInterface &str) const

virtual void	deviceInfoNameLong (BasicStringInterface &str) const

virtual void	deviceInfoDetailedDescription (BasicStringInterface &str) const

virtual void	deviceInfoFirmwareVersion (BasicStringInterface &str)

virtual void	deviceInfoModel (BasicStringInterface &str)

FilterWheelMoveToInterface Implementation
See FilterWheelMoveToInterface.
virtual int	filterCount (int &nCount)

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

virtual int	startFilterWheelMoveTo (const int &nTargetPosition)

virtual int	isCompleteFilterWheelMoveTo (bool &bComplete) const

virtual int	endFilterWheelMoveTo (void)

virtual int	abortFilterWheelMoveTo (void)

ModalSettingsDialogInterface Implementation
See ModalSettingsDialogInterface.
virtual int	initModalSettingsDialog (void)

virtual int	execModalSettingsDialog (void)

DriverRootInterface Implementation
See DriverRootInterface.
DriverInfoInterface Implementation
See DriverInfoInterface.
HardwareInfoInterface Implementation
See HardwareInfoInterface.
LinkInterface Implementation
See LinkInterface.
FilterWheelMoveToInterface Implementation
See FilterWheelMoveToInterface.
Public Member Functions inherited from LinkInterface
virtual bool	isEstablishLinkAbortable (void)

Public Member Functions inherited from FilterWheelMoveToInterface
virtual void	embeddedFilterWheelInit (const char *psFilterWheelSelection)

X2GUIEventInterface Implementation
See X2GUIEventInterface.
virtual void	uiEvent (X2GUIExchangeInterface uiex, const char pszEvent)

Additional Inherited Members
Public Types inherited from DriverRootInterface
enum	DeviceType { DT_UNKNOWN = 0, DT_MOUNT = 1, DT_FOCUSER = 2, DT_CAMERA = 3, DT_FILTERWHEEL = 4, DT_DOME = 5, DT_ROTATOR = 6, DT_WEATHER = 7, DT_GPSTFP = 8, DT_VIDEO = 9, DT_OTA =10, DT_AO =11, DT_POWERCONTROL =12, DT_PRIVATE_A =13 }

Detailed Description

The X2FilterWheel example.

Use this example to write an X2FilterWheel driver.

Utilizes ModalSettingsDialogInterface and X2GUIEventInterface for a basic, cross-platform, user interface.

Constructor & Destructor Documentation

◆ X2FilterWheel()

X2FilterWheel::X2FilterWheel	(	const char *	pszDriverSelection,
		const int &	nInstanceIndex,
		SerXInterface *	pSerX,
		TheSkyXFacadeForDriversInterface *	pTheSkyX,
		SleeperInterface *	pSleeper,
		BasicIniUtilInterface *	pIniUtil,
		LoggerInterface *	pLogger,
		MutexInterface *	pIOMutex,
		TickCountInterface *	pTickCount
	)

Standard X2 constructor

Member Function Documentation

◆ abortFilterWheelMoveTo()

int X2FilterWheel::abortFilterWheelMoveTo ( void )

virtual

Abort any move to operation in progress.

Implements FilterWheelDriverInterface.

◆ defaultFilterName()

int X2FilterWheel::defaultFilterName	(	const int &	nIndex,
		BasicStringInterface &	strFilterNameOut
	)

virtual

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.

Implements FilterWheelDriverInterface.

◆ deviceInfoDetailedDescription()

void X2FilterWheel::deviceInfoDetailedDescription ( BasicStringInterface & str ) const

virtual

Return a detailed device description.

Implements FilterWheelDriverInterface.

◆ deviceInfoFirmwareVersion()

void X2FilterWheel::deviceInfoFirmwareVersion ( BasicStringInterface & str )

virtual

Return the firmware version, if available.

Implements FilterWheelDriverInterface.

◆ deviceInfoModel()

void X2FilterWheel::deviceInfoModel ( BasicStringInterface & str )

virtual

Return the device model name.

Implements FilterWheelDriverInterface.

◆ deviceInfoNameLong()

void X2FilterWheel::deviceInfoNameLong ( BasicStringInterface & str ) const

virtual

Return a detailed device name.

Implements FilterWheelDriverInterface.

◆ deviceInfoNameShort()

void X2FilterWheel::deviceInfoNameShort ( BasicStringInterface & str ) const

virtual

Return a short device name.

Implements FilterWheelDriverInterface.

◆ deviceType()

virtual DeviceType X2FilterWheel::deviceType ( void )

inlinevirtual

Returns the type of device.

Reimplemented from FilterWheelDriverInterface.

◆ driverInfoDetailedInfo()

void X2FilterWheel::driverInfoDetailedInfo ( BasicStringInterface & str ) const

virtual

Return detailed information about the driver.

Implements FilterWheelDriverInterface.

◆ driverInfoVersion()

double X2FilterWheel::driverInfoVersion ( void ) const

virtual

Return a version number.

Implements FilterWheelDriverInterface.

◆ endFilterWheelMoveTo()

int X2FilterWheel::endFilterWheelMoveTo ( void )

virtual

End the move to. This function is always called for every corresponding startFilterWheelMoveTo(), allowing software implementations of move to.

Implements FilterWheelDriverInterface.

◆ establishLink()

int X2FilterWheel::establishLink ( void )

virtual

Connect (link) to the device.

Implements FilterWheelDriverInterface.

◆ execModalSettingsDialog()

int X2FilterWheel::execModalSettingsDialog ( void )

virtual

Execute and display the modal settings dialog.

Implements ModalSettingsDialogInterface.

◆ filterCount()

int X2FilterWheel::filterCount ( int & nCount )

virtual

Return the total number of available filters.

Implements FilterWheelDriverInterface.

◆ initModalSettingsDialog()

virtual int X2FilterWheel::initModalSettingsDialog ( void )

inlinevirtual

Initialize the modal settings dialog.

Implements ModalSettingsDialogInterface.

◆ isCompleteFilterWheelMoveTo()

int X2FilterWheel::isCompleteFilterWheelMoveTo ( bool & bComplete ) const

virtual

Sets bComplete to non zero when the move to is complete.

Implements FilterWheelDriverInterface.

◆ isLinked()

bool X2FilterWheel::isLinked ( void ) const

virtual

Return true if there is a connection, otherwise return false.

Implements FilterWheelDriverInterface.

◆ queryAbstraction()

int X2FilterWheel::queryAbstraction	(	const char *	pszName,
		void **	ppVal
	)

virtual

Return a pointer to well defined interface.

Implements FilterWheelDriverInterface.

◆ startFilterWheelMoveTo()

int X2FilterWheel::startFilterWheelMoveTo ( const int & nTargetPosition )

virtual

Start the move to operation.

Implements FilterWheelDriverInterface.

◆ terminateLink()

int X2FilterWheel::terminateLink ( void )

virtual

Disconnect from the device.

Implements FilterWheelDriverInterface.

◆ uiEvent()

void X2FilterWheel::uiEvent	(	X2GUIExchangeInterface *	uiex,
		const char *	pszEvent
	)

virtual

Take what ever action is necessary when a user interface event happens, for example, the user pressed a button.

Parameters

pszEvent The name of the event that occured following the convention "on_<object name>_<signal name>".

Implements X2GUIEventInterface.

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

filterwheelplugins/x2filterwheel/x2filterwheel.h
filterwheelplugins/x2filterwheel/x2filterwheel.cpp

Public Member Functions

X2GUIEventInterface Implementation

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ X2FilterWheel()

Member Function Documentation

◆ abortFilterWheelMoveTo()

◆ defaultFilterName()

◆ deviceInfoDetailedDescription()

◆ deviceInfoFirmwareVersion()

◆ deviceInfoModel()

◆ deviceInfoNameLong()

◆ deviceInfoNameShort()

◆ deviceType()

◆ driverInfoDetailedInfo()

◆ driverInfoVersion()

◆ endFilterWheelMoveTo()

◆ establishLink()

◆ execModalSettingsDialog()

◆ filterCount()

◆ initModalSettingsDialog()

◆ isCompleteFilterWheelMoveTo()

◆ isLinked()

◆ queryAbstraction()

◆ startFilterWheelMoveTo()

◆ terminateLink()

◆ uiEvent()