helics
3.5.2
|
#include <Filter.hpp>
Public Member Functions | |
Filter (HelicsFilter hfilt) HELICS_NOTHROW | |
Filter () HELICS_NOTHROW | |
Filter (const Filter &filter) | |
Filter & | operator= (const Filter &filter) |
operator HelicsFilter () const | |
HelicsFilter | baseObject () const |
bool | isValid () const |
const char * | getName () const |
void | set (const std::string &property, double val) |
void | setString (const std::string &property, const std::string &val) |
void | addDestinationTarget (const std::string &dest) |
void | addSourceTarget (const std::string &source) |
void | removeTarget (const std::string &dest) |
const char * | getInfo () const |
void | setInfo (const std::string &info) |
const char * | getTag (const std::string &tagname) const |
void | setTag (const std::string &tagname, const std::string &tagvalue) |
void | setOption (int32_t option, int32_t value=1) |
int32_t | getOption (int32_t option) |
void | setCallback (HelicsMessage(*filtCall)(HelicsMessage message, void *userData), void *userData) |
Protected Attributes | |
HelicsFilter | filt |
the reference to the underlying publication | |
object managing a filter in the C++98 interface
|
inlineexplicit |
construct from C level HelicsFilter object
|
inline |
default constructor
|
inline |
copy constructor
|
inline |
add a destination target to a cloning filter
all messages going to a destination are copied to the delivery address(es)
References filt, and helicsFilterAddDestinationTarget().
|
inline |
add a source target to a cloning filter
all messages coming from a source are copied to the delivery address(es)
References filt, and helicsFilterAddSourceTarget().
|
inline |
get the underlying HelicsFilter object
References filt.
|
inline |
get the interface information field of the filter
References filt, and helicsFilterGetInfo().
|
inline |
get the name for the filter
References filt, and helicsFilterGetName().
|
inline |
get the value of a tag for the filter
References filt, and helicsFilterGetTag().
|
inline |
check if the filter is valid
References filt, HELICS_TRUE, and helicsFilterIsValid().
|
inline |
cast operator to get the underlying object
References filt.
|
inline |
remove a destination target from a cloning filter
References filt, and helicsFilterRemoveTarget().
|
inline |
set a property on a filter
property | the name of the property of the filter to change |
val | the numerical value of the property |
References filt, and helicsFilterSet().
|
inline |
set the interface information field of the filter
References filt, and helicsFilterSetInfo().
|
inline |
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 |
References filt, and helicsFilterSetString().
|
inline |
set the value of a tag for the filter
References filt, and helicsFilterSetTag().