| helics 3.6.1

Namespaces | Enumerations | Functions
flagOperations.hpp File Reference
`#include <cstdint>`

Go to the source code of this file.

## Namespaces
| helics
| the main namespace for the helics co-simulation library User functions will be in the helics namespace with internal functions possible in a lower level namespace

## Enumerations
enum | helics::GeneralFlags : uint16_t { helics::error_flag = 4 , helics::indicator_flag = 5 }
enum | helics::TimingFlags : uint16_t { helics::iteration_requested_flag = 0 , helics::non_granting_flag = 7 , helics::interrupted_flag = 8 , helics::delayed_timing_flag = 10 , helics::parent_flag = 13 , helics::child_flag = 14 }
| flags used in timing messages More...
enum | helics::InterfaceFlags : uint16_t { helics::buffer_data_flag = 0 , helics::destination_target = 1 , helics::required_flag = 2 , helics::single_connection_flag = 3 , helics::only_update_on_change_flag = 6 , helics::reconnectable_flag = 7 , helics::optional_flag = 8 , helics::only_transmit_on_change_flag = 12 , helics::nameless_interface_flag = 15 }
| flags used on handles More...
enum | helics::EndpointFlags { helics::targeted_flag = 10 , helics::has_source_filter_flag = 11 , helics::source_only_flag = 13 , helics::receive_only_flag = 14 }
| enumeration of endpoint specific flags More...
enum | helics::FilterFlags { helics::clone_flag = 9 , helics::has_dest_filter_flag = 13 , helics::has_non_cloning_dest_filter_flag = 14 }
| enumeration of filter specific flags More...
enum | helics::ConnectionFlags : uint16_t { helics::core_flag = 3 , helics::global_timing_flag = 5 , helics::use_json_serialization_flag = 6 , helics::async_timing_flag = 7 , helics::observer_flag = 8 , helics::dynamic_join_flag = 9 , helics::reentrant_flag = 10 , helics::global_disconnect_flag = 11 , helics::disconnected_flag = 12 , helics::test_connection_flag = 13 , helics::slow_responding_flag = 14 , helics::non_counting_flag = 15 }
| flags used when connecting a federate/core/broker to a federation More...
enum | helics::MessageFlags : uint16_t { helics::filter_processing_required_flag = 7 , helics::user_custom_message_flag1 = 10 , helics::destination_processing_flag = 11 , helics::user_custom_message_flag2 = 13 , helics::user_custom_message_flag3 = 14 , empty_flag = 15 }
| flags used for messages More...
enum | helics::OperationFlags : uint16_t { helics::cancel_flag = 13 }
| general flags used for other operations More...

## Functions
template<class FlagContainer , class FlagIndex >
void | helics::setActionFlag (FlagContainer &M, FlagIndex flag)
template<class FlagIndex >
bool | helics::checkActionFlag (uint16_t flags, FlagIndex flag)
template<class FlagContainer , class FlagIndex >
bool | helics::checkActionFlag (const FlagContainer &M, FlagIndex flag)
template<class FlagContainer , class FlagIndex >
void | helics::clearActionFlag (FlagContainer &M, FlagIndex flag)
template<class FlagContainer , class FlagIndex >
void | helics::toggleActionFlag (FlagContainer &M, FlagIndex flag)
constexpr uint16_t | helics::make_flags (unsigned int flag)
constexpr uint16_t | helics::make_flags (unsigned int flag1, unsigned int flag2)
constexpr uint16_t | helics::make_flags (unsigned int flag1, unsigned int flag2, unsigned int flag3)
constexpr uint16_t | helics::toggle_flag (uint16_t base, unsigned int flag)

## Detailed Description

operations and helper functions for handling flags in helics