helics  3.3.0
AsyncTimeCoordinator.hpp
1 /*
2 Copyright (c) 2017-2022,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable
4 Energy, LLC. See the top-level NOTICE for additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7 #pragma once
8 
9 #include "ActionMessage.hpp"
10 #include "BaseTimeCoordinator.hpp"
11 #include "CoreFederateInfo.hpp"
12 #include "TimeDependencies.hpp"
13 
14 #include "json/forwards.h"
15 #include <atomic>
16 #include <functional>
17 #include <string>
18 #include <utility>
19 #include <vector>
20 
21 namespace helics {
22 
33  private:
34  // the variables for time coordination
35  Time currentMinTime{Time::minVal()};
36  TimeState currentTimeState{TimeState::initialized};
37  Time nextEvent{Time::maxVal()};
38 
39  protected:
40  bool iterating{false};
41 
42  public:
43  AsyncTimeCoordinator() = default;
44 
48  virtual bool updateTimeFactors() override;
49 
50  private:
51  void transmitTimingMessagesUpstream(ActionMessage& msg) const;
52  void transmitTimingMessagesDownstream(ActionMessage& msg,
53  GlobalFederateId skipFed = GlobalFederateId{}) const;
54 
55  public:
58  checkExecEntry(GlobalFederateId triggerFed = GlobalFederateId{}) override;
59 
61  virtual std::string printTimeStatus() const override;
63  virtual void generateDebuggingTimeInfo(Json::Value& base) const override;
64 
66  virtual Time getNextTime() const override { return currentMinTime; }
67 };
68 } // namespace helics
helics::timeZero
constexpr Time timeZero
Definition: helicsTime.hpp:31
helics::AsyncTimeCoordinator::getNextTime
virtual Time getNextTime() const override
Definition: AsyncTimeCoordinator.hpp:66
helics::AsyncTimeCoordinator::generateDebuggingTimeInfo
virtual void generateDebuggingTimeInfo(Json::Value &base) const override
Definition: AsyncTimeCoordinator.cpp:32
helics::ActionMessage::setExtraDestData
void setExtraDestData(int32_t data)
Definition: ActionMessage.hpp:161
helics::BaseTimeCoordinator::dependencies
TimeDependencies dependencies
Definition: BaseTimeCoordinator.hpp:27
helics::BaseTimeCoordinator::sendMessageFunction
std::function< void(const ActionMessage &)> sendMessageFunction
callback used to send the messages
Definition: BaseTimeCoordinator.hpp:29
helics::TimeState
TimeState
Definition: TimeDependencies.hpp:20
helics::BaseTimeCoordinator::mSourceId
GlobalFederateId mSourceId
the identifier for inserting into the source id field of any generated messages;
Definition: BaseTimeCoordinator.hpp:32
helics_definitions.hpp
base helics enumerations for C++ API's, a namespace wrapper for the definitions defined in helics_enu...
helics::Time
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
helics::AsyncTimeCoordinator::checkExecEntry
virtual MessageProcessingResult checkExecEntry(GlobalFederateId triggerFed=GlobalFederateId{}) override
Definition: AsyncTimeCoordinator.cpp:48
helics::GlobalFederateId
Definition: GlobalFederateId.hpp:72
helics::ActionMessage
Definition: ActionMessage.hpp:30
helics::AsyncTimeCoordinator::iterating
bool iterating
flag indicating that the min dependency is iterating
Definition: AsyncTimeCoordinator.hpp:40
helics::AsyncTimeCoordinator::printTimeStatus
virtual std::string printTimeStatus() const override
Definition: AsyncTimeCoordinator.cpp:41
helics::BaseTimeCoordinator::executionMode
bool executionMode
Definition: BaseTimeCoordinator.hpp:37
helics::AsyncTimeCoordinator::updateTimeFactors
virtual bool updateTimeFactors() override
Definition: AsyncTimeCoordinator.cpp:23
helics::AsyncTimeCoordinator
Definition: AsyncTimeCoordinator.hpp:32
helics::ActionMessage::dest_id
GlobalFederateId dest_id
20 fed_id for a targeted message
Definition: ActionMessage.hpp:39
helics::MessageProcessingResult::CONTINUE_PROCESSING
@ CONTINUE_PROCESSING
the current loop should continue
helics::MessageProcessingResult
MessageProcessingResult
Definition: CoreTypes.hpp:64
helics::BaseTimeCoordinator
Definition: BaseTimeCoordinator.hpp:25
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
helics::MessageProcessingResult::NEXT_STEP
@ NEXT_STEP
indicator that the iterations have completed
helics::BaseTimeCoordinator::generateDebuggingTimeInfo
virtual void generateDebuggingTimeInfo(Json::Value &base) const
Definition: BaseTimeCoordinator.cpp:118
helics::ActionMessage::action
action_message_def::action_t action() const noexcept
Definition: ActionMessage.hpp:88
flagOperations.hpp
helics::ActionMessage::source_id
GlobalFederateId source_id
12 – for federate_id or route_id
Definition: ActionMessage.hpp:37