helics::FilterFederateManager Class Reference

#include <FilterFederateManager.hpp>

Public Member Functions
	FilterFederateManager (Core *coreObj, Federate *fFed, local_federate_id id)
	~FilterFederateManager ()
Filter &	registerFilter (const std::string &name, const std::string &type_in, const std::string &type_out)
CloningFilter &	registerCloningFilter (const std::string &name, const std::string &type_in, const std::string &type_out)
Filter &	registerFilter (filter_types type, const std::string &name)
CloningFilter &	registerCloningFilter (filter_types type, const std::string &name)
Filter &	getFilter (const std::string &name)
const Filter &	getFilter (const std::string &name) const
Filter &	getFilter (int index)
const Filter &	getFilter (int index) const
int	getFilterCount () const
void	closeAllFilters ()

Detailed Description

class handling the implementation details of a value Federate

the functions will parallel those in message Federate and contain the actual implementation details

Constructor & Destructor Documentation

FilterFederateManager()

helics::FilterFederateManager::FilterFederateManager	(	Core *	coreObj,
		Federate *	fFed,
		local_federate_id	id
	)

construct from a pointer to a core and a specified federate id

~FilterFederateManager()

helics::FilterFederateManager::~FilterFederateManager ( )

default

destructor

Member Function Documentation

closeAllFilters()

void helics::FilterFederateManager::closeAllFilters

(

)

close all filters

References helics::Core::closeHandle().

getFilter()

Filter & helics::FilterFederateManager::getFilter

(

const std::string &

name

)

get a registered Filter

Parameters

name	the publication id

Returns

ivalid_publication_id if name is not recognized otherwise returns the publication_id

getFilterCount()

int helics::FilterFederateManager::getFilterCount

(

)

const

get the number of registered filters in the federate

registerCloningFilter() [1/2]

CloningFilter & helics::FilterFederateManager::registerCloningFilter	(	const std::string &	name,
		const std::string &	type_in,
		const std::string &	type_out
	)

register a cloningFilter

call is only valid in startup mode

Parameters

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().

registerCloningFilter() [2/2]

CloningFilter & helics::FilterFederateManager::registerCloningFilter	(	filter_types	type,
		const std::string &	name
	)

register a cloningFilter

call is only valid in startup mode

Parameters

name	the name of the endpoint
type	the defined type of the interface for endpoint checking if requested

References helics::make_cloning_filter().

registerFilter() [1/2]

Filter & helics::FilterFederateManager::registerFilter	(	const std::string &	name,
		const std::string &	type_in,
		const std::string &	type_out
	)

register a Filter

call is only valid in startup mode

Parameters

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().

registerFilter() [2/2]

Filter & helics::FilterFederateManager::registerFilter	(	filter_types	type,
		const std::string &	name
	)

register a Filter

call is only valid in startup mode

Parameters

name	the name of the endpoint
type	the defined type of the interface for endpoint checking if requested

References helics::make_filter().

---

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

• FilterFederateManager.hpp
• FilterFederateManager.cpp