Program Listing for File reporter.h

↰ Return to documentation for file (include/kami/reporter.h)

/*-
 * Copyright (c) 2022 The Johns Hopkins University Applied Physics
 * Laboratory LLC
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#pragma once
#ifndef KAMI_REPORTER_H
#define KAMI_REPORTER_H

#include <memory>
#include <vector>

#include <nlohmann/json.hpp>

#include <kami/agent.h>
#include <kami/model.h>

namespace kami {

    class Reporter;

    class ReporterAgent;

    class ReporterModel;

    class LIBKAMI_EXPORT ReporterAgent
            : public Agent {
    public:
        virtual std::unique_ptr<nlohmann::json> collect() = 0;

        virtual AgentID step(std::shared_ptr<ReporterModel> model) = 0;

    private:
        // This should be uncallable, but knocks out the inherited method.
        AgentID step(std::shared_ptr<Model> model) override;;

        int _step_counter = 0;
    };

    class LIBKAMI_EXPORT ReporterModel
            : public Model {
    public:
        ReporterModel();

        virtual std::unique_ptr<nlohmann::json> collect() = 0;

        virtual unsigned int get_step_id();

        virtual std::shared_ptr<Model> step() override;

        std::unique_ptr<nlohmann::json> report();

    protected:

        std::shared_ptr<Reporter> _rpt;

        unsigned int _step_count{};
    };

    class LIBKAMI_EXPORT Reporter
            : public std::enable_shared_from_this<Reporter> {
    public:
        Reporter();

        std::shared_ptr<Reporter> clear();

        std::unique_ptr<nlohmann::json> collect(const std::shared_ptr<ReporterModel>& model);

        std::unique_ptr<nlohmann::json>
        collect(
                const std::shared_ptr<ReporterModel>& model,
                const std::shared_ptr<Population>& pop
        );

        std::unique_ptr<nlohmann::json>
        collect(
                const std::shared_ptr<ReporterModel>& model,
                const std::unique_ptr<std::vector<AgentID>>& agent_list
        );

        std::unique_ptr<nlohmann::json> report(const std::shared_ptr<ReporterModel>& model);

    protected:
        std::unique_ptr<std::vector<nlohmann::json>> _report_data = nullptr;
    };

}

#endif //KAMI_REPORTER_H