SimTerminationEvent.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.
******************************************************************************/
/*
Sim Termination header file
 
Author: Alex Reynolds
*/
#ifndef SIM_TERM_EVENT_H
#define SIM_TERM_EVENT_H
 
#include "architecture/Tasks.h"
#include "data_management/DataIO.hpp"
#include "core/clockwerkerrors.h"
#include "simulation/SimulationSteps.h"
 
namespace modelspace {
 
    /// @brief  Class to trigger termination in scheduler
    /// 
    /// This event terminates the sscheduler, ending its 
    /// run and allowing the simulation to exit.
    class SimTerminationEvent : public clockwerk::Event {
    public:
        START_PARAMS
        END_PARAMS
 
        START_INPUTS
        END_INPUTS
 
        START_OUTPUTS
        END_OUTPUTS
 
        /// Overloaded onstructors for the model object -- requires monitor and (optional) name
        SimTerminationEvent(clockwerk::Task &pnt, const std::string &m_name="sim_term_event")
            : Event(pnt, END_STEP, m_name) {}
        SimTerminationEvent(clockwerk::Executive &e, const std::string &m_name="sim_term_event")
            : Event(e, END_STEP, m_name) {}
        SimTerminationEvent(clockwerk::Task &pnt, int schedule_slot, const std::string &m_name="sim_term_event")
            : Event(pnt, schedule_slot, m_name) {}
        SimTerminationEvent(clockwerk::Executive &e, int schedule_slot, const std::string &m_name="sim_term_event")
            : Event(e, schedule_slot, m_name) {}
        ~SimTerminationEvent() {};
    protected:
        /// @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();
    };
 
}
 
#endif