mirror of
https://github.com/JHUAPL/kami.git
synced 2026-01-07 22:13:51 -05:00
132 lines
3.9 KiB
C++
132 lines
3.9 KiB
C++
/*-
|
|
* Copyright (c) 2020 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_MODEL_H
|
|
//! @cond SuppressGuard
|
|
#define KAMI_MODEL_H
|
|
//! @endcond
|
|
|
|
#include <memory>
|
|
|
|
#include <kami/domain.h>
|
|
#include <kami/kami.h>
|
|
#include <kami/population.h>
|
|
#include <kami/scheduler.h>
|
|
|
|
namespace kami {
|
|
|
|
/**
|
|
* @brief An abstract for generic models
|
|
*
|
|
* @see `ReporterModel`
|
|
*/
|
|
class LIBKAMI_EXPORT Model
|
|
: public std::enable_shared_from_this<Model> {
|
|
|
|
public:
|
|
/**
|
|
* @brief Get the `Domain` associated with this model
|
|
*
|
|
* @returns a shared pointer to the `Domain`
|
|
*/
|
|
std::shared_ptr<Domain> get_domain();
|
|
|
|
/**
|
|
* @brief Add a `Domain` to this scheduler
|
|
*
|
|
* @details This method will associate a model with the
|
|
* scheduler.
|
|
*
|
|
* @returns a shared pointer to the `Domain`
|
|
*/
|
|
std::shared_ptr<Domain> set_domain(std::shared_ptr<Domain> domain);
|
|
|
|
/**
|
|
* @brief Get the `Population` associated with this model
|
|
*
|
|
* @returns a shared pointer to the `Population`
|
|
*/
|
|
std::shared_ptr<Population> get_population();
|
|
|
|
/**
|
|
* @brief Add a `Model` to this scheduler
|
|
*
|
|
* @details This method will associate a model with the
|
|
* scheduler.
|
|
*
|
|
* @returns a shared pointer to the `Population`
|
|
*/
|
|
std::shared_ptr<Population> set_population(std::shared_ptr<Population> population);
|
|
|
|
/**
|
|
* @brief Get the `Scheduler` associated with this model
|
|
*
|
|
* @returns a shared pointer to the `Scheduler`
|
|
*/
|
|
std::shared_ptr<Scheduler> get_scheduler();
|
|
|
|
/**
|
|
* @brief Add a `Model` to this scheduler
|
|
*
|
|
* @details This method will associate a model with the
|
|
* scheduler.
|
|
*
|
|
* @returns a shared pointer to the `Scheduler`
|
|
*/
|
|
std::shared_ptr<Scheduler> set_scheduler(std::shared_ptr<Scheduler> scheduler);
|
|
|
|
/**
|
|
* @brief Execute a single time step of the model
|
|
*
|
|
* @details This method will collect all the `Agent`s in the `Population` associated
|
|
* with model and pass them to the associated `Scheduler` for stepping.
|
|
*
|
|
* @returns a shared pointer to the model instance
|
|
*/
|
|
virtual std::shared_ptr<Model> step();
|
|
|
|
protected:
|
|
/**
|
|
* @brief Reference copy of the `Domain`
|
|
*/
|
|
std::shared_ptr<Domain> _domain = nullptr;
|
|
|
|
/**
|
|
* @brief Reference copy of the `Population`
|
|
*/
|
|
std::shared_ptr<Population> _pop = nullptr;
|
|
|
|
/**
|
|
* @brief Reference copy of the `Scheduler`
|
|
*/
|
|
std::shared_ptr<Scheduler> _sched = nullptr;
|
|
|
|
};
|
|
|
|
} // namespace kami
|
|
|
|
#endif // KAMI_MODEL_H
|