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 ( )

constexprdefault

default constructor

Member Function Documentation

baseValue()

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

inlineconstexpr

extract the base value of the id code

Referenced by helics::getSpecialFederateId().

operator!=()

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

inlineconstexprnoexcept

inequality operator

operator<()

constexpr bool helics::GlobalBrokerId::operator< ( GlobalBrokerId  id ) const

inlineconstexprnoexcept

less than operator for sorting

operator==()

constexpr bool helics::GlobalBrokerId::operator== ( GlobalBrokerId  id ) const

inlineconstexprnoexcept

equality operator

---

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

• GlobalFederateId.hpp