X2 Standard  Version 1.21
Public Member Functions | List of all members
DomeDriverInterface Class Referenceabstract

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

#include <domedriverinterface.h>

Inheritance diagram for DomeDriverInterface:
DriverRootInterface LinkInterface HardwareInfoInterface DriverInfoInterface X2Dome

Public Member Functions

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
 
virtual int dapiSync (double dAz, double dEl)=0
 
DriverRootInterface Implementation
virtual DeviceType deviceType (void)
 
virtual int queryAbstraction (const char *pszName, void **ppVal)=0
 
LinkInterface Implementation
virtual int establishLink (void)=0
 
virtual int terminateLink (void)=0
 
virtual bool isLinked (void) const =0
 
HardwareInfoInterface Implementation
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
virtual void driverInfoDetailedInfo (BasicStringInterface &str) const =0
 
virtual double driverInfoVersion (void) const =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
 

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
}
 

Detailed Description

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

Member Function Documentation

virtual int DomeDriverInterface::dapiAbort ( void  )
pure virtual

Abort any operation in progress.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiClose ( void  )
pure virtual

Inititate closing the dome slit.

See also
dapiIsCloseComplete()

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiFindHome ( void  )
pure virtual

Inititate finding home.

See also
dapiIsFindHomeComplete()

Implemented in X2Dome.

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

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

Implemented in X2Dome.

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

Inititate a dome goto.

See also
dapiIsGotoComplete()

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiIsCloseComplete ( bool *  pbComplete)
pure virtual

Return if the open is complete.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiIsFindHomeComplete ( bool *  pbComplete)
pure virtual

Return if find home is complete.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiIsGotoComplete ( bool *  pbComplete)
pure virtual

Return if the goto is complete.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiIsOpenComplete ( bool *  pbComplete)
pure virtual

Return if the open is complete.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiIsParkComplete ( bool *  pbComplete)
pure virtual

Return if the park is complete.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiIsUnparkComplete ( bool *  pbComplete)
pure virtual

Return if the unpark is complete.

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiOpen ( void  )
pure virtual

Inititate opening the dome slit.

See also
dapiIsOpenComplete()

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiPark ( void  )
pure virtual

Inititate parking the dome.

See also
dapiIsParkComplete()

Implemented in X2Dome.

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

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

Implemented in X2Dome.

virtual int DomeDriverInterface::dapiUnpark ( void  )
pure virtual

Inititate unparking the dome.

See also
dapiIsUnparkComplete()

Implemented in X2Dome.

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

Return a detailed device description.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

virtual void DomeDriverInterface::deviceInfoFirmwareVersion ( BasicStringInterface str)
inlinevirtual

Return the firmware version, if available.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

virtual void DomeDriverInterface::deviceInfoModel ( BasicStringInterface str)
inlinevirtual

Return the device model name.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

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

Return a detailed device name.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

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

Return a short device name.

Implements HardwareInfoInterface.

Reimplemented in X2Dome.

virtual DeviceType DomeDriverInterface::deviceType ( void  )
inlinevirtual

Returns the type of device.

Implements DriverRootInterface.

Reimplemented in X2Dome.

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

Return detailed information about the driver.

Implements DriverInfoInterface.

Implemented in X2Dome.

virtual double DomeDriverInterface::driverInfoVersion ( void  ) const
pure virtual

Return a version number.

Implements DriverInfoInterface.

Implemented in X2Dome.

virtual int DomeDriverInterface::establishLink ( void  )
pure virtual

Connect (link) to the device.

Implements LinkInterface.

Implemented in X2Dome.

virtual bool DomeDriverInterface::isLinked ( void  ) const
pure virtual

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

Implements LinkInterface.

Implemented in X2Dome.

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

Return a pointer to well defined interface.

Implements DriverRootInterface.

Implemented in X2Dome.

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:
X2 Examples
(C) Software Bisque, Inc. All rights reserved.