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

The UnparkInterface allows domes and mounts to be unparked. More...

#include <unparkinterface.h>

Public Member Functions

virtual int startUnpark (void)=0
 
virtual int isCompleteUnpark (bool &bComplete) const =0
 
virtual int endUnpark (void)=0
 

Detailed Description

The UnparkInterface allows domes and mounts to be unparked.

At this time TheSkyX only queries domes and mounts for implementation of this interface. In the future, other devices may be queried for implementation of this interface if and when unparking ever exists on these devices. This interface is optional.

See also
ParkInterface

Member Function Documentation

◆ endUnpark()

virtual int UnparkInterface::endUnpark ( void  )
pure virtual

Called once the unpark is complete. This is called once for every corresponding startUnpark() allowing software implementations of unpark.

◆ isCompleteUnpark()

virtual int UnparkInterface::isCompleteUnpark ( bool &  bComplete) const
pure virtual

Called to monitor the unpark process.

Parameters
bCompleteSet to true if the unpark is complete, otherwise set to false.

◆ startUnpark()

virtual int UnparkInterface::startUnpark ( void  )
pure virtual

Initiate the park process.


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