TimeManager.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. 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, LLC.
******************************************************************************/
/*
Time Manager class header file
 
Author: Alex Reynolds
*/
#ifndef TIME_MANAGER_H
#define TIME_MANAGER_H
 
#include "data_management/GraphTreeObject.h"
#include "data_management/DataIO.hpp"
#include "architecture/EventLogger.h"
#include "core/clockwerkerrors.h"
#include "core/macros.h"
#include "architecture/Time.h"
 
namespace clockwerk {
 
    /// The time manager class is a class to manage various time variables. 
    /// It maintains 4 times -- base time, MET, 
    /// UTC time, and GPS time. Base time is automatically set to zero
    /// on start, and a combination of MET or GPS/UTC time can be set
    /// and maintained via time increments and updates.
    class TimeManager : public GraphTreeObject {
    public:
        /// Base constructor -- time manager should initialize to zeros and then be set
        TimeManager();
        ~TimeManager() {};
 
        /// @brief   Function to increment all times
        /// @param   step    Time object to step by
        void stepTime(const Time& step);
 
        /// @brief   Function to increment step start and end time
        /// @param   step    Time object to step by
        void updateStep(const Time& step);
 
        /// @brief   Function to return base time by call for easy access
        /// @note    Returns the base time because it is the most default time
        Time operator() (){return base_time();}
 
        /// ------------------------------------------------------------------
        /// Incrementing clocks -- these are standard clocks that begin on 
        /// start and continue incrementing as the scheduler steps forward
        /// in time. 
        /// ------------------------------------------------------------------
        /// This is the time at the start of a given scheduler step
        DataIO<Time> step_start_time = DataIO<Time>(this, "step_start_time");
        /// This is the time at the end of a given scheduler step
        DataIO<Time> step_end_time = DataIO<Time>(this, "step_end_time");
        /// This is the exact current time as the scheduler steps forward
        DataIO<Time> base_time = DataIO<Time>(this, "base_time");
 
        /// ------------------------------------------------------------------
        /// Other time functions -- These functions return other forms of time
        /// ------------------------------------------------------------------
        /// @brief Function to return the wall clock time since run start
        /// @return A time object containing the time since run start
        virtual Time wallClockTimer() {return Time();}
 
        /// @brief Function to return whether the wall clock timer is started
        /// @return Whether the wall clock timer is started
        bool wallClockIsStarted() {return _started;}
    protected:
        /// Pointers to our time objects
        Time* _start_step_ptr;
        Time* _end_step_ptr;
        Time* _base_time_ptr;
 
        // Time used for wall clock calculation
        bool _started = false;
        Time _start;
        Time _now;
    };
}
 
#endif