#include <HandleManager.hpp>

Public Member Functions
	HandleManager ()=default

BasicHandleInfo &	addHandle (GlobalFederateId fed_id, InterfaceType what, std::string_view key, std::string_view type, std::string_view units)

BasicHandleInfo &	addHandle (GlobalFederateId fed_id, InterfaceHandle local_id, InterfaceType what, std::string_view key, std::string_view type, std::string_view units)

void	addHandle (const BasicHandleInfo &otherHandle)

void	addHandleAtIndex (const BasicHandleInfo &otherHandle, int32_t index)

void	removeHandle (GlobalHandle handle)

void	removeFederateHandles (GlobalFederateId fedToRemove)

BasicHandleInfo *	getHandleInfo (int32_t index)

const BasicHandleInfo *	getHandleInfo (int32_t index) const

BasicHandleInfo *	getHandleInfo (InterfaceHandle handle)

const BasicHandleInfo *	getHandleInfo (InterfaceHandle handle) const

BasicHandleInfo *	findHandle (GlobalHandle id)

const BasicHandleInfo *	findHandle (GlobalHandle id) const

void	setHandleOption (InterfaceHandle handle, int32_t option, int32_t val)

int32_t	getHandleOption (InterfaceHandle handle, int32_t option) const

BasicHandleInfo *	getInterfaceHandle (std::string_view name, InterfaceType type)

const BasicHandleInfo *	getInterfaceHandle (std::string_view name, InterfaceType type) const

BasicHandleInfo *	getInterfaceHandle (InterfaceHandle handle, InterfaceType type)

const BasicHandleInfo *	getInterfaceHandle (InterfaceHandle handle, InterfaceType type) const

LocalFederateId	getLocalFedID (InterfaceHandle handle) const

BasicHandleInfo &	operator[] (size_t index)

const BasicHandleInfo &	operator[] (size_t index) const

void	addAlias (std::string_view interfaceName, std::string_view alias)

auto	begin ()

auto	end ()

auto	begin () const

auto	end () const

auto	size () const

std::vector< GlobalHandle >	regexSearch (const std::string &regexExpression, InterfaceType type) const

const std::unordered_map< std::string_view, std::vector< std::string_view > > &	getAliases () const

Detailed Description

class for managing a coordinating the different types of handles used in helics

this class is not designed to be thread safe that would require a wrapper around it

Constructor & Destructor Documentation

◆ HandleManager()

helics::HandleManager::HandleManager ( )

default

default constructor

Member Function Documentation

◆ addAlias()

void helics::HandleManager::addAlias	(	std::string_view	interfaceName,
		std::string_view	alias
	)

add an alias for an interface*

Parameters

interfaceName	the name of the interface to add an alias for
alias	the new name by which an interface can be referenced

Exceptions

std::runtime_error if an alias is duplicated

aliases should be reciprocal

◆ addHandle() [1/2]

BasicHandleInfo & helics::HandleManager::addHandle	(	GlobalFederateId	fed_id,
		InterfaceHandle	local_id,
		InterfaceType	what,
		std::string_view	key,
		std::string_view	type,
		std::string_view	units
	)

add a handle to manage

◆ addHandle() [2/2]

BasicHandleInfo & helics::HandleManager::addHandle	(	GlobalFederateId	fed_id,
		InterfaceType	what,
		std::string_view	key,
		std::string_view	type,
		std::string_view	units
	)