helics  3.3.0
GlobalTimeCoordinator.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 
26  private:
27  // the variables for time coordination
28  Time currentMinTime{Time::minVal()};
29  TimeState currentTimeState{TimeState::initialized};
30  Time nextEvent{Time::maxVal()};
31 
32  protected:
33  bool iterating{false};
34 
35  public:
36  GlobalTimeCoordinator() = default;
37 
41  virtual bool updateTimeFactors() override;
42 
43  private:
44  void transmitTimingMessagesUpstream(ActionMessage& msg) const;
45  void transmitTimingMessagesDownstream(ActionMessage& msg,
46  GlobalFederateId skipFed = GlobalFederateId{}) const;
47 
48  void sendTimeUpdateRequest(Time triggerTime);
49 
50  public:
53  checkExecEntry(GlobalFederateId triggerFed = GlobalFederateId{}) override;
54 
56  virtual std::string printTimeStatus() const override;
58  virtual void generateDebuggingTimeInfo(Json::Value& base) const override;
59 
61  virtual Time getNextTime() const override { return currentMinTime; }
62 };
63 } // namespace helics
helics::timeZero
constexpr Time timeZero
Definition: helicsTime.hpp:31
helics::ActionMessage::setExtraDestData
void setExtraDestData(int32_t data)
Definition: ActionMessage.hpp:161
helics::BaseTimeCoordinator::dependencies
TimeDependencies dependencies
Definition: BaseTimeCoordinator.hpp:27
helics::TimeDependencies::verifySequenceCounter
bool verifySequenceCounter(Time tmin, std::int32_t sq)
Definition: TimeDependencies.cpp:596
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::GlobalTimeCoordinator
Definition: GlobalTimeCoordinator.hpp:25
helics_definitions.hpp
base helics enumerations for C++ API's, a namespace wrapper for the definitions defined in helics_enu...
HELICS_LOG_LEVEL_WARNING
@ HELICS_LOG_LEVEL_WARNING
Definition: helics_enums.h:192
helics::Time
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
helics::cBigTime
constexpr Time cBigTime
Definition: helicsTime.hpp:37
helics::GlobalTimeCoordinator::updateTimeFactors
virtual bool updateTimeFactors() override
Definition: GlobalTimeCoordinator.cpp:75
helics::GlobalFederateId
Definition: GlobalFederateId.hpp:72
helics::ActionMessage
Definition: ActionMessage.hpp:30
helics::BaseTimeCoordinator::sequenceCounter
std::int32_t sequenceCounter
storage for sequence counter
Definition: BaseTimeCoordinator.hpp:33
helics::ActionMessage::counter
uint16_t counter
26 counter for filter tracking or message counter
Definition: ActionMessage.hpp:41
helics::BaseTimeCoordinator::executionMode
bool executionMode
Definition: BaseTimeCoordinator.hpp:37
helics::ActionMessage::messageID
int32_t messageID
8 – message ID for a variety of purposes
Definition: ActionMessage.hpp:36
helics::ActionMessage::dest_id
GlobalFederateId dest_id
20 fed_id for a targeted message
Definition: ActionMessage.hpp:39
helics::ActionMessage::Te
Time Te
48 event time
Definition: ActionMessage.hpp:45
helics::MessageProcessingResult::CONTINUE_PROCESSING
@ CONTINUE_PROCESSING
the current loop should continue
helics::MessageProcessingResult
MessageProcessingResult
Definition: CoreTypes.hpp:64
helics::ActionMessage::Tdemin
Time Tdemin
56 min dependent event time
Definition: ActionMessage.hpp:46
helics::ActionMessage::actionTime
Time actionTime
40 the time an action took place or will take place //32
Definition: ActionMessage.hpp:44
helics::GlobalTimeCoordinator::printTimeStatus
virtual std::string printTimeStatus() const override
Definition: GlobalTimeCoordinator.cpp:164
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::GlobalTimeCoordinator::generateDebuggingTimeInfo
virtual void generateDebuggingTimeInfo(Json::Value &base) const override
Definition: GlobalTimeCoordinator.cpp:154
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::GlobalTimeCoordinator::checkExecEntry
virtual MessageProcessingResult checkExecEntry(GlobalFederateId triggerFed=GlobalFederateId{}) override
Definition: GlobalTimeCoordinator.cpp:171
helics::ActionMessage::action
action_message_def::action_t action() const noexcept
Definition: ActionMessage.hpp:88
helics::GlobalTimeCoordinator::iterating
bool iterating
flag indicating that the min dependency is iterating
Definition: GlobalTimeCoordinator.hpp:33
helics::GlobalTimeCoordinator::getNextTime
virtual Time getNextTime() const override
Definition: GlobalTimeCoordinator.hpp:61
flagOperations.hpp
helics::TimeDependencies::checkIfReadyForExecEntry
bool checkIfReadyForExecEntry(bool iterating, bool waiting) const
Definition: TimeDependencies.cpp:454
helics::ActionMessage::source_id
GlobalFederateId source_id
12 – for federate_id or route_id
Definition: ActionMessage.hpp:37