AtHeartEngineer/kami
1
0
Fork 0
mirror of https://github.com/JHUAPL/kami.git synced 2026-01-09 14:58:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

New step documentation

Browse Source
This commit is contained in:
James P. Howard, II
2022-09-01 11:39:29 -04:00
parent 893c8da8e2
commit a08b316b96
3 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/kami/agent.h
View File

@@ -146,6 +146,8 @@ namespace kami {
* agent should perform as part of its time step should be in this function.
*
* @param model a reference copy of the model
*
* @returns a copy of the AgentID
*/
virtual AgentID step(std::shared_ptr<Model> model) = 0;

5
include/kami/model.h
View File

@@ -97,7 +97,12 @@ namespace kami {
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();

19
include/kami/reporter.h
View File

@@ -65,9 +65,20 @@ namespace kami {
*/
virtual std::optional<std::unique_ptr<nlohmann::json>> collect() = 0;
/**
* @brief Execute a time-step for the agent
*
* @details This function should step the agent instance. Any activities that the
* agent should perform as part of its time step should be in this function.
*
* @param model a reference copy of the model
*
* @returns a copy of the AgentID
*/
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 {
return get_agent_id();
};
@@ -107,9 +118,15 @@ namespace kami {
};
/**
* @brief Execute a single time step of the model
*
* @details This method will collect all the `Agent`s in the `Population` associated
* with the model and pass them to the associated `Scheduler` for stepping. After scheduling,
* this method will run the collect() for the `Reporter` associated with this model.
*
* @returns a shared pointer to the model instance
*/
std::shared_ptr<Model> step() override;
virtual std::shared_ptr<Model> step() override;
std::unique_ptr<nlohmann::json> report();