helics::GlobalHandle Class Reference

#include <GlobalFederateId.hpp>

Public Member Functions
constexpr	GlobalHandle ()=default
constexpr	GlobalHandle (GlobalFederateId fed, InterfaceHandle hand)
	operator uint64_t () const
constexpr bool	operator== (GlobalHandle id) const noexcept
constexpr bool	operator!= (GlobalHandle id) const noexcept
constexpr bool	operator< (GlobalHandle id) const noexcept
constexpr bool	isValid () const

Public Attributes
GlobalFederateId	fed_id = GlobalFederateId{}
	the federate id component
InterfaceHandle	handle = InterfaceHandle{}
	the interface handle component

Detailed Description

class merging a global id and handle together

Constructor & Destructor Documentation

GlobalHandle() [1/2]

constexpr helics::GlobalHandle::GlobalHandle ( )

constexprdefault

default constructor

GlobalHandle() [2/2]

constexpr helics::GlobalHandle::GlobalHandle ( GlobalFederateId  fed, InterfaceHandle  hand  )

inlineconstexpr

construct directly from a federate_id and InterfaceHandle

Member Function Documentation

isValid()

constexpr bool helics::GlobalHandle::isValid ( ) const

inlineconstexpr

check if the handle points to a validly specified interface

References fed_id, handle, and helics::GlobalFederateId::isValid().

operator uint64_t()

helics::GlobalHandle::operator uint64_t ( ) const

inlineexplicit

convert to a uint64_t

for use in maps and other things

References helics::GlobalFederateId::baseValue(), helics::InterfaceHandle::baseValue(), fed_id, and handle.

operator!=()

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

inlineconstexprnoexcept

inequality operator

References fed_id, and handle.

operator<()

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

inlineconstexprnoexcept

less than operator for sorting

References fed_id, and handle.

operator==()

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

inlineconstexprnoexcept

equality operator

References fed_id, and handle.

---

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

• GlobalFederateId.hpp