Program Listing for File agent.h

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

/*-
 * 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_AGENT_H
#define KAMI_AGENT_H

#include <iostream>
#include <memory>
#include <string>

#include <kami/model.h>

namespace kami {

    class LIBKAMI_EXPORT AgentID {
    private:
        inline static long long _id_next = 1;

        long long _id;

    public:
        AgentID();

        [[nodiscard]] std::string to_string() const;

        friend bool operator==(
                const AgentID& lhs,
                const AgentID& rhs
        );

        friend bool operator!=(
                const AgentID& lhs,
                const AgentID& rhs
        );

        friend bool operator<(
                const AgentID& lhs,
                const AgentID& rhs
        );

        friend std::ostream& operator<<(
                std::ostream& lhs,
                const AgentID& rhs
        );
    };

    class LIBKAMI_EXPORT Agent {
    private:
        const AgentID _agent_id;

    public:
        [[nodiscard]] AgentID get_agent_id() const;

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

        friend bool operator==(
                const Agent& lhs,
                const Agent& rhs
        );

        friend bool operator!=(
                const Agent& lhs,
                const Agent& rhs
        );
    };

    class LIBKAMI_EXPORT StagedAgent
            : public Agent {
    public:
        virtual AgentID advance(std::shared_ptr<Model> model) = 0;
    };

}  // namespace kami

#endif  // KAMI_AGENT_H