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

#include <federate_id.hpp>

Public Types

using base_type = identififier_base_type
 

Public Member Functions

constexpr local_federate_id ()=default
 
constexpr local_federate_id (base_type val) noexcept
 
constexpr base_type baseValue () const
 
bool operator== (local_federate_id id) const noexcept
 
bool operator!= (local_federate_id id) const noexcept
 
bool operator< (local_federate_id 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 a 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

◆ local_federate_id() [1/2]

constexpr helics::local_federate_id::local_federate_id ( )
constexprdefault

default constructor

◆ local_federate_id() [2/2]

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

convert a base type value into a local_federate id

Member Function Documentation

◆ baseValue()

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

extract the base value of the id code

Referenced by helics::CommonCore::getFederateAt().

◆ isValid()

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

check if the operator is valid

valid operators have been set to something other than the default value

◆ operator!=()

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

inequality operator

◆ operator<()

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

less than operator for sorting

◆ operator==()

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

equality operator


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