new_agent_event.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// Copyright (C) 2021 CERN & University of Surrey for the benefit of the
// BioDynaMo collaboration. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
//
// See the LICENSE file distributed with this work for details.
// See the NOTICE file distributed with this work for additional information
// regarding copyright ownership.
//
// -----------------------------------------------------------------------------
 
#ifndef CORE_AGENT_NEW_AGENT_EVENT_H_
#define CORE_AGENT_NEW_AGENT_EVENT_H_
 
#include <limits>
#include <mutex>
#include "core/container/inline_vector.h"
#include "core/util/log.h"
 
namespace bdm {
 
using NewAgentEventUid = uint64_t;
 
class Agent;
class Behavior;
 
class NewAgentEventUidGenerator {
 public:
  NewAgentEventUidGenerator(const NewAgentEventUidGenerator&) = delete;
  NewAgentEventUidGenerator& operator=(const NewAgentEventUidGenerator&) =
      delete;
 
  static NewAgentEventUidGenerator* GetInstance();
 
  NewAgentEventUid GenerateUid() {
    std::lock_guard<std::recursive_mutex> lock(mutex_);
    constexpr uint64_t kOne = 1;
    if (counter_ == 64) {
      Log::Fatal("NewAgentEventUidGenerator",
                 "BioDynaMo only supports 64 unique NewAgentEventUids."
                 " You requested a 65th one.");
    }
    return kOne << counter_++;
  }
 
 private:
  NewAgentEventUidGenerator() = default;
  std::recursive_mutex mutex_;
  uint64_t counter_ = 0;
};
 
struct NewAgentEvent {
  virtual ~NewAgentEvent() = default;
 
  virtual NewAgentEventUid GetUid() const = 0;
 
  mutable Agent* existing_agent;
  mutable InlineVector<Agent*, 3> new_agents;
  mutable Behavior* existing_behavior;
  mutable InlineVector<Behavior*, 3> new_behaviors;
};
 
}  // namespace bdm
 
#endif  // CORE_AGENT_NEW_AGENT_EVENT_H_