helics  2.8.1
Public Member Functions | Protected Attributes | List of all members
helicscpp::Filter Class Reference

#include <Filter.hpp>

+ Inheritance diagram for helicscpp::Filter:

Public Member Functions

 Filter (helics_filter hfilt) HELICS_NOTHROW
 
 Filter () HELICS_NOTHROW
 
 Filter (const Filter &filter)
 
Filteroperator= (const Filter &filter)
 
 operator helics_filter () const
 
helics_filter 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)
 

Protected Attributes

helics_filter filt
 the reference to the underlying publication
 

Detailed Description

object managing a filter in the C++98 interface

Constructor & Destructor Documentation

◆ Filter() [1/3]

helicscpp::Filter::Filter ( helics_filter  hfilt)
inlineexplicit

construct from C level helics_filter object

◆ Filter() [2/3]

helicscpp::Filter::Filter ( )
inline

default constructor

◆ Filter() [3/3]

helicscpp::Filter::Filter ( const Filter filter)
inline

copy constructor

Member Function Documentation

◆ addDestinationTarget()

void helicscpp::Filter::addDestinationTarget ( const std::string &  dest)
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().

◆ addSourceTarget()

void helicscpp::Filter::addSourceTarget ( const std::string &  source)
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().

◆ baseObject()

helics_filter helicscpp::Filter::baseObject ( ) const
inline

get the underlying helics_filter object

References filt.

◆ getInfo()

const char* helicscpp::Filter::getInfo ( ) const
inline

get the interface information field of the filter

References filt, and helicsFilterGetInfo().

◆ getName()

const char* helicscpp::Filter::getName ( ) const
inline

get the name for the filter

References filt, and helicsFilterGetName().

◆ isValid()

bool helicscpp::Filter::isValid ( ) const
inline

check if the filter is valid

References filt, helics_true, and helicsFilterIsValid().

◆ operator helics_filter()

helicscpp::Filter::operator helics_filter ( ) const
inline

cast operator to get the underlying object

References filt.

◆ operator=()

Filter& helicscpp::Filter::operator= ( const Filter filter)
inline

copy assignment

References filt.

Referenced by helicscpp::CloningFilter::operator=().

◆ removeTarget()

void helicscpp::Filter::removeTarget ( const std::string &  dest)
inline

remove a destination target from a cloning filter

References filt, and helicsFilterRemoveTarget().

◆ set()

void helicscpp::Filter::set ( const std::string &  property,
double  val 
)
inline

set a property on a filter

Parameters
propertythe name of the property of the filter to change
valthe numerical value of the property

References filt, and helicsFilterSet().

◆ setInfo()

void helicscpp::Filter::setInfo ( const std::string &  info)
inline

set the interface information field of the filter

References filt, and helicsFilterSetInfo().

◆ setString()

void helicscpp::Filter::setString ( const std::string &  property,
const std::string &  val 
)
inline

set a string property on a filter

Parameters
propertythe name of the property of the filter to change
valthe numerical value of the property

References filt, and helicsFilterSetString().


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