![]() |
helics
3.0.1
|
#include <cstdint>
Go to the source code of this file.
Enumerations | |
enum | operation_flags : uint16_t { iteration_requested_flag = 0, destination_target = 1, required_flag = 2, core_flag = 3, error_flag = 4, indicator_flag = 5, use_json_serialization_flag = 6, extra_flag1 = 7, optional_flag = 8, clone_flag, extra_flag2 = 10, destination_processing_flag, disconnected_flag = 12, extra_flag3 = 13, extra_flag4 = 14, empty_flag = 15 } |
Functions | |
template<class FlagContainer , class FlagIndex > | |
void | setActionFlag (FlagContainer &M, FlagIndex flag) |
template<class FlagIndex > | |
bool | checkActionFlag (uint16_t flags, FlagIndex flag) |
template<class FlagContainer , class FlagIndex > | |
bool | checkActionFlag (const FlagContainer &M, FlagIndex flag) |
template<class FlagContainer , class FlagIndex > | |
void | clearActionFlag (FlagContainer &M, FlagIndex flag) |
template<class FlagContainer , class FlagIndex > | |
void | toggleActionFlag (FlagContainer &M, FlagIndex flag) |
constexpr uint16_t | make_flags (unsigned int flag) |
constexpr uint16_t | make_flags (unsigned int flag1, unsigned int flag2) |
constexpr uint16_t | make_flags (unsigned int flag1, unsigned int flag2, unsigned int flag3) |
Variables | |
constexpr uint16_t | slow_responding_flag = extra_flag4 |
overload of extra_flag4 indicating a federate, core or broker is slow responding | |
constexpr uint16_t | cancel_flag = extra_flag3 |
overload of extra_flag3 indicating an operation is canceled | |
constexpr uint16_t | observer_flag = optional_flag |
overload of optional_flag indicating that a federate is an observer only | |
constexpr uint16_t | parent_flag = extra_flag3 |
overload of extra_flag3 indicating the message is from a parent object | |
constexpr uint16_t | child_flag = extra_flag4 |
overload of extra_flag4 indicating a message is from a child object | |
constexpr uint16_t | non_counting_flag = empty_flag |
overload of nameless_interface_flag indicating that a federate should not count in any totals | |
constexpr uint16_t | targetted_flag = extra_flag2 |
overload of extra_flag2 indicating an endpoint is targeted | |
constexpr uint16_t | filter_processing_required_flag |
constexpr uint16_t | non_granting_flag = extra_flag1 |
overload of extra_flag1 to indicate the request is from a non-granting federate | |
constexpr uint16_t | delayed_timing_flag = extra_flag2 |
overload of extra_flag2 to indicate the request is from federate with delayed timing | |
constexpr uint16_t | nameless_interface_flag = empty_flag |
overload of flag to indicate an interface is nameless | |
operations and helper functions for handling flags in helics
enum operation_flags : uint16_t |
flag definitions for the action Message Flag field
|
inline |
template function to check a flag in an object containing a flags field
|
inline |
check a flag value on a specified index template function to check a flag in an object containing a flags field
Referenced by helics::CommonCore::addDestinationTarget(), helics::CommonCore::addSourceTarget(), helics::CommonCore::closeHandle(), helics::FederateState::createInterface(), helics::FilterFederate::destinationProcessMessage(), helics::errorMessageString(), helics::prettyPrintString(), helics::TimeCoordinator::processConfigUpdateMessage(), helics::ForwardingTimeCoordinator::processDependencyUpdateMessage(), helics::TimeCoordinator::processDependencyUpdateMessage(), helics::FilterFederate::processFilterReturn(), helics::FilterFederate::processMessageFilter(), helics::CommonCore::sendTo(), helics::CommonCore::sendToAt(), helics::FederateState::setInterfaceProperty(), helics::CommonCore::setValue(), helics::ActionMessage::to_string(), and toggleActionFlag().
|
inline |
template function to clear a flag in an object containing a flags field
Referenced by toggleActionFlag().
|
inlineconstexpr |
helper function to facilitate make a flag variable
Referenced by helics::UnknownHandleManager::hasNonOptionalUnknowns(), helics::UnknownHandleManager::hasRequiredUnknowns(), make_flags(), helics::UnknownHandleManager::processNonOptionalUnknowns(), helics::UnknownHandleManager::processRequiredUnknowns(), and helics::CommonCore::registerCloningFilter().
|
inlineconstexpr |
helper function to facilitate make a flag variable out of two flags
References make_flags().
|
inlineconstexpr |
helper function to facilitate make a flag variable out of three flags
References make_flags().
|
inline |
template function to set a flag in an object containing a flags field
FlagContainer | an object with a .flags field |
FlagIndex | a type that can be used as part of a shift to index into a flag object |
M | the container to set the flag in |
flag | the flag to set |
Referenced by helics::CommonCore::addDestinationFilterToEndpoint(), helics::CoreBroker::addDestinationFilterToEndpoint(), helics::CommonCore::addDestinationTarget(), helics::CommonCore::addSourceTarget(), helics::TimeCoordinator::checkExecEntry(), helics::CoreBroker::clearTimeBarrier(), helics::FilterCoordinator::closeFilter(), helics::CommonCore::closeHandle(), helics::CommonCore::connect(), helics::CommonCore::enterExecutingMode(), helics::FederateState::enterExecutingMode(), helics::TimeCoordinator::enteringExecMode(), helics::TimeoutMonitor::pingSub(), helics::CommonCore::registerCloningFilter(), helics::CommonCore::registerFederate(), helics::CommonCore::requestTimeIterative(), helics::CommonCore::setFlagOption(), helics::CommonCore::setHandleOption(), helics::setIterationFlags(), helics::CoreBroker::setLoggingCallback(), helics::CommonCore::setLoggingCallback(), helics::CommonCore::timeRequest(), and toggleActionFlag().
|
inline |
template function to clear a flag in an object containing a flags field
References checkActionFlag(), clearActionFlag(), and setActionFlag().
|
constexpr |