Rates.hpp

/******************************************************************************
* 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.
******************************************************************************/
 
#ifndef RATES_HPP
#define RATES_HPP
 
#include <array>
 
#include "core/clockwerkerrors.h"
 
namespace clockwerk {
 
    template <typename T, unsigned int N>
    class Rates {
    public:
        /// @brief   Function to calculate rates from current state of system
        /// @param   time    The reference time
        /// @param   state   The reference state
        /// @param   out_rates   Implicit return of rates based on time, state
        virtual int calculateRates(T time, const std::array<T, N> &state,
                                    std::array<T, N> &out_rates) {return NO_ERROR;}
    private:
 
    };
 
}
 
#endif