LogManager.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.
******************************************************************************/
/*
Log Manager header file
 
Author: Alex Reynolds
*/
#ifndef LOG_MANAGER_H
#define LOG_MANAGER_H
 
#include <vector>
 
#include "core/macros.h"
#include "architecture/Tasks.h"
#include "monitors/RateMonitor.h"
#include "data_management/GraphTreeObject.h"
#include "logging/SimLogger.h"
#include "events/LogEvent.h"
#include "architecture/Executive.h"
#include "architecture/Time.h"
 
namespace modelspace {
 
    /// @brief  Class to manage logs
    /// 
    /// This is the header for the log manager, which is responsible
    /// for adding logs to the simulation and ensuring they are executed
    /// in accordance with their rate or triggers.
    class LogManager : public clockwerk::GraphTreeObject {
    public:
        /// @brief   Constructor for the log manager
        LogManager(clockwerk::Executive &executive) : exc(executive) {}
 
        /// @brief   Destructor for the log manager. Frees memory allocated
        ///          internally to logging events and monitors
        ~LogManager();
 
        /// @brief   Overloaded function to register and set up a logger
        /// @param   log     The logger to add to the sim
        /// @param   rate    The rate, as a Time object, at which the logger should log
        void addLog(clockwerk::SimLogger &log, const clockwerk::Time &rate);
 
        /// @brief   Overloaded function to register and set up a logger
        /// @param   log     The logger to add to the sim
        /// @param   rate    The rate, in Hz, at which the logger should log
        void addLog(clockwerk::SimLogger &log, unsigned int rate);
 
        /// @brief   Overloaded function to register and set up a logger
        /// @param   log     The logger to add to the sim
        /// @param   monitor The monitor which triggers the logger
        void addLog(clockwerk::SimLogger &log, clockwerk::Monitor &monitor);
 
        /// @brief Function to set output directory for all logs
        /// @param directory Directory to set as base
        /// @note Can be overwritten if individual log out dir is set
        void outDir(const std::string &directory) {_output_directory = directory;}
 
        clockwerk::Executive& exc;
    protected:
        /// Output directory
        std::string _output_directory = "";
 
        /// List of logging events
        std::vector<LogEvent*> _log_events;
 
        /// List of rate monitors established in the log manager
        std::vector<RateMonitor*> _monitors;
    };
 
}
 
#endif