helics  3.0.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
 
bool operator== (GlobalBrokerId id) const noexcept
 
bool operator!= (GlobalBrokerId id) const noexcept
 
bool operator< (GlobalBrokerId id) const noexcept
 
bool isFederate () const
 
bool isBroker () const
 
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

◆ operator!=()

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

inequality operator

◆ operator<()

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

less than operator for sorting

◆ operator==()

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

equality operator


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