Program Listing for File population.h

↰ Return to documentation for file (include/kami/population.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_POPULATION_H
#define KAMI_POPULATION_H

#include <map>
#include <vector>

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

namespace kami {

    class LIBKAMI_EXPORT Population {
    public:
        [[nodiscard]] std::shared_ptr<Agent> get_agent_by_id(AgentID agent_id) const;

        AgentID add_agent(const std::shared_ptr<Agent>& agent) noexcept;

        std::shared_ptr<Agent> delete_agent(AgentID agent_id);

        [[nodiscard]] std::unique_ptr<std::vector<AgentID>> get_agent_list() const;

    protected:
        std::map<kami::AgentID, std::shared_ptr<Agent>> _agent_map;
    };
}  // namespace kami

#endif  // KAMI_POPULATION_H