PreExposureTaskInterface Class Reference

The PreExposureTaskInterface gives cameras a way to inform TheSkyX when executing CameraDriverInterface::CCStartExposure will take longer than dExposureDuration. More...

#include <preexposuretaskinterface.h>

Public Member Functions
virtual int	CCGetBlockingPreExposureTaskCount (const enumCameraIndex &Camera, const enumWhichCCD &CCDOrig, int &nCount)=0
virtual int	CCGetBlockingPreExposureTaskInfo (const enumCameraIndex &Camera, const enumWhichCCD &CCDOrig, const int nIndex, BasicStringInterface &sName)=0
virtual int	CCExecuteBlockingPreExposureTask (const enumCameraIndex &Camera, const enumWhichCCD &CCDOrig, const int nIndex)=0
virtual int	CCGetPreExposureTaskCount (const enumCameraIndex &Camera, const enumWhichCCD &CCDOrig, int &nCount)=0
virtual int	CCGetPreExposureTaskInfo (const enumCameraIndex &Camera, const enumWhichCCD &CCDOrig, const int nIndex, double &dDuration, BasicStringInterface &sName)=0
virtual int	CCSetAdditionalArgInterface (const enumCameraIndex &Camera, const enumWhichCCD &CCDOrig, const int &nIndex)

Detailed Description

The PreExposureTaskInterface gives cameras a way to inform TheSkyX when executing CameraDriverInterface::CCStartExposure will take longer than dExposureDuration.

This interface is optional. By default, when an exposure is triggered, TheSkyX will display a countdown showing when the exposure duration set by the user has ellapsed. However, many cameras have additional functions (such as RBI, mirror lock, etc) that can cause the process of taking an image to take substantially longer than the exposure itself.

Implementing this interface provides camera driver producers a way to cause TheSkyX to display additional progress bars before the actual 'exposure' progress bar.

Note that TheSkyX will continue to rely on CCIsExposureComplete to determine when an exposure has actually finished, any times reported by this interface will be used for display purposes only. Implementing this interface does NOT change the actual sequence of events that take place during an exposure, but can provide useful feedback to the user.

There are two types of preexposure task that this interface deals with independantly: Type 1) Blocking tasks that must take place before CCStartExposure begins Type 2) Nonblocking tasks that occur after CCStartExposure begins, but while CCIsExposureComplete is "false"

Don't forget to respond accordingly in your queryAbstraction().

Member Function Documentation

CCExecuteBlockingPreExposureTask()

virtual int PreExposureTaskInterface::CCExecuteBlockingPreExposureTask ( const enumCameraIndex &  Camera, const enumWhichCCD &  CCDOrig, const int  nIndex  )

pure virtual

TheSkyX calls this function to query the name of the task (to be displayed above the progress bar), and the expected duration of the task.

CCGetBlockingPreExposureTaskCount()

virtual int PreExposureTaskInterface::CCGetBlockingPreExposureTaskCount ( const enumCameraIndex &  Camera, const enumWhichCCD &  CCDOrig, int &  nCount  )

pure virtual

TheSkyX calls this function to query the number of pre-exposure tasks that will be executed before the exposure duration countdown.

CCGetBlockingPreExposureTaskInfo()

virtual int PreExposureTaskInterface::CCGetBlockingPreExposureTaskInfo ( const enumCameraIndex &  Camera, const enumWhichCCD &  CCDOrig, const int  nIndex, BasicStringInterface &  sName  )

pure virtual

TheSkyX calls this function to query the name of the task (to be displayed above the progress bar), and the expected duration of the task.

CCGetPreExposureTaskCount()

virtual int PreExposureTaskInterface::CCGetPreExposureTaskCount ( const enumCameraIndex &  Camera, const enumWhichCCD &  CCDOrig, int &  nCount  )

pure virtual

TheSkyX calls this function to query the number of pre-exposure tasks that will be executed before the exposure duration countdown.

CCGetPreExposureTaskInfo()

virtual int PreExposureTaskInterface::CCGetPreExposureTaskInfo ( const enumCameraIndex &  Camera, const enumWhichCCD &  CCDOrig, const int  nIndex, double &  dDuration, BasicStringInterface &  sName  )

pure virtual

TheSkyX calls this function to query the name of the task (to be displayed above the progress bar), and the expected duration of the task.

---

The documentation for this class was generated from the following file:

• licensedinterfaces/preexposuretaskinterface.h