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

#include <federate_id.hpp>

Public Types

using base_type = identififier_base_type
 

Public Member Functions

constexpr interface_handle ()=default
 
constexpr interface_handle (base_type val) noexcept
 
constexpr base_type baseValue () const
 
bool operator== (interface_handle id) const noexcept
 
bool operator!= (interface_handle id) const noexcept
 
bool operator< (interface_handle id) const noexcept
 
bool operator> (interface_handle id) const noexcept
 
bool isValid () const
 

Detailed Description

class defining a local_federate_id

the intent of this class is to limit the operations available on a federate identifier to those that are actually required and make sense, and make it as low impact as possible. it also acts to limit any mistakes of a local_federate_id

Constructor & Destructor Documentation

◆ interface_handle()

constexpr helics::interface_handle::interface_handle ( )
constexprdefault

default constructor

Member Function Documentation

◆ baseValue()

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

◆ operator!=()

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

inequality operator

◆ operator<()

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

comparison operator for sorting

◆ operator==()

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

equality operator


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