File indexing completed on 2024-04-21 03:43:38

 /*
     SPDX-FileCopyrightText: 2023 Wolfgang Reissenberger <sterne-jaeger@openfuture.de>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #pragma once
 
 #include "QString"
 
 namespace Ekos
 {
 typedef enum
 {
     STARTUP_IDLE,
     STARTUP_SCRIPT,
     STARTUP_UNPARK_DOME,
     STARTUP_UNPARKING_DOME,
     STARTUP_UNPARK_MOUNT,
     STARTUP_UNPARKING_MOUNT,
     STARTUP_UNPARK_CAP,
     STARTUP_UNPARKING_CAP,
     STARTUP_ERROR,
     STARTUP_COMPLETE
 } StartupState;
 typedef enum
 {
     SHUTDOWN_IDLE,
     SHUTDOWN_PARK_CAP,
     SHUTDOWN_PARKING_CAP,
     SHUTDOWN_PARK_MOUNT,
     SHUTDOWN_PARKING_MOUNT,
     SHUTDOWN_PARK_DOME,
     SHUTDOWN_PARKING_DOME,
     SHUTDOWN_SCRIPT,
     SHUTDOWN_SCRIPT_RUNNING,
     SHUTDOWN_ERROR,
     SHUTDOWN_COMPLETE
 } ShutdownState;
 typedef enum
 {
     PARKWAIT_IDLE,
     PARKWAIT_PARK,
     PARKWAIT_PARKING,
     PARKWAIT_PARKED,
     PARKWAIT_UNPARK,
     PARKWAIT_UNPARKING,
     PARKWAIT_UNPARKED,
     PARKWAIT_ERROR
 } ParkWaitState;
 // overall states of EKOS
 typedef enum { EKOS_IDLE, EKOS_STARTING, EKOS_STOPPING, EKOS_READY } EkosState;
 // overall states of INDI
 typedef enum { INDI_IDLE, INDI_CONNECTING, INDI_DISCONNECTING, INDI_PROPERTY_CHECK, INDI_READY } INDIState;
 
 /** @brief options what should happen if an error or abort occurs */
 typedef enum
 {
     ERROR_DONT_RESTART,
     ERROR_RESTART_AFTER_TERMINATION,
     ERROR_RESTART_IMMEDIATELY
 } ErrorHandlingStrategy;
 
 /** @brief Algorithms, in the same order as UI. */
 typedef enum
 {
     ALGORITHM_GREEDY = 1
 } SchedulerAlgorithm;
 
 
 /** @brief Conditions under which a SchedulerJob may start. */
 typedef enum
 {
     START_ASAP = 0,
     START_AT   = 2
 } StartupCondition;
 
 /** @brief Conditions under which a SchedulerJob may complete. */
 typedef enum
 {
     FINISH_SEQUENCE,
     FINISH_REPEAT,
     FINISH_LOOP,
     FINISH_AT
 } CompletionCondition;
 
 /** @brief IterationTypes, the different types of scheduler iterations that are run. */
 typedef enum
 {
     RUN_WAKEUP = 0,
     RUN_SCHEDULER,
     RUN_JOBCHECK,
     RUN_SHUTDOWN,
     RUN_NOTHING
 } SchedulerTimerState;
 
 /** @brief States of a SchedulerJob. */
 typedef enum
 {
     SCHEDJOB_IDLE,       /**< Job was just created, and is not evaluated yet */
     SCHEDJOB_EVALUATION, /**< Job is being evaluated */
     SCHEDJOB_SCHEDULED,  /**< Job was evaluated, and has a schedule */
     SCHEDJOB_BUSY,       /**< Job is being processed */
     SCHEDJOB_ERROR,      /**< Job encountered a fatal issue while processing, and must be reset manually */
     SCHEDJOB_ABORTED,    /**< Job encountered a transitory issue while processing, and will be rescheduled */
     SCHEDJOB_INVALID,    /**< Job has an incorrect configuration, and cannot proceed */
     SCHEDJOB_COMPLETE    /**< Job finished all required captures */
 } SchedulerJobStatus;
 
 /** @brief Running stages of a SchedulerJob. */
 typedef enum
 {
     SCHEDSTAGE_IDLE,
     SCHEDSTAGE_SLEWING,
     SCHEDSTAGE_SLEW_COMPLETE,
     SCHEDSTAGE_FOCUSING,
     SCHEDSTAGE_FOCUS_COMPLETE,
     SCHEDSTAGE_ALIGNING,
     SCHEDSTAGE_ALIGN_COMPLETE,
     SCHEDSTAGE_RESLEWING,
     SCHEDSTAGE_RESLEWING_COMPLETE,
     SCHEDSTAGE_POSTALIGN_FOCUSING,
     SCHEDSTAGE_POSTALIGN_FOCUSING_COMPLETE,
     SCHEDSTAGE_GUIDING,
     SCHEDSTAGE_GUIDING_COMPLETE,
     SCHEDSTAGE_CAPTURING,
     SCHEDSTAGE_COMPLETE
 } SchedulerJobStage;
 
 /** @brief mapping signature --> frames count */
 typedef QMap<QString, uint16_t> CapturedFramesMap;
 
 // Functions to make human-readable debug messages for the various enums.
 
 QString ekosStateString(EkosState state);
 QString indiStateString(INDIState state);
 QString startupStateString(StartupState state);
 QString shutdownStateString(ShutdownState state);
 QString parkWaitStateString(ParkWaitState state);
 QString timerStr(SchedulerTimerState state);
 QString startupConditionString(StartupCondition condition);
 QString completionConditionString(CompletionCondition condition);
 
 } // Ekos namespace