FilterWheelDriverInterface Class Reference

The FilterWheelDriverInterface allows an X2 implementor to a write X2 filter wheel driver. More...

#include <filterwheeldriverinterface.h>

Inheritance diagram for FilterWheelDriverInterface:

Public Member Functions
DriverRootInterface Implementation
See DriverRootInterface.
virtual DeviceType	deviceType (void)
virtual int	queryAbstraction (const char *pszName, void **ppVal)=0
DriverInfoInterface Implementation
See DriverInfoInterface.
virtual void	driverInfoDetailedInfo (BasicStringInterface &str) const =0
virtual double	driverInfoVersion (void) const =0
HardwareInfoInterface Implementation
See HardwareInfoInterface.
virtual void	deviceInfoNameShort (BasicStringInterface &str) const =0
virtual void	deviceInfoNameLong (BasicStringInterface &str) const =0
virtual void	deviceInfoDetailedDescription (BasicStringInterface &str) const =0
virtual void	deviceInfoFirmwareVersion (BasicStringInterface &str)=0
virtual void	deviceInfoModel (BasicStringInterface &str)=0
LinkInterface Implementation
See LinkInterface.
virtual int	establishLink (void)=0
virtual int	terminateLink (void)=0
virtual bool	isLinked (void) const =0
FilterWheelMoveToInterface Implementation
See FilterWheelMoveToInterface.
virtual int	filterCount (int &nCount)=0
virtual int	defaultFilterName (const int &nIndex, BasicStringInterface &strFilterNameOut)=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
Public Member Functions inherited from LinkInterface
virtual bool	isEstablishLinkAbortable (void)
Public Member Functions inherited from FilterWheelMoveToInterface
virtual void	embeddedFilterWheelInit (const char *psFilterWheelSelection)

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 FilterWheelDriverInterface allows an X2 implementor to a write X2 filter wheel driver.

See the X2FilterWheel for an example.

Member Function Documentation

abortFilterWheelMoveTo()

virtual int FilterWheelDriverInterface::abortFilterWheelMoveTo ( void )

pure virtual

Abort any move to operation in progress.

Implements FilterWheelMoveToInterface.

Implemented in X2FilterWheel.

defaultFilterName()

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

pure 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 implementation 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 from FilterWheelMoveToInterface.

Implemented in X2FilterWheel.

deviceInfoDetailedDescription()

virtual void FilterWheelDriverInterface::deviceInfoDetailedDescription ( BasicStringInterface & str ) const

pure virtual

Return a detailed device description.

Implements HardwareInfoInterface.

Implemented in X2FilterWheel.

deviceInfoFirmwareVersion()

virtual void FilterWheelDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface & str )

pure virtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

Implemented in X2FilterWheel.

deviceInfoModel()

virtual void FilterWheelDriverInterface::deviceInfoModel ( BasicStringInterface & str )

pure virtual

Return the device model name.

Implements HardwareInfoInterface.

Implemented in X2FilterWheel.

deviceInfoNameLong()

virtual void FilterWheelDriverInterface::deviceInfoNameLong ( BasicStringInterface & str ) const

pure virtual

Return a detailed device name.

Implements HardwareInfoInterface.

Implemented in X2FilterWheel.

deviceInfoNameShort()

virtual void FilterWheelDriverInterface::deviceInfoNameShort ( BasicStringInterface & str ) const

pure virtual

Return a short device name.

Implements HardwareInfoInterface.

Implemented in X2FilterWheel.

deviceType()

virtual DeviceType FilterWheelDriverInterface::deviceType ( void )

inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

Reimplemented in X2FilterWheel.

driverInfoDetailedInfo()

virtual void FilterWheelDriverInterface::driverInfoDetailedInfo ( BasicStringInterface & str ) const

pure virtual

Return detailed information about the driver.

Implements DriverInfoInterface.

Implemented in X2FilterWheel.

driverInfoVersion()

virtual double FilterWheelDriverInterface::driverInfoVersion ( void ) const

pure virtual

Return a version number.

Implements DriverInfoInterface.

Implemented in X2FilterWheel.

endFilterWheelMoveTo()

virtual int FilterWheelDriverInterface::endFilterWheelMoveTo ( void )

pure virtual

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

Implements FilterWheelMoveToInterface.

Implemented in X2FilterWheel.

establishLink()

virtual int FilterWheelDriverInterface::establishLink ( void )

pure virtual

Connect (link) to the device.

Implements LinkInterface.

Implemented in X2FilterWheel.

filterCount()

virtual int FilterWheelDriverInterface::filterCount ( int & nCount )

pure virtual

Return the total number of available filters.

Implements FilterWheelMoveToInterface.

Implemented in X2FilterWheel.

isCompleteFilterWheelMoveTo()

virtual int FilterWheelDriverInterface::isCompleteFilterWheelMoveTo ( bool & bComplete ) const

pure virtual

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

Implements FilterWheelMoveToInterface.

Implemented in X2FilterWheel.

isLinked()

virtual bool FilterWheelDriverInterface::isLinked ( void ) const

pure virtual

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

Implements LinkInterface.

Implemented in X2FilterWheel.

queryAbstraction()

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

pure virtual

Return a pointer to well defined interface.

Implements DriverRootInterface.

Implemented in X2FilterWheel.

startFilterWheelMoveTo()

virtual int FilterWheelDriverInterface::startFilterWheelMoveTo ( const int & nTargetPosition )

pure virtual

Start the move to operation.

Implements FilterWheelMoveToInterface.

Implemented in X2FilterWheel.

terminateLink()

virtual int FilterWheelDriverInterface::terminateLink ( void )

pure virtual

Disconnect from the device.

Implements LinkInterface.

Implemented in X2FilterWheel.

---

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

• licensedinterfaces/filterwheeldriverinterface.h