The FocuserGotoInterface2 allows a focuser to perform a goto operation. More...
#include <focusergotointerface2.h>
Public Member Functions | |
| virtual int | focPosition (int &nPosition)=0 |
| virtual int | focMinimumLimit (int &nMinLimit)=0 |
| virtual int | focMaximumLimit (int &nMaxLimit)=0 |
| virtual int | focAbort ()=0 |
| virtual int | startFocGoto (const int &nRelativeOffset)=0 |
| virtual int | isCompleteFocGoto (bool &bComplete) const =0 |
| virtual int | endFocGoto (void)=0 |
| virtual int | amountCountFocGoto (void) const =0 |
| virtual int | amountNameFromIndexFocGoto (const int &nZeroBasedIndex, BasicStringInterface &strDisplayName, int &nAmount)=0 |
| virtual int | amountIndexFocGoto (void)=0 |
| virtual void | embeddedFocuserInit (const char *psFilterWheelSelection) |
| virtual int | focPosition (int &nPosition)=0 |
| virtual int | focMinimumLimit (int &nMinLimit)=0 |
| virtual int | focMaximumLimit (int &nMaxLimit)=0 |
| virtual int | focAbort ()=0 |
| virtual int | startFocGoto (const int &nRelativeOffset)=0 |
| virtual int | isCompleteFocGoto (bool &bComplete) const =0 |
| virtual int | endFocGoto (void)=0 |
| virtual int | amountCountFocGoto (void) const =0 |
| virtual int | amountNameFromIndexFocGoto (const int &nZeroBasedIndex, BasicStringInterface &strDisplayName, int &nAmount)=0 |
| virtual int | amountIndexFocGoto (void)=0 |
| virtual void | embeddedFocuserInit (const char *psFilterWheelSelection) |
Detailed Description
The FocuserGotoInterface2 allows a focuser to perform a goto operation.
The nature of a focuser is that it moves relative from where it is, in(-) and out(+). This justifies why startFocGoto() is relative rather than absolute. An absolute goto can be accomplished by the more primitive, indigenous startFocGoto.
The gotos can be asynchronous, but some focuser hardware precludes that. In such, cases startFocGoto should be synchronous and isCompleteFocGoto would always return true so drivers can essentially "fake" the the asynchronousness.
Member Function Documentation
◆ amountCountFocGoto() [1/2]
|
pure virtual |
Return the number (count) of avaiable focuser gotos.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ amountCountFocGoto() [2/2]
|
pure virtual |
Return the number (count) of avaiable focuser gotos.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ amountIndexFocGoto() [1/2]
|
pure virtual |
Return the current index of focuser goto selection.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ amountIndexFocGoto() [2/2]
|
pure virtual |
Return the current index of focuser goto selection.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ amountNameFromIndexFocGoto() [1/2]
|
pure virtual |
Return a string along with the amount or size of the corresponding focuser goto.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ amountNameFromIndexFocGoto() [2/2]
|
pure virtual |
Return a string along with the amount or size of the corresponding focuser goto.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ embeddedFocuserInit() [1/2]
|
inlinevirtual |
Coming soon to TheSkyX, a mount having an embedded focuser, via x2.
◆ embeddedFocuserInit() [2/2]
|
inlinevirtual |
Coming soon to TheSkyX, a mount having an embedded focuser, via x2.
◆ endFocGoto() [1/2]
|
pure virtual |
Called after the goto is complete. This is called once for every corresponding startFocGoto() allowing software implementations of focuser gotos.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ endFocGoto() [2/2]
|
pure virtual |
Called after the goto is complete. This is called once for every corresponding startFocGoto() allowing software implementations of focuser gotos.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focAbort() [1/2]
|
pure virtual |
Abort an operation in progress.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focAbort() [2/2]
|
pure virtual |
Abort an operation in progress.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focMaximumLimit() [1/2]
|
pure virtual |
Return the focusers maximum limit.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focMaximumLimit() [2/2]
|
pure virtual |
Return the focusers maximum limit.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focMinimumLimit() [1/2]
|
pure virtual |
Return the focusers minimum limit.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focMinimumLimit() [2/2]
|
pure virtual |
Return the focusers minimum limit.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focPosition() [1/2]
|
pure 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.)
Implemented in FocuserDriverInterface, and X2Focuser.
◆ focPosition() [2/2]
|
pure 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.)
Implemented in FocuserDriverInterface, and X2Focuser.
◆ isCompleteFocGoto() [1/2]
|
pure virtual |
Return if the goto is complete.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ isCompleteFocGoto() [2/2]
|
pure virtual |
Return if the goto is complete.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ startFocGoto() [1/2]
|
pure virtual |
Initiate the focus goto operation.
Implemented in FocuserDriverInterface, and X2Focuser.
◆ startFocGoto() [2/2]
|
pure virtual |
Initiate the focus goto operation.
Implemented in FocuserDriverInterface, and X2Focuser.
The documentation for this class was generated from the following file:
- licensedinterfaces/focuser/focusergotointerface2.h