RotatorDriverInterface Class Reference

The RotatorDriverInterface allows an X2 implementor to write a X2 rotator driver. More...

#include <rotatordriverinterface.h>

Inheritance diagram for RotatorDriverInterface:

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
virtual bool	isEstablishLinkAbortable (void) const
virtual int	position (double &dPosition)=0
virtual int	abort (void)=0
virtual int	startRotatorGoto (const double &dTargetPosition)=0
virtual int	isCompleteRotatorGoto (bool &bComplete) const =0
virtual int	endRotatorGoto (void)=0
Public Member Functions inherited from LinkInterface
virtual bool	isEstablishLinkAbortable (void)

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 RotatorDriverInterface allows an X2 implementor to write a X2 rotator driver.

See the X2Rotator for an example.

Member Function Documentation

abort()

virtual int RotatorDriverInterface::abort ( void )

pure virtual

Abort any operation in progress.

Implemented in X2Rotator.

deviceInfoDetailedDescription()

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

pure virtual

Return a detailed device description.

Implements HardwareInfoInterface.

Implemented in X2Rotator.

deviceInfoFirmwareVersion()

virtual void RotatorDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface & str )

pure virtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

Implemented in X2Rotator.

deviceInfoModel()

virtual void RotatorDriverInterface::deviceInfoModel ( BasicStringInterface & str )

pure virtual

Return the device model name.

Implements HardwareInfoInterface.

Implemented in X2Rotator.

deviceInfoNameLong()

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

pure virtual

Return a detailed device name.

Implements HardwareInfoInterface.

Implemented in X2Rotator.

deviceInfoNameShort()

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

pure virtual

Return a short device name.

Implements HardwareInfoInterface.

Implemented in X2Rotator.

deviceType()

virtual DeviceType RotatorDriverInterface::deviceType ( void )

inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

Reimplemented in X2Rotator.

driverInfoDetailedInfo()

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

pure virtual

Return detailed information about the driver.

Implements DriverInfoInterface.

Implemented in X2Rotator.

driverInfoVersion()

virtual double RotatorDriverInterface::driverInfoVersion ( void ) const

pure virtual

Return a version number.

Implements DriverInfoInterface.

Implemented in X2Rotator.

endRotatorGoto()

virtual int RotatorDriverInterface::endRotatorGoto ( void )

pure virtual

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

Implemented in X2Rotator.

establishLink()

virtual int RotatorDriverInterface::establishLink ( void )

pure virtual

Connect (link) to the device.

Implements LinkInterface.

Implemented in X2Rotator.

isCompleteRotatorGoto()

virtual int RotatorDriverInterface::isCompleteRotatorGoto ( bool & bComplete ) const

pure virtual

Called to monitor the goto process.

Parameters

bComplete

Set to true if the goto is complete, otherwise set to false.

Implemented in X2Rotator.

isLinked()

virtual bool RotatorDriverInterface::isLinked ( void ) const

pure virtual

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

Implements LinkInterface.

Implemented in X2Rotator.

position()

virtual int RotatorDriverInterface::position ( double & dPosition )

pure virtual

Return the position of the rotator.

Implemented in X2Rotator.

queryAbstraction()

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

pure virtual

Return a pointer to well defined interface.

Implements DriverRootInterface.

Implemented in X2Rotator.

startRotatorGoto()

virtual int RotatorDriverInterface::startRotatorGoto ( const double & dTargetPosition )

pure virtual

Initiate the rotator goto.

Implemented in X2Rotator.

terminateLink()

virtual int RotatorDriverInterface::terminateLink ( void )

pure virtual

Disconnect from the device.

Implements LinkInterface.

Implemented in X2Rotator.

---

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

• licensedinterfaces/rotatordriverinterface.h