helics
3.5.2
|
#include <ConnectorFederateManager.hpp>
Public Member Functions | |
ConnectorFederateManager (Core *coreObj, Federate *fFed, LocalFederateId fid, bool singleThreaded) | |
~ConnectorFederateManager () | |
Filter & | registerFilter (std::string_view name, std::string_view type_in, std::string_view type_out) |
CloningFilter & | registerCloningFilter (std::string_view name, std::string_view type_in, std::string_view type_out) |
Filter & | registerFilter (FilterTypes type, std::string_view name) |
CloningFilter & | registerCloningFilter (FilterTypes type, std::string_view name) |
Filter & | getFilter (std::string_view name) |
const Filter & | getFilter (std::string_view name) const |
Filter & | getFilter (int index) |
const Filter & | getFilter (int index) const |
Translator & | registerTranslator (std::string_view name, std::string_view endpointType, std::string_view units) |
Translator & | getTranslator (std::string_view name) |
const Translator & | getTranslator (std::string_view name) const |
Translator & | getTranslator (int index) |
const Translator & | getTranslator (int index) const |
int | getFilterCount () const |
int | getTranslatorCount () const |
void | closeAllConnectors () |
void | disconnectAllConnectors () |
void | disconnect () |
class handling the implementation details for managing connectors(Filters and Translators)
the functions match those in Federate.hpp dealing with filters and Translators and contain the actual implementation details
helics::ConnectorFederateManager::ConnectorFederateManager | ( | Core * | coreObj, |
Federate * | fFed, | ||
LocalFederateId | fid, | ||
bool | singleThreaded | ||
) |
construct from a pointer to a core and a specified federate id
|
default |
destructor
void helics::ConnectorFederateManager::closeAllConnectors | ( | ) |
close all filters
References helics::Core::closeHandle().
void helics::ConnectorFederateManager::disconnect | ( | ) |
disconnect from the coreObject
void helics::ConnectorFederateManager::disconnectAllConnectors | ( | ) |
close all filters
Filter & helics::ConnectorFederateManager::getFilter | ( | std::string_view | name | ) |
get a registered Filter
name | the publication id |
int helics::ConnectorFederateManager::getFilterCount | ( | ) | const |
get the number of registered filters in the federate
Translator & helics::ConnectorFederateManager::getTranslator | ( | std::string_view | name | ) |
get a registered Translator
name | the translator name |
int helics::ConnectorFederateManager::getTranslatorCount | ( | ) | const |
get the number of registered filters in the federate
CloningFilter & helics::ConnectorFederateManager::registerCloningFilter | ( | FilterTypes | type, |
std::string_view | name | ||
) |
register a cloningFilter
call is only valid in startup mode
name | the name of the endpoint |
type | the defined type of the interface for endpoint checking if requested |
References helics::make_cloning_filter().
CloningFilter & helics::ConnectorFederateManager::registerCloningFilter | ( | std::string_view | name, |
std::string_view | type_in, | ||
std::string_view | type_out | ||
) |
register a cloningFilter
call is only valid in startup mode
name | the name of the endpoint |
type_in | the type the filter is expecting as an input |
type_out | the type the filter generates |
References helics::Core::getHandleName(), and helics::Core::registerCloningFilter().
Filter & helics::ConnectorFederateManager::registerFilter | ( | FilterTypes | type, |
std::string_view | name | ||
) |
register a Filter
call is only valid in startup mode
type | the defined type of the filter |
name | the name of the filter |
References helics::make_filter().
Filter & helics::ConnectorFederateManager::registerFilter | ( | std::string_view | name, |
std::string_view | type_in, | ||
std::string_view | type_out | ||
) |
register a Filter
call is only valid in startup mode
name | the name of the endpoint |
type_in | the type the filter is expecting as an input |
type_out | the type the filter generates |
References helics::Core::getHandleName(), and helics::Core::registerFilter().
Translator & helics::ConnectorFederateManager::registerTranslator | ( | std::string_view | name, |
std::string_view | endpointType, | ||
std::string_view | units | ||
) |
register a Translator
call is only valid in startup mode
name | the name of the translator |
endpointType | is the type of the endpoints |
units | is the units associated with the value interface |
References helics::Core::getHandleName(), and helics::Core::registerTranslator().