| helics 3.6.1

Public Types | Public Member Functions | Friends | List of all members
helics::GlobalBrokerId Class Reference

`#include <GlobalFederateId.hpp>`

## Public Types
using | BaseType = IdentifierBaseType

## Public Member Functions
constexpr | GlobalBrokerId ()=default
constexpr | GlobalBrokerId (BaseType val) noexcept
constexpr BaseType | baseValue () const
constexpr bool | operator== (GlobalBrokerId id) const noexcept
constexpr bool | operator!= (GlobalBrokerId id) const noexcept
constexpr bool | operator< (GlobalBrokerId id) const noexcept
constexpr bool | isFederate () const
constexpr bool | isBroker () const
constexpr bool | isValid () const
BaseType | localIndex () const

## Friends
class | GlobalFederateId

## Detailed Description

class holding a globally unique identifier for brokers

the class is fully compatible with GlobalFederateId

## Constructor & Destructor Documentation

## ◆ GlobalBrokerId()

constexpr helics::GlobalBrokerId::GlobalBrokerId | ( |  | ) |
| constexpr default

default constructor

## Member Function Documentation

## ◆ baseValue()

constexpr BaseType helics::GlobalBrokerId::baseValue | ( |  | ) | const
| inline constexpr

extract the base value of the id code

Referenced by helics::getSpecialFederateId().

## ◆ operator!=()

constexpr bool helics::GlobalBrokerId::operator!= | ( | GlobalBrokerId | id | ) | const
| inline constexpr noexcept

inequality operator

## ◆ operator<()

constexpr bool helics::GlobalBrokerId::operator< | ( | GlobalBrokerId | id | ) | const
| inline constexpr noexcept

less than operator for sorting

## ◆ operator==()

constexpr bool helics::GlobalBrokerId::operator== | ( | GlobalBrokerId | id | ) | const
| inline constexpr noexcept

equality operator

The documentation for this class was generated from the following file:

- GlobalFederateId.hpp