The DomeDriverInterface allows an X2 implementor to a write X2 dome driver. More...

#include <domedriverinterface.h>

Inheritance diagram for DomeDriverInterface:

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

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 =0

virtual double	driverInfoVersion (void) const =0

virtual int	dapiGetAzEl (double pdAz, double pdEl)=0

virtual int	dapiGotoAzEl (double dAz, double dEl)=0

virtual int	dapiAbort (void)=0

virtual int	dapiOpen (void)=0

virtual int	dapiClose (void)=0

virtual int	dapiPark (void)=0

virtual int	dapiUnpark (void)=0

virtual int	dapiFindHome (void)=0

Is Complete Members
virtual int	dapiIsGotoComplete (bool *pbComplete)=0

virtual int	dapiIsOpenComplete (bool *pbComplete)=0

virtual int	dapiIsCloseComplete (bool *pbComplete)=0

virtual int	dapiIsParkComplete (bool *pbComplete)=0

virtual int	dapiIsUnparkComplete (bool *pbComplete)=0

virtual int	dapiIsFindHomeComplete (bool *pbComplete)=0

virtual int	dapiSync (double dAz, double dEl)=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 DomeDriverInterface allows an X2 implementor to a write X2 dome driver.

Member Function Documentation

◆ dapiAbort()

virtual int DomeDriverInterface::dapiAbort ( void )

pure virtual

Abort any operation in progress.

Implemented in X2Dome.

◆ dapiClose()

virtual int DomeDriverInterface::dapiClose ( void )

pure virtual

Inititate closing the dome slit.

See also: dapiIsCloseComplete()

Implemented in X2Dome.

◆ dapiFindHome()

virtual int DomeDriverInterface::dapiFindHome ( void )

pure virtual

Inititate finding home.

See also: dapiIsFindHomeComplete()

Implemented in X2Dome.

◆ dapiGetAzEl()

virtual int DomeDriverInterface::dapiGetAzEl	(	double *	pdAz,
		double *	pdEl
	)

pure virtual

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

Implemented in X2Dome.

◆ dapiGotoAzEl()

virtual int DomeDriverInterface::dapiGotoAzEl	(	double	dAz,
		double	dEl
	)

pure virtual

Inititate a dome goto.

See also: dapiIsGotoComplete()

Implemented in X2Dome.

◆ dapiIsCloseComplete()

virtual int DomeDriverInterface::dapiIsCloseComplete ( bool * pbComplete )

pure virtual

Return if the open is complete.

Implemented in X2Dome.

◆ dapiIsFindHomeComplete()

virtual int DomeDriverInterface::dapiIsFindHomeComplete ( bool * pbComplete )

pure virtual

Return if find home is complete.

Implemented in X2Dome.

◆ dapiIsGotoComplete()

virtual int DomeDriverInterface::dapiIsGotoComplete ( bool * pbComplete )

pure virtual

Return if the goto is complete.

Implemented in X2Dome.

◆ dapiIsOpenComplete()

virtual int DomeDriverInterface::dapiIsOpenComplete ( bool * pbComplete )

pure virtual

Return if the open is complete.

Implemented in X2Dome.

◆ dapiIsParkComplete()

virtual int DomeDriverInterface::dapiIsParkComplete ( bool * pbComplete )

pure virtual

Return if the park is complete.

Implemented in X2Dome.

◆ dapiIsUnparkComplete()

virtual int DomeDriverInterface::dapiIsUnparkComplete ( bool * pbComplete )

pure virtual

Return if the unpark is complete.

Implemented in X2Dome.

◆ dapiOpen()

virtual int DomeDriverInterface::dapiOpen ( void )

pure virtual

Inititate opening the dome slit.

See also: dapiIsOpenComplete()

Implemented in X2Dome.

◆ dapiPark()

virtual int DomeDriverInterface::dapiPark ( void )

pure virtual

Inititate parking the dome.

See also: dapiIsParkComplete()

Implemented in X2Dome.

◆ dapiSync()

virtual int DomeDriverInterface::dapiSync	(	double	dAz,
		double	dEl
	)

pure virtual

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

Implemented in X2Dome.

◆ dapiUnpark()

virtual int DomeDriverInterface::dapiUnpark ( void )

pure virtual

Inititate unparking the dome.

See also: dapiIsUnparkComplete()

Implemented in X2Dome.

◆ deviceInfoDetailedDescription()

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

inlinevirtual

Return a detailed device description.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

◆ deviceInfoFirmwareVersion()

virtual void DomeDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface & str )

inlinevirtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

◆ deviceInfoModel()

virtual void DomeDriverInterface::deviceInfoModel ( BasicStringInterface & str )

inlinevirtual

Return the device model name.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

◆ deviceInfoNameLong()

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

inlinevirtual

Return a detailed device name.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

◆ deviceInfoNameShort()

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

inlinevirtual

Return a short device name.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

◆ deviceType()

virtual DeviceType DomeDriverInterface::deviceType ( void )

inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

Reimplemented in X2Dome.

◆ driverInfoDetailedInfo()

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

pure virtual

Return detailed information about the driver.

Implements DriverInfoInterface.

Implemented in X2Dome.

◆ driverInfoVersion()

virtual double DomeDriverInterface::driverInfoVersion ( void ) const

pure virtual

Return a version number.

Implements DriverInfoInterface.

Implemented in X2Dome.

◆ establishLink()

virtual int DomeDriverInterface::establishLink ( void )

pure virtual

Connect (link) to the device.

Implements LinkInterface.

Implemented in X2Dome.

◆ isLinked()

virtual bool DomeDriverInterface::isLinked ( void ) const

pure virtual

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

Implements LinkInterface.

Implemented in X2Dome.

◆ queryAbstraction()

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

pure virtual

Return a pointer to well defined interface.

Implements DriverRootInterface.

Implemented in X2Dome.

◆ terminateLink()

virtual int DomeDriverInterface::terminateLink ( void )

pure virtual

Disconnect from the device.

Implements LinkInterface.

Implemented in X2Dome.

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

licensedinterfaces/domedriverinterface.h

Public Member Functions

Additional Inherited Members

Detailed Description

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()