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

#include <global_federate_id.hpp>

Public Types

using base_type = identififier_base_type
 

Public Member Functions

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

Detailed Description

class defining a specific type for labeling a route

Constructor & Destructor Documentation

◆ route_id() [1/2]

constexpr helics::route_id::route_id ( )
constexprdefault

default constructor

◆ route_id() [2/2]

constexpr helics::route_id::route_id ( base_type  val)
inlineexplicitconstexprnoexcept

construct from a base_type value

Member Function Documentation

◆ baseValue()

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

explicitly convert to a base value

Referenced by helics::CommsInterface::addRoute(), and helics::CommsInterface::removeRoute().

◆ isValid()

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

check if the route is valid

◆ operator!=()

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

inequality operator

◆ operator<()

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

less than operator for sorting

◆ operator==()

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

equality operator


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