LogEvent.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 Event header file
 
Author: Alex Reynolds
*/
#ifndef LOG_EVENT_H
#define LOG_EVENT_H
 
#include "architecture/Tasks.h"
#include "data_management/GraphTreeObject.h"
#include "data_management/DataIO.hpp"
#include "core/clockwerkerrors.h"
#include "logging/SimLogger.h"
#include "simulation/SimulationSteps.h"
 
namespace modelspace {
 
    /// @brief   Class to execute logging
    /// 
    /// This event executes logging in the specified logger whenever
    /// triggered. The triggering events will be determined by the
    /// selected monitor.
    class LogEvent : public clockwerk::Event {
    public:
        START_PARAMS
        END_PARAMS
 
        START_INPUTS
        END_INPUTS
 
        START_OUTPUTS
        END_OUTPUTS
 
        LogEvent(clockwerk::SimLogger &log, clockwerk::Task &pnt, int schedule_slot=END_STEP, const std::string &m_name="log_event");
        LogEvent(clockwerk::SimLogger &log, clockwerk::Executive &e, int schedule_slot=END_STEP, const std::string &m_name="log_event");
        ~LogEvent() {};
    protected:
        /// @brief   Function to set up and start our logger
        int start();
 
        /// @brief   Function to check monitor input conditions and set trigger
        ///          flag accordingly. Should be implemented in derived class
        /// @return  Error code corresponding to success/failure
        /// @note    Will NOT run if trigger and persistence are true
        int execute();
 
        /// Handle to our logger object
        clockwerk::SimLogger &_logger;
    };
 
}
 
#endif