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

#include <global_federate_id.hpp>

Public Types

using base_type = identififier_base_type
 

Public Member Functions

constexpr global_broker_id ()=default
 
constexpr global_broker_id (base_type val) noexcept
 
constexpr base_type baseValue () const
 
bool operator== (global_broker_id id) const noexcept
 
bool operator!= (global_broker_id id) const noexcept
 
bool operator< (global_broker_id id) const noexcept
 
bool isFederate () const
 
bool isBroker () const
 
bool isValid () const
 
base_type localIndex () const
 

Friends

class global_federate_id
 

Detailed Description

class holding a globally unique identifier for brokers

the class is fully compatible with global_federate_id

Constructor & Destructor Documentation

◆ global_broker_id()

constexpr helics::global_broker_id::global_broker_id ( )
constexprdefault

default constructor

Member Function Documentation

◆ baseValue()

constexpr base_type helics::global_broker_id::baseValue ( ) const
inlineconstexpr

extract the base value of the id code

◆ operator!=()

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

inequality operator

◆ operator<()

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

less than operator for sorting

◆ operator==()

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

equality operator


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