SimTimeManager.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX INC.
******************************************************************************/
/*
Time Manager class header file
 
Author: Alex Reynolds
*/
#ifndef SIMULATION_SIM_TIME_MANAGER_H
#define SIMULATION_SIM_TIME_MANAGER_H
 
#include "architecture/Time.h"
#include "architecture/DataIO.hpp"
 
namespace warptwin {

    const std::string DEFAULT_SIMULATION_TIME = "2023 September 26, 12:00:00 MDT";

    const double GPS_TO_J2000_ET_OFFSET = 630763200.0;
 
    enum nav_time_sources_e {
        NAV_SRC_SYSTEM,
        NAV_SRC_GPS,
        NAV_SRC_UTC,
        NAV_SRC_TDB
    };

    class SimTimeManager : public clockwerk::GraphTreeObject {
    public:
        SimTimeManager();
        virtual ~SimTimeManager() {};

        void stepTime(const clockwerk::Time& step);

        void updateStep(const clockwerk::Time& step);
        
        clockwerk::Time wallClockTimer(); 

        double str2tdb(const std::string &time_input);

        std::string tdbTime() {return std::to_string(tdb_time().asFloatingPoint());}
        std::string utcTime();
        std::string jdTime();
        std::string gpsTime();
        double decimalYear();


        int configureSystemTime(const clockwerk::Time& offset, uint32 resolution_nsec=1);

        void configureNavigationTime(const std::string& source="SYSTEM");

        void setTime(const std::string &time_input=DEFAULT_SIMULATION_TIME);

        clockwerk::DataIO<clockwerk::Time> step_start_time = clockwerk::DataIO<clockwerk::Time>(this, "step_start_time");
        clockwerk::DataIO<clockwerk::Time> step_end_time = clockwerk::DataIO<clockwerk::Time>(this, "step_end_time");
        clockwerk::DataIO<clockwerk::Time> base_time = clockwerk::DataIO<clockwerk::Time>(this, "base_time");
        clockwerk::DataIO<clockwerk::Time> tdb_time = clockwerk::DataIO<clockwerk::Time>(this, "tdb_time");
        clockwerk::DataIO<clockwerk::Time> gps_time = clockwerk::DataIO<clockwerk::Time>(this, "gps_time");
        clockwerk::DataIO<clockwerk::Time> utc_time = clockwerk::DataIO<clockwerk::Time>(this, "utc_time");
        clockwerk::DataIO<clockwerk::Time> system_time = clockwerk::DataIO<clockwerk::Time>(this, "system_time");
        clockwerk::DataIO<clockwerk::Time> navigation_time = clockwerk::DataIO<clockwerk::Time>(this, "navigation_time");

        bool wallClockIsStarted() {return _started;}

        void setTime(clockwerk::Time set_val) {system_time(set_val); _sys_time_set = true;}

        void unsetTime() {_sys_time_set = false;}
    protected:
        // Temporary variable to make time retrieval faster 
        clockwerk::Time _diff;
        struct timespec _tmp;

        clockwerk::Time* _start_step_ptr;
        clockwerk::Time* _end_step_ptr;
        clockwerk::Time* _base_time_ptr;
        clockwerk::Time* _tdb_time_ptr;
        clockwerk::Time* _gps_time_ptr;
        clockwerk::Time* _utc_time_ptr;
        clockwerk::Time* _system_time_ptr;
 
        // Time used for wall clock calculation
        bool _started = false;
        clockwerk::Time _start;
        clockwerk::Time _now;
 
        // Time variables dictating os time behavior 
        clockwerk::Time _system_time_offset = clockwerk::Time(0, 0);
        uint32 _system_time_resolution = 1;
        nav_time_sources_e _nav_time_source = nav_time_sources_e::NAV_SRC_SYSTEM;
        clockwerk::Time _nav_base_time;
        bool _sys_time_set = false;
 
        GraphTreeObject* _children[MAXIMUM_APP_CHILDREN];
    };
 
}
 
#endif