helics  3.0.1
Functions
filter functions

Functions

void helicsFilterAddDeliveryEndpoint (HelicsFilter filt, const char *deliveryEndpoint, HelicsError *err)
 
void helicsFilterRemoveTarget (HelicsFilter filt, const char *target, HelicsError *err)
 
void helicsFilterRemoveDeliveryEndpoint (HelicsFilter filt, const char *deliveryEndpoint, HelicsError *err)
 
const char * helicsFilterGetInfo (HelicsFilter filt)
 
void helicsFilterSetInfo (HelicsFilter filt, const char *info, HelicsError *err)
 
const char * helicsFilterGetTag (HelicsFilter filt, const char *tagname)
 
void helicsFilterSetTag (HelicsFilter filt, const char *tagname, const char *tagvalue, HelicsError *err)
 
void helicsFilterSetOption (HelicsFilter filt, int option, int value, HelicsError *err)
 
int helicsFilterGetOption (HelicsFilter filt, int option)
 

Detailed Description

Functions that manipulate cloning filters in some way.

Function Documentation

◆ helicsFilterAddDeliveryEndpoint()

void helicsFilterAddDeliveryEndpoint ( HelicsFilter  filt,
const char *  deliveryEndpoint,
HelicsError 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.
[in,out]errA pointer to an error object for catching errors.

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

◆ helicsFilterGetInfo()

const char* helicsFilterGetInfo ( HelicsFilter  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 ( HelicsFilter  filt,
int  option 
)

Get a handle option for the filter.

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

◆ helicsFilterGetTag()

const char* helicsFilterGetTag ( HelicsFilter  filt,
const char *  tagname 
)

Get the data in a specified tag of a filter.

Parameters
filtThe filter to query.
tagnameThe name of the tag to query.
Returns
A string with the tag data.

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

◆ helicsFilterRemoveDeliveryEndpoint()

void helicsFilterRemoveDeliveryEndpoint ( HelicsFilter  filt,
const char *  deliveryEndpoint,
HelicsError 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.
[in,out]errA pointer to an error object for catching errors.

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

◆ helicsFilterRemoveTarget()

void helicsFilterRemoveTarget ( HelicsFilter  filt,
const char *  target,
HelicsError err 
)

Remove a destination target from a filter.

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

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

◆ helicsFilterSetInfo()

void helicsFilterSetInfo ( HelicsFilter  filt,
const char *  info,
HelicsError err 
)

Set the data in the info field for a filter.

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

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

◆ helicsFilterSetOption()

void helicsFilterSetOption ( HelicsFilter  filt,
int  option,
int  value,
HelicsError err 
)

Set an option value 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.
[in,out]errAn error object to fill out in case of an error.

◆ helicsFilterSetTag()

void helicsFilterSetTag ( HelicsFilter  filt,
const char *  tagname,
const char *  tagvalue,
HelicsError err 
)

Set the data in a specific tag for a filter.

Parameters
filtThe filter object to set the tag for.
tagnameThe string to set.
tagvaluethe string value to associate with a tag.
[in,out]errAn error object to fill out in case of an error.

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