X2Rotator Class Reference

The X2Rotator example. More...

#include <x2rotator.h>

Inheritance diagram for X2Rotator:

Public Member Functions
	X2Rotator (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)
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)
virtual int	terminateLink (void)
virtual bool	isLinked (void) const
virtual bool	isEstablishLinkAbortable (void) const
RotatorDriverInterface Implementation
See RotatorDriverInterface.
virtual int	position (double &dPosition)
virtual int	abort (void)
virtual int	startRotatorGoto (const double &dTargetPosition)
virtual int	isCompleteRotatorGoto (bool &bComplete) const
virtual int	endRotatorGoto (void)
virtual void	portName (BasicStringInterface &str) const
virtual void	setPortName (const char *szPort)
virtual unsigned int	baudRate () const
virtual void	setBaudRate (unsigned int)
virtual bool	isBaudRateFixed () const
virtual SerXInterface::Parity	parity () const
virtual void	setParity (const SerXInterface::Parity &parity)
virtual bool	isParityFixed () const
DriverRootInterface Implementation
See DriverRootInterface.
DriverInfoInterface Implementation
See DriverInfoInterface.
HardwareInfoInterface Implementation
See HardwareInfoInterface.
LinkInterface Implementation
See LinkInterface.
Public Member Functions inherited from LinkInterface
virtual bool	isEstablishLinkAbortable (void)
Public Member Functions inherited from SerialPortParams2Interface
virtual int	dataBits () const
virtual void	setDataBits (const int &nValue)
virtual bool	isDataBitsFixed ()
virtual int	stopBits () const
virtual void	setStopBits (const int &nValue)
virtual bool	isStopBitsFixed ()
virtual int	flowControl () const
virtual void	setFlowControl (const int &nValue)
virtual bool	isFlowControlFixed ()

ModalSettingsDialogInterface Implementation
See ModalSettingsDialogInterface.
virtual int	initModalSettingsDialog (void)
virtual int	execModalSettingsDialog (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 X2Rotator example.

Use this example to write an X2Rotator driver.

Constructor & Destructor Documentation

X2Rotator()

X2Rotator::X2Rotator	(	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

abort()

int X2Rotator::abort ( void  )

virtual

Abort any operation in progress.

Implements RotatorDriverInterface.

baudRate()

virtual unsigned int X2Rotator::baudRate ( ) const

inlinevirtual

Return the buad rate.

Implements SerialPortParams2Interface.

deviceInfoDetailedDescription()

void X2Rotator::deviceInfoDetailedDescription ( BasicStringInterface &  str ) const

virtual

Return a detailed device description.

Implements RotatorDriverInterface.

deviceInfoFirmwareVersion()

void X2Rotator::deviceInfoFirmwareVersion ( BasicStringInterface &  str )

virtual

Return the firmware version, if available.

Implements RotatorDriverInterface.

deviceInfoModel()

void X2Rotator::deviceInfoModel ( BasicStringInterface &  str )

virtual

Return the device model name.

Implements RotatorDriverInterface.

deviceInfoNameLong()

void X2Rotator::deviceInfoNameLong ( BasicStringInterface &  str ) const

virtual

Return a detailed device name.

Implements RotatorDriverInterface.

deviceInfoNameShort()

void X2Rotator::deviceInfoNameShort ( BasicStringInterface &  str ) const

virtual

Return a short device name.

Implements RotatorDriverInterface.

deviceType()

virtual DeviceType X2Rotator::deviceType ( void  )

inlinevirtual

Returns the type of device.

Reimplemented from RotatorDriverInterface.

driverInfoDetailedInfo()

void X2Rotator::driverInfoDetailedInfo ( BasicStringInterface &  str ) const

virtual

Return detailed information about the driver.

Implements RotatorDriverInterface.

driverInfoVersion()

double X2Rotator::driverInfoVersion ( void  ) const

virtual

Return a version number.

Implements RotatorDriverInterface.

endRotatorGoto()

int X2Rotator::endRotatorGoto ( void  )

virtual

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

Implements RotatorDriverInterface.

establishLink()

int X2Rotator::establishLink ( void  )

virtual

Connect (link) to the device.

Implements RotatorDriverInterface.

execModalSettingsDialog()

int X2Rotator::execModalSettingsDialog ( void  )

virtual

Execute and display the modal settings dialog.

Implements ModalSettingsDialogInterface.

initModalSettingsDialog()

virtual int X2Rotator::initModalSettingsDialog ( void  )

inlinevirtual

Initialize the modal settings dialog.

Implements ModalSettingsDialogInterface.

isBaudRateFixed()

virtual bool X2Rotator::isBaudRateFixed ( ) const

inlinevirtual

Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.

Implements SerialPortParams2Interface.

isCompleteRotatorGoto()

int X2Rotator::isCompleteRotatorGoto ( bool &  bComplete ) const

virtual

Called to moitor the goto process.

Parameters

bComplete

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

Implements RotatorDriverInterface.

isLinked()

bool X2Rotator::isLinked ( void  ) const

virtual

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

Implements RotatorDriverInterface.

isParityFixed()

virtual bool X2Rotator::isParityFixed ( ) const

inlinevirtual

Return if the parameter is fixed or not. The general user interface will hide this parameter if it is fixed.

Implements SerialPortParams2Interface.

parity()

virtual SerXInterface::Parity X2Rotator::parity ( ) const

inlinevirtual

Return the parity.

Implements SerialPortParams2Interface.

portName()

void X2Rotator::portName ( BasicStringInterface &  str ) const

virtual

Return serial port name as a string.

Implements SerialPortParams2Interface.

position()

int X2Rotator::position ( double &  dPosition )

virtual

Return the position of the rotator.

Implements RotatorDriverInterface.

queryAbstraction()

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

virtual

Return a pointer to well defined interface.

Implements RotatorDriverInterface.

setBaudRate()

virtual void X2Rotator::setBaudRate ( unsigned int  )

inlinevirtual

Set the baud rate.

Implements SerialPortParams2Interface.

setParity()

virtual void X2Rotator::setParity ( const SerXInterface::Parity &  parity )

inlinevirtual

Set the parity.

Implements SerialPortParams2Interface.

setPortName()

void X2Rotator::setPortName ( const char *  szPort )

virtual

Set the serial port name as a string.

Implements SerialPortParams2Interface.

startRotatorGoto()

int X2Rotator::startRotatorGoto ( const double &  dTargetPosition )

virtual

Initiate the rotator goto.

Implements RotatorDriverInterface.

terminateLink()

int X2Rotator::terminateLink ( void  )

virtual

Disconnect from the device.

Implements RotatorDriverInterface.

---

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

• rotatorplugins/x2rotator/x2rotator.h
• rotatorplugins/x2rotator/x2rotator.cpp