helics  2.8.1
Functions
filter functions

Functions

void helicsFilterAddDeliveryEndpoint (helics_filter filt, const char *deliveryEndpoint, helics_error *err)
 
void helicsFilterRemoveTarget (helics_filter filt, const char *target, helics_error *err)
 
void helicsFilterRemoveDeliveryEndpoint (helics_filter filt, const char *deliveryEndpoint, helics_error *err)
 
const char * helicsFilterGetInfo (helics_filter filt)
 
void helicsFilterSetInfo (helics_filter filt, const char *info, helics_error *err)
 
void helicsFilterSetOption (helics_filter filt, int option, int value, helics_error *err)
 
int helicsFilterGetOption (helics_filter filt, int option)
 

Detailed Description

Functions that manipulate cloning filters in some way.

Function Documentation

◆ helicsFilterAddDeliveryEndpoint()

void helicsFilterAddDeliveryEndpoint ( helics_filter  filt,
const char *  deliveryEndpoint,
helics_error err 
)

Add a delivery endpoint to a cloning filter.

All cloned messages are sent to the delivery address(es).

Parameters
filtThe given filter.
deliveryEndpointThe name of the endpoint to deliver messages to. @forcpponly
[in,out]errA pointer to an error object for catching errors. @endforcpponly

Referenced by helicscpp::CloningFilter::addDeliveryEndpoint().

◆ helicsFilterGetInfo()

const char* helicsFilterGetInfo ( helics_filter  filt)

Get the data in the info field of a filter.

Parameters
filtThe given filter.
Returns
A string with the info field string.

Referenced by helicscpp::Filter::getInfo().

◆ helicsFilterGetOption()

int helicsFilterGetOption ( helics_filter  filt,
int  option 
)

Get a handle option for the filter.

Parameters
filtThe given filter to query.
optionThe option to query /ref helics_handle_options.

◆ helicsFilterRemoveDeliveryEndpoint()

void helicsFilterRemoveDeliveryEndpoint ( helics_filter  filt,
const char *  deliveryEndpoint,
helics_error err 
)

Remove a delivery destination from a cloning filter.

Parameters
filtThe given filter (must be a cloning filter).
deliveryEndpointA string with the delivery endpoint to remove. @forcpponly
[in,out]errA pointer to an error object for catching errors. @endforcpponly

Referenced by helicscpp::CloningFilter::removeDeliveryEndpoint().

◆ helicsFilterRemoveTarget()

void helicsFilterRemoveTarget ( helics_filter  filt,
const char *  target,
helics_error err 
)

Remove a destination target from a filter.

Parameters
filtThe given filter.
targetThe named endpoint to remove as a target. @forcpponly @forcpponly
[in,out]errA pointer to an error object for catching errors. @endforcpponly

Referenced by helicscpp::Filter::removeTarget().

◆ helicsFilterSetInfo()

void helicsFilterSetInfo ( helics_filter  filt,
const char *  info,
helics_error err 
)

Set the data in the info field for a filter.

Parameters
filtThe given filter.
infoThe string to set. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

Referenced by helicscpp::Filter::setInfo().

◆ helicsFilterSetOption()

void helicsFilterSetOption ( helics_filter  filt,
int  option,
int  value,
helics_error err 
)

Set the data in the info field for a filter.

Parameters
filtThe given filter.
optionThe option to set /ref helics_handle_options.
valueThe value of the option commonly 0 for false 1 for true. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly