| helics 3.6.1

MessageFilters.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2025,
3 Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC. See the top-level NOTICE for
4 additional details. All rights reserved.
5 SPDX-License-Identifier: BSD-3-Clause
6 */
7
14 #ifndef HELICS_APISHARED_MESSAGE_FILTER_FEDERATE_FUNCTIONS_H_
15 #define HELICS_APISHARED_MESSAGE_FILTER_FEDERATE_FUNCTIONS_H_
16
17 #include "helicsCore.h"
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
38 HELICS_EXPORT HelicsFilter helicsFederateRegisterFilter(HelicsFederate fed, HelicsFilterTypes type, const char* name, HelicsError* err);
54 HELICS_EXPORT HelicsFilter helicsFederateRegisterGlobalFilter(HelicsFederate fed,
55 HelicsFilterTypes type,
56 const char* name,
57 HelicsError* err);
58
73 HELICS_EXPORT HelicsFilter helicsFederateRegisterCloningFilter(HelicsFederate fed, const char* name, HelicsError* err);
74
89 HELICS_EXPORT HelicsFilter helicsFederateRegisterGlobalCloningFilter(HelicsFederate fed, const char* name, HelicsError* err);
90
106 HELICS_EXPORT HelicsFilter helicsCoreRegisterFilter(HelicsCore core, HelicsFilterTypes type, const char* name, HelicsError* err);
107
122 HELICS_EXPORT HelicsFilter helicsCoreRegisterCloningFilter(HelicsCore core, const char* name, HelicsError* err);
123
131 HELICS_EXPORT int helicsFederateGetFilterCount(HelicsFederate fed);
132
145 HELICS_EXPORT HelicsFilter helicsFederateGetFilter(HelicsFederate fed, const char* name, HelicsError* err);
157 HELICS_EXPORT HelicsFilter helicsFederateGetFilterByIndex(HelicsFederate fed, int index, HelicsError* err);
158
166 HELICS_EXPORT HelicsBool helicsFilterIsValid(HelicsFilter filt);
167
175 HELICS_EXPORT const char* helicsFilterGetName(HelicsFilter filt);
176
187 HELICS_EXPORT void helicsFilterSet(HelicsFilter filt, const char* prop, double val, HelicsError* err);
188
199 HELICS_EXPORT void helicsFilterSetString(HelicsFilter filt, const char* prop, const char* val, HelicsError* err);
200
208 HELICS_EXPORT double helicsFilterGetPropertyDouble(HelicsFilter filt, const char* prop);
209
219 HELICS_EXPORT const char* helicsFilterGetPropertyString(HelicsFilter filt, const char* prop);
220
231 HELICS_EXPORT void helicsFilterAddDestinationTarget(HelicsFilter filt, const char* dst, HelicsError* err);
232
244 HELICS_EXPORT void helicsFilterAddSourceTarget(HelicsFilter filt, const char* source, HelicsError* err);
245
263 HELICS_EXPORT void helicsFilterAddDeliveryEndpoint(HelicsFilter filt, const char* deliveryEndpoint, HelicsError* err);
264
275 HELICS_EXPORT void helicsFilterRemoveTarget(HelicsFilter filt, const char* target, HelicsError* err);
276
286 HELICS_EXPORT void helicsFilterRemoveDeliveryEndpoint(HelicsFilter filt, const char* deliveryEndpoint, HelicsError* err);
287
295 HELICS_EXPORT const char* helicsFilterGetInfo(HelicsFilter filt);
305 HELICS_EXPORT void helicsFilterSetInfo(HelicsFilter filt, const char* info, HelicsError* err);
306
314 HELICS_EXPORT const char* helicsFilterGetTag(HelicsFilter filt, const char* tagname);
315
326 HELICS_EXPORT void helicsFilterSetTag(HelicsFilter filt, const char* tagname, const char* tagvalue, HelicsError* err);
327
339 HELICS_EXPORT void helicsFilterSetOption(HelicsFilter filt, int option, int value, HelicsError* err);
340
347 HELICS_EXPORT int helicsFilterGetOption(HelicsFilter filt, int option);
348
353 #ifdef __cplusplus
354 } /* end of extern "C" { */
355 #endif
356
357 #endif /* HELICS_APISHARED_MESSAGE_FILTER_FEDERATE_FUNCTIONS_H_*/
helicsCoreRegisterCloningFilter
HelicsFilter helicsCoreRegisterCloningFilter(HelicsCore core, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:208
helicsFederateRegisterCloningFilter
HelicsFilter helicsFederateRegisterCloningFilter(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:167
helicsFederateGetFilterCount
int helicsFederateGetFilterCount(HelicsFederate fed)
Definition: MessageFiltersExport.cpp:255
helicsFilterGetPropertyDouble
double helicsFilterGetPropertyDouble(HelicsFilter filt, const char *prop)
Definition: MessageFiltersExport.cpp:361
helicsFilterSetString
void helicsFilterSetString(HelicsFilter filt, const char *prop, const char *val, HelicsError *err)
Definition: MessageFiltersExport.cpp:346
helicsFilterGetName
const char * helicsFilterGetName(HelicsFilter filt)
Definition: MessageFiltersExport.cpp:321
helicsCoreRegisterFilter
HelicsFilter helicsCoreRegisterFilter(HelicsCore core, HelicsFilterTypes type, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:147
helicsFilterAddSourceTarget
void helicsFilterAddSourceTarget(HelicsFilter filt, const char *source, HelicsError *err)
Definition: MessageFiltersExport.cpp:412
helicsFederateRegisterGlobalCloningFilter
HelicsFilter helicsFederateRegisterGlobalCloningFilter(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:187
helicsFilterGetPropertyString
const char * helicsFilterGetPropertyString(HelicsFilter filt, const char *prop)
Definition: MessageFiltersExport.cpp:375
helicsFederateGetFilterByIndex
HelicsFilter helicsFederateGetFilterByIndex(HelicsFederate fed, int index, HelicsError *err)
Definition: MessageFiltersExport.cpp:264
helicsFederateGetFilter
HelicsFilter helicsFederateGetFilter(HelicsFederate fed, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:231
helicsFilterAddDestinationTarget
void helicsFilterAddDestinationTarget(HelicsFilter filt, const char *dst, HelicsError *err)
Definition: MessageFiltersExport.cpp:395
helicsFederateRegisterGlobalFilter
HelicsFilter helicsFederateRegisterGlobalFilter(HelicsFederate fed, HelicsFilterTypes type, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:124
helicsFederateRegisterFilter
HelicsFilter helicsFederateRegisterFilter(HelicsFederate fed, HelicsFilterTypes type, const char *name, HelicsError *err)
Definition: MessageFiltersExport.cpp:103
helicsFilterIsValid
HelicsBool helicsFilterIsValid(HelicsFilter filt)
Definition: MessageFiltersExport.cpp:311
helicsFilterSet
void helicsFilterSet(HelicsFilter filt, const char *prop, double val, HelicsError *err)
Definition: MessageFiltersExport.cpp:331
HelicsCore
void * HelicsCore
Definition: api-data.h:54
HelicsFilter
void * HelicsFilter
Definition: api-data.h:43
HelicsBool
int HelicsBool
Definition: api-data.h:118
HelicsFederate
void * HelicsFederate
Definition: api-data.h:65
helicsFilterAddDeliveryEndpoint
void helicsFilterAddDeliveryEndpoint(HelicsFilter filt, const char *deliveryEndpoint, HelicsError *err)
Definition: MessageFiltersExport.cpp:429
helicsFilterRemoveTarget
void helicsFilterRemoveTarget(HelicsFilter filt, const char *target, HelicsError *err)
Definition: MessageFiltersExport.cpp:446
helicsFilterGetInfo
const char * helicsFilterGetInfo(HelicsFilter filt)
Definition: MessageFiltersExport.cpp:480
helicsFilterSetTag
void helicsFilterSetTag(HelicsFilter filt, const char *tagname, const char *tagvalue, HelicsError *err)
Definition: MessageFiltersExport.cpp:530
helicsFilterGetOption
int helicsFilterGetOption(HelicsFilter filt, int option)
Definition: MessageFiltersExport.cpp:562
helicsFilterRemoveDeliveryEndpoint
void helicsFilterRemoveDeliveryEndpoint(HelicsFilter filt, const char *deliveryEndpoint, HelicsError *err)
Definition: MessageFiltersExport.cpp:463
helicsFilterSetOption
void helicsFilterSetOption(HelicsFilter filt, int option, int value, HelicsError *err)
Definition: MessageFiltersExport.cpp:546
helicsFilterGetTag
const char * helicsFilterGetTag(HelicsFilter filt, const char *tagname)
Definition: MessageFiltersExport.cpp:513
helicsFilterSetInfo
void helicsFilterSetInfo(HelicsFilter filt, const char *info, HelicsError *err)
Definition: MessageFiltersExport.cpp:497
helicsCore.h
Common functions for the HELICS C api.
HelicsFilterTypes
HelicsFilterTypes
Definition: helics_enums.h:391
HelicsError
Definition: api-data.h:177