![]() |
helics
2.8.1
|
Functions related to message filters for the C api. More...
#include "helics.h"
Go to the source code of this file.
Functions related to message filters for the C api.
helics_filter helicsCoreRegisterCloningFilter | ( | helics_core | core, |
const char * | name, | ||
helics_error * | err | ||
) |
Create a cloning Filter on the specified core.
Cloning filters copy a message and send it to multiple locations, source and destination can be added through other functions.
core | The core to register through. | |
name | The name of the filter (can be NULL). @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Core::registerCloningFilter().
helics_filter helicsCoreRegisterFilter | ( | helics_core | core, |
helics_filter_type | type, | ||
const char * | name, | ||
helics_error * | err | ||
) |
Create a source Filter on the specified core.
Filters can be created through a federate or a core, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior.
core | The core to register through. | |
type | The type of filter to create /ref helics_filter_type. | |
name | The name of the filter (can be NULL). @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Core::registerFilter().
helics_filter helicsFederateGetFilter | ( | helics_federate | fed, |
const char * | name, | ||
helics_error * | err | ||
) |
Get a filter by its name, typically already created via registerInterfaces file or something of that nature.
fed | The federate object to use to get the filter. | |
name | The name of the filter. @forcpponly | |
[in,out] | err | The error object to complete if there is an error. @endforcpponly |
Referenced by helicscpp::Federate::getFilter().
helics_filter helicsFederateGetFilterByIndex | ( | helics_federate | fed, |
int | index, | ||
helics_error * | err | ||
) |
Get a filter by its index, typically already created via registerInterfaces file or something of that nature.
fed | The federate object in which to create a publication. | |
index | The index of the publication to get. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Federate::getFilter().
int helicsFederateGetFilterCount | ( | helics_federate | fed | ) |
Get the number of filters registered through a federate.
fed | The federate object to use to get the filter. |
helics_filter helicsFederateRegisterCloningFilter | ( | helics_federate | fed, |
const char * | name, | ||
helics_error * | err | ||
) |
Create a cloning Filter on the specified federate.
Cloning filters copy a message and send it to multiple locations, source and destination can be added through other functions.
fed | The federate to register through. | |
name | The name of the filter (can be NULL). @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Federate::registerCloningFilter().
helics_filter helicsFederateRegisterFilter | ( | helics_federate | fed, |
helics_filter_type | type, | ||
const char * | name, | ||
helics_error * | err | ||
) |
Create a source Filter on the specified federate.
Filters can be created through a federate or a core, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior
fed | The federate to register through. | |
type | The type of filter to create /ref helics_filter_type. | |
name | The name of the filter (can be NULL). @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Federate::registerFilter().
helics_filter helicsFederateRegisterGlobalCloningFilter | ( | helics_federate | fed, |
const char * | name, | ||
helics_error * | err | ||
) |
Create a global cloning Filter on the specified federate.
Cloning filters copy a message and send it to multiple locations, source and destination can be added through other functions.
fed | The federate to register through. | |
name | The name of the filter (can be NULL). @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Federate::registerGlobalCloningFilter().
helics_filter helicsFederateRegisterGlobalFilter | ( | helics_federate | fed, |
helics_filter_type | type, | ||
const char * | name, | ||
helics_error * | err | ||
) |
Create a global source filter through a federate.
Filters can be created through a federate or a core, linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior.
fed | The federate to register through. | |
type | The type of filter to create /ref helics_filter_type. | |
name | The name of the filter (can be NULL). @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Federate::registerGlobalFilter().
void helicsFilterAddDestinationTarget | ( | helics_filter | filt, |
const char * | dst, | ||
helics_error * | err | ||
) |
Add a destination target to a filter.
All messages going to a destination are copied to the delivery address(es).
filt | The given filter to add a destination target to. | |
dst | The name of the endpoint to add as a destination target. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Filter::addDestinationTarget().
void helicsFilterAddSourceTarget | ( | helics_filter | filt, |
const char * | source, | ||
helics_error * | err | ||
) |
Add a source target to a filter.
All messages coming from a source are copied to the delivery address(es).
filt | The given filter. | |
source | The name of the endpoint to add as a source target. @forcpponly. | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Filter::addSourceTarget().
const char* helicsFilterGetName | ( | helics_filter | filt | ) |
Get the name of the filter and store in the given string.
filt | The given filter. |
get the name of the filter
Referenced by helicscpp::Filter::getName().
helics_bool helicsFilterIsValid | ( | helics_filter | filt | ) |
Check if a filter is valid.
filt | The filter object to check. |
Referenced by helicscpp::Filter::isValid().
void helicsFilterSet | ( | helics_filter | filt, |
const char * | prop, | ||
double | val, | ||
helics_error * | err | ||
) |
Set a property on a filter.
filt | The filter to modify. | |
prop | A string containing the property to set. | |
val | A numerical value for the property. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Filter::set().
void helicsFilterSetString | ( | helics_filter | filt, |
const char * | prop, | ||
const char * | val, | ||
helics_error * | err | ||
) |
Set a string property on a filter.
filt | The filter to modify. | |
prop | A string containing the property to set. | |
val | A string containing the new value. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Filter::setString().