| helics 3.6.1

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

`#include <GlobalFederateId.hpp>`

## Public Types
using | BaseType = IdentifierBaseType

## Public Member Functions
constexpr | route_id ()=default
constexpr | route_id (BaseType val) noexcept
constexpr BaseType | baseValue () const
constexpr bool | operator== (route_id id) const noexcept
constexpr bool | operator!= (route_id id) const noexcept
constexpr bool | operator< (route_id id) const noexcept
constexpr 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 | ( |  | ) |
| constexpr default

default constructor

## ◆ route_id() [2/2]

constexpr helics::route_id::route_id | ( | BaseType | val | ) |
| inline explicit constexpr noexcept

construct from a BaseType value

## Member Function Documentation

## ◆ baseValue()

constexpr BaseType helics::route_id::baseValue | ( |  | ) | const
| inline constexpr

explicitly convert to a base value

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

## ◆ isValid()

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

check if the route is valid

## ◆ operator!=()

constexpr bool helics::route_id::operator!= | ( | route_id | id | ) | const
| inline constexpr noexcept

inequality operator

## ◆ operator<()

constexpr bool helics::route_id::operator< | ( | route_id | id | ) | const
| inline constexpr noexcept

less than operator for sorting

## ◆ operator==()

constexpr bool helics::route_id::operator== | ( | route_id | id | ) | const
| inline constexpr noexcept

equality operator

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

- GlobalFederateId.hpp