|
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) |
|
Functions that manipulate cloning filters in some way.
◆ helicsFilterAddDeliveryEndpoint()
Add a delivery endpoint to a cloning filter.
All cloned messages are sent to the delivery address(es).
- Parameters
-
| filt | The given filter. |
| deliveryEndpoint | The name of the endpoint to deliver messages to. @forcpponly |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::CloningFilter::addDeliveryEndpoint().
◆ helicsFilterGetInfo()
Get the data in the info field of a filter.
- Parameters
-
- Returns
- A string with the info field string.
Referenced by helicscpp::Filter::getInfo().
◆ helicsFilterGetOption()
Get a handle option for the filter.
- Parameters
-
filt | The given filter to query. |
option | The option to query /ref helics_handle_options. |
◆ helicsFilterRemoveDeliveryEndpoint()
Remove a delivery destination from a cloning filter.
- Parameters
-
| filt | The given filter (must be a cloning filter). |
| deliveryEndpoint | A string with the delivery endpoint to remove. @forcpponly |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::CloningFilter::removeDeliveryEndpoint().
◆ helicsFilterRemoveTarget()
Remove a destination target from a filter.
- Parameters
-
| filt | The given filter. |
| target | The named endpoint to remove as a target. @forcpponly @forcpponly |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Filter::removeTarget().
◆ helicsFilterSetInfo()
Set the data in the info field for a filter.
- Parameters
-
| filt | The given filter. |
| info | The string to set. @forcpponly |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
Referenced by helicscpp::Filter::setInfo().
◆ helicsFilterSetOption()
Set the data in the info field for a filter.
- Parameters
-
| filt | The given filter. |
| option | The option to set /ref helics_handle_options. |
| value | The value of the option commonly 0 for false 1 for true. @forcpponly |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |