#include <x2dome.h>

Inheritance diagram for X2Dome:

Public Member Functions
	X2Dome (const char pszSelectionString, const int &nISIndex, SerXInterface pSerX, TheSkyXFacadeForDriversInterface pTheSkyXForMounts, 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)

LinkInterface Implementation
See LinkInterface.
virtual int	establishLink (void)

virtual int	terminateLink (void)

virtual bool	isLinked (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)

DriverInfoInterface Implementation
See DriverInfoInterface.
virtual void	driverInfoDetailedInfo (BasicStringInterface &str) const

virtual double	driverInfoVersion (void) const

virtual int	dapiGetAzEl (double pdAz, double pdEl)

virtual int	dapiGotoAzEl (double dAz, double dEl)

virtual int	dapiAbort (void)

virtual int	dapiOpen (void)

virtual int	dapiClose (void)

virtual int	dapiPark (void)

virtual int	dapiUnpark (void)

virtual int	dapiFindHome (void)

virtual int	dapiIsGotoComplete (bool *pbComplete)

virtual int	dapiIsOpenComplete (bool *pbComplete)

virtual int	dapiIsCloseComplete (bool *pbComplete)

virtual int	dapiIsParkComplete (bool *pbComplete)

virtual int	dapiIsUnparkComplete (bool *pbComplete)

virtual int	dapiIsFindHomeComplete (bool *pbComplete)

virtual int	dapiSync (double dAz, double dEl)

Detailed Description

The X2Dome example.

Use this example to write an X2Dome driver.

Constructor & Destructor Documentation

◆ X2Dome()

X2Dome::X2Dome	(	const char *	pszSelectionString,
		const int &	nISIndex,
		SerXInterface *	pSerX,
		TheSkyXFacadeForDriversInterface *	pTheSkyXForMounts,
		SleeperInterface *	pSleeper,
		BasicIniUtilInterface *	pIniUtil,
		LoggerInterface *	pLogger,
		MutexInterface *	pIOMutex,
		TickCountInterface *	pTickCount
	)

Standard X2 constructor

Member Function Documentation

◆ dapiAbort()

int X2Dome::dapiAbort ( void )

virtual

Abort any operation in progress.

Implements DomeDriverInterface.

◆ dapiClose()

int X2Dome::dapiClose ( void )

virtual

Inititate closing the dome slit.

See also: dapiIsCloseComplete()

Implements DomeDriverInterface.

◆ dapiFindHome()

int X2Dome::dapiFindHome ( void )

virtual

Inititate finding home.

See also: dapiIsFindHomeComplete()

Implements DomeDriverInterface.

◆ dapiGetAzEl()

int X2Dome::dapiGetAzEl	(	double *	pdAz,
		double *	pdEl
	)

virtual

Return the dome azimuth (and elevation, if necessary).

Implements DomeDriverInterface.

◆ dapiGotoAzEl()

int X2Dome::dapiGotoAzEl	(	double	dAz,
		double	dEl
	)

virtual

Inititate a dome goto.

See also: dapiIsGotoComplete()

Implements DomeDriverInterface.

◆ dapiIsCloseComplete()

int X2Dome::dapiIsCloseComplete ( bool * pbComplete )

virtual

Return if the open is complete.

Implements DomeDriverInterface.

◆ dapiIsFindHomeComplete()

int X2Dome::dapiIsFindHomeComplete ( bool * pbComplete )

virtual

Return if find home is complete.

Implements DomeDriverInterface.

◆ dapiIsGotoComplete()

int X2Dome::dapiIsGotoComplete ( bool * pbComplete )

virtual

Return if the goto is complete.

Implements DomeDriverInterface.

◆ dapiIsOpenComplete()

int X2Dome::dapiIsOpenComplete ( bool * pbComplete )

virtual

Return if the open is complete.

Implements DomeDriverInterface.

◆ dapiIsParkComplete()

int X2Dome::dapiIsParkComplete ( bool * pbComplete )

virtual

Return if the park is complete.

Implements DomeDriverInterface.

◆ dapiIsUnparkComplete()

int X2Dome::dapiIsUnparkComplete ( bool * pbComplete )

virtual

Return if the unpark is complete.

Implements DomeDriverInterface.

◆ dapiOpen()

int X2Dome::dapiOpen ( void )

virtual

Inititate opening the dome slit.

See also: dapiIsOpenComplete()

Implements DomeDriverInterface.

◆ dapiPark()

int X2Dome::dapiPark ( void )

virtual

Inititate parking the dome.

See also: dapiIsParkComplete()

Implements DomeDriverInterface.

◆ dapiSync()

int X2Dome::dapiSync	(	double	dAz,
		double	dEl
	)

virtual

Initialize the dome coordinate to dAz (and dEl if necessary)

Implements DomeDriverInterface.

◆ dapiUnpark()

int X2Dome::dapiUnpark ( void )

virtual

Inititate unparking the dome.

See also: dapiIsUnparkComplete()

Implements DomeDriverInterface.

◆ deviceInfoDetailedDescription()

void X2Dome::deviceInfoDetailedDescription ( BasicStringInterface & str ) const

virtual

Return a detailed device description.

Reimplemented from DomeDriverInterface.

◆ deviceInfoFirmwareVersion()

void X2Dome::deviceInfoFirmwareVersion ( BasicStringInterface & str )

virtual

Return the firmware version, if available.

Reimplemented from DomeDriverInterface.

◆ deviceInfoModel()

void X2Dome::deviceInfoModel ( BasicStringInterface & str )

virtual

Return the device model name.

Reimplemented from DomeDriverInterface.

◆ deviceInfoNameLong()

void X2Dome::deviceInfoNameLong ( BasicStringInterface & str ) const

virtual

Return a detailed device name.

Reimplemented from DomeDriverInterface.

◆ deviceInfoNameShort()

void X2Dome::deviceInfoNameShort ( BasicStringInterface & str ) const

virtual

Return a short device name.

Reimplemented from DomeDriverInterface.

◆ deviceType()

virtual DeviceType X2Dome::deviceType ( void )

inlinevirtual

Returns the type of device.

Reimplemented from DomeDriverInterface.

◆ driverInfoDetailedInfo()

void X2Dome::driverInfoDetailedInfo ( BasicStringInterface & str ) const

virtual

Return detailed information about the driver.

Implements DomeDriverInterface.

◆ driverInfoVersion()

double X2Dome::driverInfoVersion ( void ) const

virtual

Return a version number.

Implements DomeDriverInterface.

◆ establishLink()

int X2Dome::establishLink ( void )

virtual

Connect (link) to the device.

Implements DomeDriverInterface.

◆ isLinked()

bool X2Dome::isLinked ( void ) const

virtual

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

Implements DomeDriverInterface.

◆ queryAbstraction()

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

virtual

Return a pointer to well defined interface.

Implements DomeDriverInterface.

◆ terminateLink()

int X2Dome::terminateLink ( void )

virtual

Disconnect from the device.

Implements DomeDriverInterface.

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

domeplugins/x2dome/x2dome.h
domeplugins/x2dome/x2dome.cpp

Public Member Functions

DriverInfoInterface Implementation

Detailed Description

Constructor & Destructor Documentation

◆ X2Dome()

Member Function Documentation

◆ dapiAbort()

◆ dapiClose()

◆ dapiFindHome()

◆ dapiGetAzEl()

◆ dapiGotoAzEl()

◆ dapiIsCloseComplete()

◆ dapiIsFindHomeComplete()

◆ dapiIsGotoComplete()

◆ dapiIsOpenComplete()

◆ dapiIsParkComplete()

◆ dapiIsUnparkComplete()

◆ dapiOpen()

◆ dapiPark()

◆ dapiSync()

◆ dapiUnpark()

◆ deviceInfoDetailedDescription()

◆ deviceInfoFirmwareVersion()

◆ deviceInfoModel()

◆ deviceInfoNameLong()

◆ deviceInfoNameShort()

◆ deviceType()

◆ driverInfoDetailedInfo()

◆ driverInfoVersion()

◆ establishLink()

◆ isLinked()

◆ queryAbstraction()

◆ terminateLink()