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

#include <global_federate_id.hpp>

Public Types

using base_type = identififier_base_type
 

Public Member Functions

constexpr global_federate_id ()=default
 
constexpr global_federate_id (base_type val) noexcept
 
constexpr global_federate_id (global_broker_id id) noexcept
 
constexpr operator global_broker_id () const noexcept
 
constexpr base_type baseValue () const
 
bool operator== (global_federate_id id) const noexcept
 
bool operator!= (global_federate_id id) const noexcept
 
bool operator< (global_federate_id id) const noexcept
 
bool operator> (global_federate_id id) const noexcept
 
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 operator> (global_broker_id id) const noexcept
 
bool isFederate () const
 
bool isBroker () const
 
bool isValid () const
 
constexpr base_type localIndex () const
 

Detailed Description

class holder a globally unique identifier for federates

Constructor & Destructor Documentation

◆ global_federate_id() [1/2]

constexpr helics::global_federate_id::global_federate_id ( )
constexprdefault

default constructor

◆ global_federate_id() [2/2]

constexpr helics::global_federate_id::global_federate_id ( global_broker_id  id)
inlineconstexprnoexcept

implicit conversion from global_id

Member Function Documentation

◆ baseValue()

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

◆ isBroker()

bool helics::global_federate_id::isBroker ( ) const
inline

return true if the broker_id is a valid broker id code

◆ isFederate()

bool helics::global_federate_id::isFederate ( ) const
inline

return true if the broker_id is a valid federate id code

◆ isValid()

bool helics::global_federate_id::isValid ( ) const
inline

return true if the broker_id is a valid broker id code

◆ localIndex()

constexpr base_type helics::global_federate_id::localIndex ( ) const
inlineconstexpr

generate a local offset index

the global_id is shifted by a certain amount

◆ operator!=() [1/2]

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

inequality operator

◆ operator!=() [2/2]

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

inequality operator

◆ operator<() [1/2]

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

less than operator for sorting

◆ operator<() [2/2]

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

less than operator for sorting

◆ operator==() [1/2]

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

equality operator

◆ operator==() [2/2]

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

equality operator

◆ operator>() [1/2]

bool helics::global_federate_id::operator> ( global_broker_id  id) const
inlinenoexcept

greater than operator for sorting

◆ operator>() [2/2]

bool helics::global_federate_id::operator> ( global_federate_id  id) const
inlinenoexcept

greater than operator for sorting


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