helics
3.5.1
|
#include <Filters.hpp>
Public Member Functions | |
Filter ()=default | |
Filter (Federate *ffed, std::string_view filtName=EMPTY_STRING) | |
Filter (Federate *ffed, std::string_view filtName, InterfaceHandle ihandle) | |
Filter (Core *core, std::string_view filtName, InterfaceHandle ihandle) | |
Filter (InterfaceVisibility locality, Federate *ffed, std::string_view filtName=EMPTY_STRING) | |
Filter (Core *core, std::string_view 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 | isCloningFilter () const |
void | setOperator (std::shared_ptr< FilterOperator > filterOp) |
virtual const std::string & | getDisplayName () const override |
virtual void | set (std::string_view property, double val) |
virtual void | setString (std::string_view property, std::string_view val) |
void | addTarget (std::string_view target) |
void | setFilterType (std::int32_t type) |
Public Member Functions inherited from helics::Interface | |
Interface (Federate *federate, InterfaceHandle hid, std::string_view actName) | |
Interface (Core *core, InterfaceHandle hid, std::string_view actName) | |
InterfaceHandle | getHandle () const |
operator InterfaceHandle () const | |
bool | isValid () const |
bool | operator< (const Interface &inp) const |
bool | operator> (const Interface &inp) const |
bool | operator== (const Interface &inp) const |
bool | operator!= (const Interface &inp) const |
const std::string & | getLocalName () const |
const std::string & | getName () const |
const std::string & | getTarget () const |
void | addSourceTarget (std::string_view newTarget, InterfaceType hint=InterfaceType::UNKNOWN) |
void | addDestinationTarget (std::string_view newTarget, InterfaceType hint=InterfaceType::UNKNOWN) |
void | removeTarget (std::string_view targetToRemove) |
void | addAlias (std::string_view alias) |
const std::string & | getInfo () const |
void | setInfo (std::string_view info) |
void | setTag (std::string_view tag, std::string_view value) |
const std::string & | getTag (std::string_view tag) const |
virtual void | setOption (int32_t option, int32_t value=1) |
virtual int32_t | getOption (int32_t option) const |
const std::string & | getInjectionType () const |
const std::string & | getExtractionType () const |
const std::string & | getInjectionUnits () const |
const std::string & | getExtractionUnits () const |
const std::string & | getSourceTargets () const |
const std::string & | getDestinationTargets () const |
void | close () |
void | disconnectFromCore () |
Protected Member Functions | |
void | setFilterOperations (std::shared_ptr< FilterOperations > filterOps) |
Protected Attributes | |
bool | cloning = false |
bool | disableAssign = false |
disable assignment for the object | |
Protected Attributes inherited from helics::Interface | |
Core * | mCore {nullptr} |
pointer to the core object | |
InterfaceHandle | handle {} |
the id as generated by the Federate | |
std::string | mName |
the name or key of the interface | |
Friends | |
void | addOperations (Filter *filt, FilterTypes type, Core *cptr) |
class for managing a particular filter
|
default |
default constructor
|
explicit |
construct through a federate
helics::Filter::Filter | ( | Federate * | ffed, |
std::string_view | filtName, | ||
InterfaceHandle | ihandle | ||
) |
construct from handle and federate
helics::Filter::Filter | ( | Core * | core, |
std::string_view | filtName, | ||
InterfaceHandle | ihandle | ||
) |
construct from handle and core
helics::Filter::Filter | ( | InterfaceVisibility | locality, |
Federate * | ffed, | ||
std::string_view | filtName = EMPTY_STRING |
||
) |
construct through a federate
|
explicit |
construct through a core object
References helics::Interface::handle, and helics::Core::registerFilter().
|
virtualdefault |
virtual destructor
|
default |
copy the filter, a copied filter will point to the same object
|
inlineoverridevirtual |
get the display name for an input
the name is the given local name or if empty the name of the target
Implements helics::Interface.
|
inline |
check if the filter is a cloning filter
copy the filter, a copied filter will point to the same object as the original
|
virtual |
set a property on a filter
property | the name of the property of the filter to change |
val | the numerical value of the property |
Referenced by helicsFilterSet().
|
protected |
set a filter operations object
References helics::Interface::handle, helics::Interface::mCore, and helics::Core::setFilterOperator().
Referenced by helics::CloningFilter::CloningFilter().
void helics::Filter::setFilterType | ( | std::int32_t | type | ) |
set the type of operations specifying how the filter should operate
References addOperations.
void helics::Filter::setOperator | ( | std::shared_ptr< FilterOperator > | filterOp | ) |
set a message operator to process the message
References helics::Interface::handle, helics::Interface::mCore, and helics::Core::setFilterOperator().
|
virtual |
set a string property on a filter
property | the name of the property of the filter to change |
val | the numerical value of the property |
Reimplemented in helics::CloningFilter.
Referenced by helics::CloningFilter::addDeliveryEndpoint(), helicsFilterSetString(), helics::CloningFilter::removeDeliveryEndpoint(), and helics::CloningFilter::setString().
|
friend |
add a defined operation to a filter
Referenced by setFilterType().