helics  2.8.1
TimeCoordinatorProcessing.hpp
1 /*
2 Copyright (c) 2017-2021,
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 "TimeCoordinator.hpp"
10 
11 #include <tuple>
12 
13 namespace helics {
14 std::tuple<federate_state, message_processing_result, bool>
15  processCoordinatorMessage(ActionMessage& cmd,
16  TimeCoordinator* timeCoord,
17  const federate_state state,
18  const bool timeGranted_mode,
19  const global_federate_id localID);
20 
21 }
helics::message_process_result::processed
@ processed
the message was used to update the current state
helics::HELICS_INITIALIZING
@ HELICS_INITIALIZING
Definition: core-types.hpp:24
helics::message_process_result::delay_processing
@ delay_processing
the message should be delayed and reprocessed later
helics::iteration_request
iteration_request
Definition: core-types.hpp:90
helics::parent_broker_id
constexpr global_broker_id parent_broker_id
Definition: global_federate_id.hpp:60
helics::federate_state
federate_state
Definition: core-types.hpp:22
helics::message_processing_result::error
@ error
indicator that an error has occurred
helics::returnableResult
bool returnableResult(message_processing_result result)
Definition: core-types.hpp:75
helics::iteration_request::force_iteration
@ force_iteration
force an iteration whether it is needed or not
iteration_requested_flag
@ iteration_requested_flag
indicator that an iteration has been requested
Definition: flagOperations.hpp:16
checkActionFlag
bool checkActionFlag(uint16_t flags, FlagIndex flag)
Definition: flagOperations.hpp:75
helics::message_processing_result
message_processing_result
Definition: core-types.hpp:65
helics::message_processing_result::halted
@ halted
indicator that the simulation has been halted
helics::message_processing_result::continue_processing
@ continue_processing
the current loop should continue
helics::iteration_request::iterate_if_needed
@ iterate_if_needed
indicator that the iterations need to continue
helics::iteration_request::no_iterations
@ no_iterations
indicator that the iterations have completed
indicator_flag
@ indicator_flag
flag used for setting values
Definition: flagOperations.hpp:21
helics::HELICS_ERROR
@ HELICS_ERROR
the federation has encountered an error
Definition: core-types.hpp:28
helics::HELICS_TERMINATING
@ HELICS_TERMINATING
the federate is in the process of shutting down
Definition: core-types.hpp:27
helics::HELICS_EXECUTING
@ HELICS_EXECUTING
the federation has entered execution state and it now advancing in time
Definition: core-types.hpp:26
helics::message_process_result::no_effect
@ no_effect
the message did not result in an update
helics
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
required_flag
@ required_flag
flag indicating that an action or match is required
Definition: flagOperations.hpp:18
helics::HELICS_FINISHED
@ HELICS_FINISHED
the federation has finished its execution
Definition: core-types.hpp:29
flagOperations.hpp
helics::root_broker_id
constexpr global_broker_id root_broker_id
Definition: global_federate_id.hpp:62
helics::message_processing_result::next_step
@ next_step
indicator that the iterations have completed
helics::message_processing_result::iterating
@ iterating
indicator that the iterations need to continue
helics::message_processing_result::delay_message
@ delay_message
delay the current message and continue processing