mirror of
https://github.com/JHUAPL/kami.git
synced 2026-01-09 14:58:02 -05:00
8742637ac8
documentation fixes Did this the long way. The documentation for Doxygen says I should be able to hide those defines with a single knob. However, I cannot make it work. So each one is now filtered out individually.
93 lines
3.0 KiB
C++
93 lines
3.0 KiB
C++
/*-
|
|
* 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_POPULATION_H
|
|
//! @cond SuppressGuard
|
|
#define KAMI_POPULATION_H
|
|
//! @endcond
|
|
|
|
#include <map>
|
|
#include <vector>
|
|
|
|
#include <kami/agent.h>
|
|
#include <kami/kami.h>
|
|
|
|
namespace kami {
|
|
|
|
/**
|
|
* @brief An abstract for generic models
|
|
*/
|
|
class LIBKAMI_EXPORT Population {
|
|
protected:
|
|
/**
|
|
* @brief A mapping of `AgentID` to `Agent` pointers
|
|
*
|
|
* @details This is the mapping of all `AgentID`s to
|
|
* pointers to the corresponding `Agent` in this population.
|
|
* This is left exposed as protected should any subclass
|
|
* wish to manipulate this mapping directly.
|
|
*/
|
|
std::map<kami::AgentID, std::shared_ptr<Agent>> _agent_map;
|
|
|
|
public:
|
|
/**
|
|
* @brief Get a reference to an `Agent` by `AgentID`
|
|
*
|
|
* @param[in] agent_id the `AgentID` to search for.
|
|
*
|
|
* @return a reference to the desired `Agent` or nothing is not found
|
|
*/
|
|
[[nodiscard]] std::optional<std::shared_ptr<Agent>> get_agent_by_id(AgentID agent_id) const;
|
|
|
|
/**
|
|
* @brief Add an Agent to the Population.
|
|
*
|
|
* @param agent The Agent to add.
|
|
*
|
|
* @returns the ID of the agent added
|
|
*/
|
|
AgentID add_agent(const std::shared_ptr<Agent>& agent);
|
|
|
|
/**
|
|
* @brief Remove an Agent from the Population.
|
|
*
|
|
* @param agent_id The AgentID of the agent to remove.
|
|
*
|
|
* @returns a shared pointer to the Agent deleted
|
|
*/
|
|
std::optional<std::shared_ptr<Agent>> delete_agent(AgentID agent_id);
|
|
|
|
/**
|
|
* @brief Returns the agent list.
|
|
*
|
|
* @returns a `std::vector` of all the `AgentID`'s in the `Population`
|
|
*/
|
|
[[nodiscard]] std::shared_ptr<std::vector<AgentID>> get_agent_list() const;
|
|
};
|
|
} // namespace kami
|
|
|
|
#endif // KAMI_POPULATION_H
|