FocuserDriverInterface Class Reference

The FocuserDriverInterface allows an X2 implementor to a write X2 focuser driver. More...

#include <focuserdriverinterface.h>

Inheritance diagram for FocuserDriverInterface:

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
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)
LinkInterface Implementation
See LinkInterface.
virtual int	establishLink (void)=0
virtual int	terminateLink (void)=0
virtual bool	isLinked (void) const =0
FocuserGotoInterface2 Implementation
See FocuserGotoInterface2.
virtual int	focPosition (int &nPosition)=0
virtual int	focMinimumLimit (int &nMinLimit)=0
virtual int	focMaximumLimit (int &nMaxLimit)=0
virtual int	focAbort ()=0
virtual int	startFocGoto (const int &nRelativeOffset)=0
virtual int	isCompleteFocGoto (bool &bComplete) const =0
virtual int	endFocGoto (void)=0
virtual int	amountCountFocGoto (void) const =0
virtual int	amountNameFromIndexFocGoto (const int &nZeroBasedIndex, BasicStringInterface &strDisplayName, int &nAmount)=0
virtual int	amountIndexFocGoto (void)=0
Public Member Functions inherited from LinkInterface
virtual bool	isEstablishLinkAbortable (void)
Public Member Functions inherited from FocuserGotoInterface2
virtual void	embeddedFocuserInit (const char *psFilterWheelSelection)
virtual void	embeddedFocuserInit (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 FocuserDriverInterface allows an X2 implementor to a write X2 focuser driver.

See the X2Focuser for an example.

Member Function Documentation

amountCountFocGoto()

virtual int FocuserDriverInterface::amountCountFocGoto ( void  ) const

pure virtual

Return the number (count) of avaiable focuser gotos.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

amountIndexFocGoto()

virtual int FocuserDriverInterface::amountIndexFocGoto ( void  )

pure virtual

Return the current index of focuser goto selection.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

amountNameFromIndexFocGoto()

virtual int FocuserDriverInterface::amountNameFromIndexFocGoto ( const int &  nZeroBasedIndex, BasicStringInterface &  strDisplayName, int &  nAmount  )

pure virtual

Return a string along with the amount or size of the corresponding focuser goto.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

deviceInfoDetailedDescription()

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

inlinevirtual

Return a detailed device description.

Implements HardwareInfoInterface.

Reimplemented in X2Focuser.

deviceInfoFirmwareVersion()

virtual void FocuserDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface &  str )

inlinevirtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

Reimplemented in X2Focuser.

deviceInfoModel()

virtual void FocuserDriverInterface::deviceInfoModel ( BasicStringInterface &  str )

inlinevirtual

Return the device model name.

Implements HardwareInfoInterface.

Reimplemented in X2Focuser.

deviceInfoNameLong()

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

inlinevirtual

Return a detailed device name.

Implements HardwareInfoInterface.

Reimplemented in X2Focuser.

deviceInfoNameShort()

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

inlinevirtual

Return a short device name.

Implements HardwareInfoInterface.

Reimplemented in X2Focuser.

deviceType()

virtual DeviceType FocuserDriverInterface::deviceType ( void  )

inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

driverInfoDetailedInfo()

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

inlinevirtual

Return detailed information about the driver.

Implements DriverInfoInterface.

Reimplemented in X2Focuser.

driverInfoVersion()

virtual double FocuserDriverInterface::driverInfoVersion ( void  ) const

inlinevirtual

Return a version number.

Implements DriverInfoInterface.

Reimplemented in X2Focuser.

endFocGoto()

virtual int FocuserDriverInterface::endFocGoto ( void  )

pure virtual

Called after the goto is complete. This is called once for every corresponding startFocGoto() allowing software implementations of focuser gotos.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

establishLink()

virtual int FocuserDriverInterface::establishLink ( void  )

pure virtual

Connect (link) to the device.

Implements LinkInterface.

Implemented in X2Focuser.

focAbort()

virtual int FocuserDriverInterface::focAbort ( )

pure virtual

Abort an operation in progress.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

focMaximumLimit()

virtual int FocuserDriverInterface::focMaximumLimit ( int &  nMaxLimit )

pure virtual

Return the focusers maximum limit.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

focMinimumLimit()

virtual int FocuserDriverInterface::focMinimumLimit ( int &  nMinLimit )

pure virtual

Return the focusers minimum limit.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

focPosition()

virtual int FocuserDriverInterface::focPosition ( int &  nPosition )

pure virtual

Return the position of the focuser. If the hardware doesn't have a digital read out, return a number that roughly corresponds to whatever units the focuser moves in (time, lenght, etc.)

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

isCompleteFocGoto()

virtual int FocuserDriverInterface::isCompleteFocGoto ( bool &  bComplete ) const

pure virtual

Return if the goto is complete.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

isLinked()

virtual bool FocuserDriverInterface::isLinked ( void  ) const

pure virtual

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

Implements LinkInterface.

Implemented in X2Focuser.

queryAbstraction()

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

pure virtual

Return a pointer to well defined interface.

Implements DriverRootInterface.

Implemented in X2Focuser.

startFocGoto()

virtual int FocuserDriverInterface::startFocGoto ( const int &  nRelativeOffset )

pure virtual

Initiate the focus goto operation.

Implements FocuserGotoInterface2.

Implemented in X2Focuser.

terminateLink()

virtual int FocuserDriverInterface::terminateLink ( void  )

pure virtual

Disconnect from the device.

Implements LinkInterface.

Implemented in X2Focuser.

---

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

• licensedinterfaces/focuserdriverinterface.h