X2 Standard  Version 1.24
Public Member Functions | List of all members
OpenLoopMoveInterface Class Referenceabstract

The OpenLoopMoveInterface allows a mount to move at a given rate for a open-ended amount of time. More...

#include <openloopmoveinterface.h>

Public Member Functions

virtual int startOpenLoopMove (const MountDriverInterface::MoveDir &Dir, const int &nRateIndex)=0
 
virtual int endOpenLoopMove (void)=0
 
virtual bool allowDiagonalMoves ()
 
virtual int rateCountOpenLoopMove (void) const =0
 
virtual int rateNameFromIndexOpenLoopMove (const int &nZeroBasedIndex, char *pszOut, const int &nOutMaxSize)=0
 
virtual int rateIndexOpenLoopMove (void)=0
 

Detailed Description

The OpenLoopMoveInterface allows a mount to move at a given rate for a open-ended amount of time.

This interface is typically used by TheSkyX to allow a user-interface button to move the mount, where the mount moves while the button is down, and the mount stops moving when the button is released.

Member Function Documentation

◆ allowDiagonalMoves()

virtual bool OpenLoopMoveInterface::allowDiagonalMoves ( )
inlinevirtual

Return true if the mount can be commanded to move in more than one perpendicular axis at the same time, otherwise return false.

◆ endOpenLoopMove()

virtual int OpenLoopMoveInterface::endOpenLoopMove ( void  )
pure virtual

End the open-loop move. This function is always called for every corresponding startOpenLoopMove(), allowing software implementations of the move.

◆ rateCountOpenLoopMove()

virtual int OpenLoopMoveInterface::rateCountOpenLoopMove ( void  ) const
pure virtual

Return the number (count) of avaiable moves.

◆ rateIndexOpenLoopMove()

virtual int OpenLoopMoveInterface::rateIndexOpenLoopMove ( void  )
pure virtual

Return the current index of move selection.

◆ rateNameFromIndexOpenLoopMove()

virtual int OpenLoopMoveInterface::rateNameFromIndexOpenLoopMove ( const int &  nZeroBasedIndex,
char *  pszOut,
const int &  nOutMaxSize 
)
pure virtual

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

◆ startOpenLoopMove()

virtual int OpenLoopMoveInterface::startOpenLoopMove ( const MountDriverInterface::MoveDir Dir,
const int &  nRateIndex 
)
pure virtual

Start the open-loop move.


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