ForwardingTimeCoordinator.hpp

/*
Copyright (c) 2017-2024,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
Energy, LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
 
#include "ActionMessage.hpp"
#include "BaseTimeCoordinator.hpp"
#include "CoreFederateInfo.hpp"
#include "TimeDependencies.hpp"
 
#include "json/forwards.h"
#include <atomic>
#include <functional>
#include <string>
#include <utility>
#include <vector>
 
namespace helics {
 
class ForwardingTimeCoordinator: public BaseTimeCoordinator {
  private:
    // the variables for time coordination
    DependencyInfo upstream;
    DependencyInfo downstream;
    static constexpr std::int32_t mSequenceIncrement{100};
 
  protected:
    bool iterating{false};  
    bool ignoreMinFed{false};  
    std::int32_t sequenceModifier{0};
 
  public:
    ForwardingTimeCoordinator() = default;
 
    virtual bool updateTimeFactors() override;
 
  private:
    void transmitTimingMessagesUpstream(ActionMessage& msg) const;
    void transmitTimingMessagesDownstream(ActionMessage& msg,
                                          GlobalFederateId skipFed = GlobalFederateId{}) const;
 
  public:
    virtual TimeProcessingResult processTimeMessage(const ActionMessage& cmd) override;
    virtual MessageProcessingResult
        checkExecEntry(GlobalFederateId triggerFed = GlobalFederateId{}) override;
 
    virtual std::string printTimeStatus() const override;
    virtual void generateDebuggingTimeInfo(Json::Value& base) const override;
 
    virtual Time getNextTime() const override { return downstream.next; }
};
}  // namespace helics