helics  2.8.1
Public Member Functions | Public Attributes | List of all members
helics::global_handle Class Reference

#include <global_federate_id.hpp>

Public Member Functions

constexpr global_handle ()=default
 
constexpr global_handle (global_federate_id fed, interface_handle hand)
 
 operator uint64_t () const
 
bool operator== (global_handle id) const noexcept
 
bool operator!= (global_handle id) const noexcept
 
bool operator< (global_handle id) const noexcept
 
bool isValid () const
 

Public Attributes

global_federate_id fed_id = global_federate_id{}
 the federate id component
 
interface_handle handle = interface_handle{}
 the interface handle component
 

Detailed Description

class merging a global id and handle together

Constructor & Destructor Documentation

◆ global_handle() [1/2]

constexpr helics::global_handle::global_handle ( )
constexprdefault

default constructor

◆ global_handle() [2/2]

constexpr helics::global_handle::global_handle ( global_federate_id  fed,
interface_handle  hand 
)
inlineconstexpr

construct directly from a federate_id and interface_handle

Member Function Documentation

◆ isValid()

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

check if the handle points to a validly specified interface

◆ operator uint64_t()

helics::global_handle::operator uint64_t ( ) const
inlineexplicit

convert to a uint64_t

for use in maps and other things

References helics::interface_handle::baseValue(), helics::global_federate_id::baseValue(), fed_id, and handle.

◆ operator!=()

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

inequality operator

◆ operator<()

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

less than operator for sorting

◆ operator==()

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

equality operator


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