RateMonitor.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.
******************************************************************************/
/*
Rate Monitor header file
 
Author: Alex Reynolds
*/
#ifndef MONITORS_RATE_MONITOR_H
#define MONITORS_RATE_MONITOR_H
 
#include "architecture/Executive.h"
#include "architecture/Tasks.h"
#include "architecture/Time.h"
#include "data_management/GraphTreeObject.h"
#include "data_management/DataIO.hpp"
#include "core/clockwerkerrors.h"
#include "simulation/SimulationSteps.h"
 
namespace modelspace {
 
    /// @brief  Monitor to trigger at a particular rate
 
    /// The rate monitor is a simple implementation of the monitor
    /// that triggers at a set rate. The rate is set upon construction,
    /// but may be changed during run via function.
 
    /// If the simulation run rate is less than the monitor rate, 
    /// the monitor will simply trigger every step
    class RateMonitor : public clockwerk::Monitor {
    public:
        /// Overloaded onstructors for the model object -- requires executive and (optional) name
        RateMonitor(clockwerk::Task &pnt, const std::string &m_name="rate_monitor")
            : clockwerk::Monitor(pnt, ALL, m_name) {}
        RateMonitor(clockwerk::Executive &e, const std::string &m_name="rate_monitor")
            : clockwerk::Monitor(e, ALL, m_name) {}
        RateMonitor(clockwerk::Task &pnt, int schedule_slot, const std::string &m_name="rate_monitor")
            : clockwerk::Monitor(pnt, schedule_slot, m_name) {}
        RateMonitor(clockwerk::Executive &e, int schedule_slot, const std::string &m_name="rate_monitor")
            : clockwerk::Monitor(e, schedule_slot, m_name) {}
        ~RateMonitor() {};
 
        /// @brief   Function to check our current (base) time against
        ///          our rate conditions
        /// @return  Error code corresponding to success/failure
        /// @note    Will NOT run if trigger and persistence are true
        int execute();
 
        START_PARAMS
            /// This is the rate at which the monitor will trigger
            SIGNAL(rate, clockwerk::Time, clockwerk::Time(1,0))
        END_PARAMS
 
        START_INPUTS
            /// This is the current time in the simulation
            SIGNAL(current_time, clockwerk::Time, clockwerk::Time(0,0))
        END_INPUTS
 
        START_OUTPUTS
            /// This is the next time at which the monitor will trigger
            SIGNAL(next_trigger_time, clockwerk::Time, clockwerk::Time(0,0))
        END_OUTPUTS
    protected:
 
    };
 
}
 
#endif