Program Listing for File DataPlotter.h

↰ Return to documentation for file (include/Karana/GeneralKModels/DataPlotter.h)

/*
 * Copyright (c) 2024-2026 Karana Dynamics Pty Ltd. All rights reserved.
 *
 * NOTICE TO USER:
 *
 * This source code and/or documentation (the "Licensed Materials") is
 * the confidential and proprietary information of Karana Dynamics Inc.
 * Use of these Licensed Materials is governed by the terms and conditions
 * of a separate software license agreement between Karana Dynamics and the
 * Licensee ("License Agreement"). Unless expressly permitted under that
 * agreement, any reproduction, modification, distribution, or disclosure
 * of the Licensed Materials, in whole or in part, to any third party
 * without the prior written consent of Karana Dynamics is strictly prohibited.
 *
 * THE LICENSED MATERIALS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
 * KARANA DYNAMICS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT, AND
 * FITNESS FOR A PARTICULAR PURPOSE.
 *
 * IN NO EVENT SHALL KARANA DYNAMICS BE LIABLE FOR ANY DAMAGES WHATSOEVER,
 * INCLUDING BUT NOT LIMITED TO LOSS OF PROFITS, DATA, OR USE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, WHETHER IN CONTRACT, TORT,
 * OR OTHERWISE ARISING OUT OF OR IN CONNECTION WITH THE LICENSED MATERIALS.
 *
 * U.S. Government End Users: The Licensed Materials are a "commercial item"
 * as defined at 48 C.F.R. 2.101, and are provided to the U.S. Government
 * only as a commercial end item under the terms of this license.
 *
 * Any use of the Licensed Materials in individual or commercial software must
 * include, in the user documentation and internal source code comments,
 * this Notice, Disclaimer, and U.S. Government Use Provision.
 */

/**
 * @file
 * @brief Contains the declarations for the DataPlotter KModel.
 */

#pragma once
#include "Karana/KUtils/DataPlotter.h"
#include "Karana/SOADyn/KModel.h"

namespace Karana::Models {

    namespace km = Karana::Math;
    namespace kd = Karana::Dynamics;
    namespace ku = Karana::KUtils;

    /**
     * @class DataPlotterParams
     * @brief Parameters for the DataPlotter model.
     */
    class DataPlotterParams : public KModelParams {
      public:
        /**
         * @brief Constructor
         * @param name - Name of the params.
         */
        DataPlotterParams(std::string_view name);

        /**
         * @brief Used to ensure the params are ready.
         *
         * @return `true` if the params are ready, `false` otherwise.
         */
        bool isReady() const final;

        /// If true, then log the first step.
        bool log_first_step = true;
    };

    /**
     * @class DataPlotter
     * @brief The DataPlotter model updates the visualization at each postHop.
     */
    class DataPlotter : public KModel<DataPlotter, DataPlotterParams> {
      public:
        /**
         * @brief DataPlotter constructor. The constructor is not meant to be called directly.
         *        Please use the create(...) method instead to create an instance.
         *
         * @param name The name of the DataPlotter model.
         * @param mm The ModelManager to register this model with.
         * @param plot_data The PlotData to use for updating plots.
         */
        DataPlotter(std::string_view name,
                    const kc::ks_ptr<kd::ModelManager> &mm,
                    const kc::ks_ptr<ku::PlotData> &plot_data);

        /**
         * @brief Constructor.
         *
         * @param name The name of the DataPlotter model.
         * @param mm The ModelManager to register this model with.
         * @param plot_data The PlotData to use for updating plots.
         * @return A ks_ptr to the newly created instance of the DataPlotter model.
         */
        static kc::ks_ptr<DataPlotter> create(std::string_view name,
                                              const kc::ks_ptr<kd::ModelManager> &mm,
                                              const kc::ks_ptr<ku::PlotData> &plot_data);

        /**
         * @brief Perform data logging.
         *
         * @param t Current time. Not used.
         * @param x Current state. Not used.
         */
        void postModelStep(const km::Ktime &t, const km::Vec &x);

        /**
         * @brief Get the H5Writer used by the model.
         *
         * This can be used to enable/disable various tables of the H5Writer.
         *
         * @return The H5Write that this model uses for logging.
         */
        kc::ks_ptr<ku::PlotData> getPlotData();

        /**
         * @brief Destructor for DataPlotter.
         */
        ~DataPlotter();

      protected:
        /**
         * @brief Register the model.
         */
        void _registerModel() override;

        /**
         * @brief Unregister the model.
         */
        void _unregisterModel() override;

      private:
        /// The node that we use to calculate and apply the forces.
        kc::ks_ptr<ku::PlotData> _plot_data;
    };
} // namespace Karana::Models