X2 Standard  Version 1.24
Public Member Functions | List of all members
X2Focuser Class Reference

The X2Focuser example. More...

#include <x2focuser.h>

Inheritance diagram for X2Focuser:
FocuserDriverInterface DriverRootInterface LinkInterface HardwareInfoInterface DriverInfoInterface FocuserGotoInterface2

Public Member Functions

 X2Focuser (const char *pszDisplayName, const int &nInstanceIndex, SerXInterface *pSerXIn, TheSkyXFacadeForDriversInterface *pTheSkyXIn, SleeperInterface *pSleeperIn, BasicIniUtilInterface *pIniUtilIn, LoggerInterface *pLoggerIn, MutexInterface *pIOMutexIn, TickCountInterface *pTickCountIn)
 
DriverRootInterface Implementation
virtual int queryAbstraction (const char *pszName, void **ppVal)
 
DriverInfoInterface Implementation
virtual void driverInfoDetailedInfo (BasicStringInterface &str) const
 
virtual double driverInfoVersion (void) const
 
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)
 
LinkInterface Implementation
virtual int establishLink (void)
 
virtual int terminateLink (void)
 
virtual bool isLinked (void) const
 
- Public Member Functions inherited from FocuserDriverInterface
virtual DeviceType deviceType (void)
 
- Public Member Functions inherited from FocuserGotoInterface2
virtual void embeddedFocuserInit (const char *psFilterWheelSelection)
 
virtual void embeddedFocuserInit (const char *psFilterWheelSelection)
 

FocuserGotoInterface2 Implementation

See FocuserGotoInterface2.

virtual int focPosition (int &nPosition)
 
virtual int focMinimumLimit (int &nMinLimit)
 
virtual int focMaximumLimit (int &nMaxLimit)
 
virtual int focAbort ()
 
virtual int startFocGoto (const int &nRelativeOffset)
 
virtual int isCompleteFocGoto (bool &bComplete) const
 
virtual int endFocGoto (void)
 
virtual int amountCountFocGoto (void) const
 
virtual int amountNameFromIndexFocGoto (const int &nZeroBasedIndex, BasicStringInterface &strDisplayName, int &nAmount)
 
virtual int amountIndexFocGoto (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 X2Focuser example.

Use this example to write an X2Focuser driver.

Member Function Documentation

◆ amountCountFocGoto()

int X2Focuser::amountCountFocGoto ( void  ) const
virtual

Return the number (count) of avaiable focuser gotos.

Implements FocuserDriverInterface.

◆ amountIndexFocGoto()

int X2Focuser::amountIndexFocGoto ( void  )
virtual

Return the current index of focuser goto selection.

Implements FocuserDriverInterface.

◆ amountNameFromIndexFocGoto()

int X2Focuser::amountNameFromIndexFocGoto ( const int &  nZeroBasedIndex,
BasicStringInterface strDisplayName,
int &  nAmount 
)
virtual

Return a string along with the amount or size of the corresponding focuser goto.

Implements FocuserDriverInterface.

◆ deviceInfoDetailedDescription()

void X2Focuser::deviceInfoDetailedDescription ( BasicStringInterface str) const
virtual

Return a detailed device description.

Reimplemented from FocuserDriverInterface.

◆ deviceInfoFirmwareVersion()

void X2Focuser::deviceInfoFirmwareVersion ( BasicStringInterface str)
virtual

Return the firmware version, if available.

Reimplemented from FocuserDriverInterface.

◆ deviceInfoModel()

void X2Focuser::deviceInfoModel ( BasicStringInterface str)
virtual

Return the device model name.

Reimplemented from FocuserDriverInterface.

◆ deviceInfoNameLong()

void X2Focuser::deviceInfoNameLong ( BasicStringInterface str) const
virtual

Return a detailed device name.

Reimplemented from FocuserDriverInterface.

◆ deviceInfoNameShort()

void X2Focuser::deviceInfoNameShort ( BasicStringInterface str) const
virtual

Return a short device name.

Reimplemented from FocuserDriverInterface.

◆ driverInfoDetailedInfo()

void X2Focuser::driverInfoDetailedInfo ( BasicStringInterface str) const
virtual

Return detailed information about the driver.

Reimplemented from FocuserDriverInterface.

◆ driverInfoVersion()

double X2Focuser::driverInfoVersion ( void  ) const
virtual

Return a version number.

Reimplemented from FocuserDriverInterface.

◆ endFocGoto()

int X2Focuser::endFocGoto ( void  )
virtual

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

Implements FocuserDriverInterface.

◆ establishLink()

int X2Focuser::establishLink ( void  )
virtual

Connect (link) to the device.

Implements FocuserDriverInterface.

◆ focAbort()

int X2Focuser::focAbort ( )
virtual

Abort an operation in progress.

Implements FocuserDriverInterface.

◆ focMaximumLimit()

int X2Focuser::focMaximumLimit ( int &  nMaxLimit)
virtual

Return the focusers maximum limit.

Implements FocuserDriverInterface.

◆ focMinimumLimit()

int X2Focuser::focMinimumLimit ( int &  nMinLimit)
virtual

Return the focusers minimum limit.

Implements FocuserDriverInterface.

◆ focPosition()

int X2Focuser::focPosition ( int &  nPosition)
virtual

Return the position of the focuser. If the hardware doesn't have a digital read out, return a number that roughly corresponds to whatever units the focuser moves in (time, lenght, etc.)

Implements FocuserDriverInterface.

◆ isCompleteFocGoto()

int X2Focuser::isCompleteFocGoto ( bool &  bComplete) const
virtual

Return if the goto is complete.

Implements FocuserDriverInterface.

◆ isLinked()

bool X2Focuser::isLinked ( void  ) const
virtual

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

Implements FocuserDriverInterface.

◆ queryAbstraction()

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

Return a pointer to well defined interface.

Implements FocuserDriverInterface.

◆ startFocGoto()

int X2Focuser::startFocGoto ( const int &  nRelativeOffset)
virtual

Initiate the focus goto operation.

Implements FocuserDriverInterface.

◆ terminateLink()

int X2Focuser::terminateLink ( void  )
virtual

Disconnect from the device.

Implements FocuserDriverInterface.


The documentation for this class was generated from the following files:
X2 Examples
(C) Software Bisque, Inc. All rights reserved.