helics::CloningFilter Class Reference

#include <Filters.hpp>

Inheritance diagram for helics::CloningFilter:

Public Member Functions
	CloningFilter ()=default
	CloningFilter (Core *cr, const std::string &filtName=EMPTY_STRING)
	CloningFilter (Federate *ffed, const std::string &filtName=EMPTY_STRING)
	CloningFilter (interface_visibility locality, Federate *ffed, const std::string &filtName=EMPTY_STRING)
	CloningFilter (Federate *ffed, const std::string &filtName, interface_handle handle)
	CloningFilter (CloningFilter &&filt)=default
	CloningFilter (const CloningFilter &filt)=default
CloningFilter &	operator= (CloningFilter &&filt)=default
CloningFilter &	operator= (const CloningFilter &filt)=default
	~CloningFilter ()=default
void	addDeliveryEndpoint (const std::string &endpoint)
void	removeDeliveryEndpoint (const std::string &endpoint)
virtual void	setString (const std::string &property, const std::string &val) override
Public Member Functions inherited from helics::Filter
	Filter ()=default
	Filter (Federate *ffed, const std::string &filtName=EMPTY_STRING)
	Filter (Federate *ffed, const std::string &filtName, interface_handle ihandle)
	Filter (interface_visibility locality, Federate *ffed, const std::string &filtName=EMPTY_STRING)
	Filter (Core *cr, const std::string &filtName=EMPTY_STRING)
virtual	~Filter ()=default
	Filter (Filter &&filt)=default
	Filter (const Filter &filt)=default
Filter &	operator= (Filter &&filt)=default
Filter &	operator= (const Filter &filt)=default
bool	isValid () const
bool	isCloningFilter () const
void	setOperator (std::shared_ptr< FilterOperator > mo)
interface_handle	getHandle () const
	operator interface_handle () const
const std::string &	getName () const
const std::string &	getKey () const
const std::string &	getInjectionType () const
const std::string &	getExtractionType () const
const std::string &	getInfo () const
void	setInfo (const std::string &info)
virtual void	set (const std::string &property, double val)
virtual void	addSourceTarget (const std::string &sourceName)
virtual void	addDestinationTarget (const std::string &destinationName)
void	addTarget (const std::string &target)
virtual void	removeTarget (const std::string &sourceName)
void	setOption (int32_t option, int32_t value)
void	close ()
int32_t	getOption (int32_t option) const

Friends
class	FilterFederateManager

Additional Inherited Members
Protected Member Functions inherited from helics::Filter
void	setFilterOperations (std::shared_ptr< FilterOperations > filterOps)
Protected Attributes inherited from helics::Filter
Core *	corePtr = nullptr
	the Core to use
Federate *	fed = nullptr
	pointer to fed
interface_handle	handle
	the handle as generated by the Federate
bool	cloning = false
bool	disableAssign = false
	disable assignment for the object
std::string	name
	The name of the filter.

Detailed Description

class used to clone message for delivery to other endpoints

Constructor & Destructor Documentation

CloningFilter() [1/7]

helics::CloningFilter::CloningFilter ( )

default

default constructor

CloningFilter() [2/7]

helics::CloningFilter::CloningFilter ( Core *  cr, const std::string &  filtName = EMPTY_STRING  )

explicit

construct from a core object

References helics::Filter::corePtr, helics::Filter::handle, helics::Filter::name, helics::Core::registerCloningFilter(), and helics::Filter::setFilterOperations().

CloningFilter() [3/7]

helics::CloningFilter::CloningFilter ( Federate *  ffed, const std::string &  filtName = EMPTY_STRING  )

explicit

construct from a Federate

References helics::Filter::corePtr, and helics::Filter::setFilterOperations().

CloningFilter() [4/7]

helics::CloningFilter::CloningFilter	(	interface_visibility	locality,
		Federate *	ffed,
		const std::string &	filtName = EMPTY_STRING
	)

construct from a Federate

References helics::Filter::corePtr, and helics::Federate::getCorePointer().

CloningFilter() [5/7]

helics::CloningFilter::CloningFilter	(	Federate *	ffed,
		const std::string &	filtName,
		interface_handle	handle
	)

constructor used by FilterFederateManager

CloningFilter() [6/7]

helics::CloningFilter::CloningFilter ( CloningFilter &&  filt )

default

move the filter to a new cloning filter

CloningFilter() [7/7]

helics::CloningFilter::CloningFilter ( const CloningFilter &  filt )

default

copy the filter, a copied filter will point to the same object

~CloningFilter()

helics::CloningFilter::~CloningFilter ( )

default

destructor

Member Function Documentation

addDeliveryEndpoint()

void helics::CloningFilter::addDeliveryEndpoint

(

const std::string &

endpoint

)

add a delivery address this is the name of an endpoint to deliver the message to

References helics::Filter::setString().

operator=() [1/2]

CloningFilter& helics::CloningFilter::operator= ( CloningFilter &&  filt )

default

move assign the cloning filter

operator=() [2/2]

CloningFilter& helics::CloningFilter::operator= ( const CloningFilter &  filt )

default

copy the filter, a copied filter will point to the same object as the original

removeDeliveryEndpoint()

void helics::CloningFilter::removeDeliveryEndpoint

(

const std::string &

endpoint

)

remove a delivery address this is the name of an endpoint to deliver the message to

References helics::Filter::setString().

setString()

void helics::CloningFilter::setString ( const std::string &  property, const std::string &  val  )

overridevirtual

set a string property on a filter

Parameters

property	the name of the property of the filter to change
val	the numerical value of the property

Reimplemented from helics::Filter.

References helics::Filter::addDestinationTarget(), helics::Filter::addSourceTarget(), helics::Filter::removeTarget(), and helics::Filter::setString().

---

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

• Filters.hpp
• Filters.cpp