MountDriverInterface Class Reference

The MountDriverInterface allows an X2 implementor to a write X2 mount driver. More...

#include <mountdriverinterface.h>

Inheritance diagram for MountDriverInterface:

Public Types
enum	MotorState {   MKS_MOTOR_HOMING =(0x0100), MKS_MOTOR_SERVO =(0x0200), MKS_MOTOR_INDEXING =(0x0400), MKS_MOTOR_SLEWING =(0x0800),   MKS_MOTOR_HOMED =(0x1000), MKS_MOTOR_JOYSTICKING =(0x2000), MKS_MOTOR_OFF =(0x4000), MKS_MOTOR_MOVING = (MKS_MOTOR_HOMING | MKS_MOTOR_SLEWING | MKS_MOTOR_JOYSTICKING) }
enum	Axis { AXIS_RA = 0, AXIS_DEC = 1 }
enum	MoveDir { MD_NORTH = 0, MD_SOUTH = 1, MD_EAST = 2, MD_WEST = 3 }
enum	MoveRate {   MR_FLASH = -2, MR_BASE = -1, MR_0R5X = 0, MR_1X = 1,   MR_2X = 2, MR_4X = 3, MR_8X = 4, MR_16X = 5,   MR_32X = 6, MR_64X = 7, MR_128X = 8, MR_256X = 9,   MR_SLEW = 10 }
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 }

Public Member Functions
DriverRootInterface Implementation
See DriverRootInterface.
virtual DeviceType	deviceType (void)
virtual int	queryAbstraction (const char *pszName, void **ppVal)=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
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
virtual bool	needsRefactionAdjustments (void)
virtual int	raDec (double &dRawRA, double &dRawDec, const bool &bCached=false)=0
virtual int	abort (void)=0
Public Member Functions inherited from LinkInterface
virtual bool	isEstablishLinkAbortable (void)

Detailed Description

The MountDriverInterface allows an X2 implementor to a write X2 mount driver.

See the X2Mount for an example.

Member Enumeration Documentation

Axis

enum MountDriverInterface::Axis

Axis, Parmamount only.

MotorState

enum MountDriverInterface::MotorState

MotorState, Paramount only.

MoveDir

enum MountDriverInterface::MoveDir

Move direction.

MoveRate

enum MountDriverInterface::MoveRate

MoveRate, Parmamount only.

Member Function Documentation

abort()

virtual int MountDriverInterface::abort ( void  )

pure virtual

Abort any operation currently in progress.

Implemented in X2Mount.

deviceInfoDetailedDescription()

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

pure virtual

Return a detailed device description.

Implements HardwareInfoInterface.

Implemented in X2Mount.

deviceInfoFirmwareVersion()

virtual void MountDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface &  str )

pure virtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

Implemented in X2Mount.

deviceInfoModel()

virtual void MountDriverInterface::deviceInfoModel ( BasicStringInterface &  str )

pure virtual

Return the device model name.

Implements HardwareInfoInterface.

Implemented in X2Mount.

deviceInfoNameLong()

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

pure virtual

Return a detailed device name.

Implements HardwareInfoInterface.

Implemented in X2Mount.

deviceInfoNameShort()

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

pure virtual

Return a short device name.

Implements HardwareInfoInterface.

Implemented in X2Mount.

deviceType()

virtual DeviceType MountDriverInterface::deviceType ( void  )

inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

Reimplemented in X2Mount.

driverInfoDetailedInfo()

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

pure virtual

Return detailed information about the driver.

Implements DriverInfoInterface.

Implemented in X2Mount.

driverInfoVersion()

virtual double MountDriverInterface::driverInfoVersion ( void  ) const

pure virtual

Return a version number.

Implements DriverInfoInterface.

Implemented in X2Mount.

establishLink()

virtual int MountDriverInterface::establishLink ( void  )

pure virtual

Connect (link) to the device.

Implements LinkInterface.

Implemented in X2Mount.

isLinked()

virtual bool MountDriverInterface::isLinked ( void  ) const

pure virtual

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

Implements LinkInterface.

Implemented in X2Mount.

needsRefactionAdjustments()

virtual bool MountDriverInterface::needsRefactionAdjustments ( void  )

inlinevirtual

Return true if the mount wants TheSkyX to handle refraction if and only if the mount itself does not internally handle refraction.

Reimplemented from NeedsRefractionInterface.

queryAbstraction()

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

pure virtual

Return a pointer to well defined interface.

Implements DriverRootInterface.

Implemented in X2Mount.

raDec()

virtual int MountDriverInterface::raDec ( double &  dRawRA, double &  dRawDec, const bool &  bCached = false  )

pure virtual

Return the mechanical or raw right ascension and declination coordinates of the mount.

Parameters

dRawRA	is the right ascension coordinate of the mount from 0 to 24.
dRawDec	is the declination coordinate of the mount from -90 to +90.
bCached	may be ignored.

See also

NeedsRefractionInterface for clarity on what is meant by "mechanical or raw" coordinates.

Implemented in X2Mount.

terminateLink()

virtual int MountDriverInterface::terminateLink ( void  )

pure virtual

Disconnect from the device.

Implements LinkInterface.

Implemented in X2Mount.

---

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

• licensedinterfaces/mountdriverinterface.h