helics  2.8.1
MessageFilters.h
Go to the documentation of this file.
1 /*
2 Copyright (c) 2017-2021,
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 "helics.h"
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
55  helics_filter_type type,
56  const char* name,
57  helics_error* err);
58 
74 
90 
106 HELICS_EXPORT helics_filter helicsCoreRegisterFilter(helics_core core, helics_filter_type type, const char* name, helics_error* err);
107 
122 HELICS_EXPORT helics_filter helicsCoreRegisterCloningFilter(helics_core core, const char* name, helics_error* err);
123 
132 
145 HELICS_EXPORT helics_filter helicsFederateGetFilter(helics_federate fed, const char* name, helics_error* err);
158 
166 HELICS_EXPORT helics_bool helicsFilterIsValid(helics_filter filt);
167 
175 HELICS_EXPORT const char* helicsFilterGetName(helics_filter filt);
176 
187 HELICS_EXPORT void helicsFilterSet(helics_filter filt, const char* prop, double val, helics_error* err);
188 
199 HELICS_EXPORT void helicsFilterSetString(helics_filter filt, const char* prop, const char* val, helics_error* err);
200 
211 HELICS_EXPORT void helicsFilterAddDestinationTarget(helics_filter filt, const char* dst, helics_error* err);
212 
224 HELICS_EXPORT void helicsFilterAddSourceTarget(helics_filter filt, const char* source, helics_error* err);
225 
243 HELICS_EXPORT void helicsFilterAddDeliveryEndpoint(helics_filter filt, const char* deliveryEndpoint, helics_error* err);
244 
255 HELICS_EXPORT void helicsFilterRemoveTarget(helics_filter filt, const char* target, helics_error* err);
256 
266 HELICS_EXPORT void helicsFilterRemoveDeliveryEndpoint(helics_filter filt, const char* deliveryEndpoint, helics_error* err);
267 
275 HELICS_EXPORT const char* helicsFilterGetInfo(helics_filter filt);
285 HELICS_EXPORT void helicsFilterSetInfo(helics_filter filt, const char* info, helics_error* err);
286 
298 HELICS_EXPORT void helicsFilterSetOption(helics_filter filt, int option, int value, helics_error* err);
299 
306 HELICS_EXPORT int helicsFilterGetOption(helics_filter filt, int option);
307 
312 #ifdef __cplusplus
313 } /* end of extern "C" { */
314 #endif
315 
316 #endif /* HELICS_APISHARED_MESSAGE_FILTER_FEDERATE_FUNCTIONS_H_*/
helicsFederateRegisterCloningFilter
helics_filter helicsFederateRegisterCloningFilter(helics_federate fed, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:123
helicsFederateRegisterFilter
helics_filter helicsFederateRegisterFilter(helics_federate fed, helics_filter_type type, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:58
helicsFilterGetInfo
const char * helicsFilterGetInfo(helics_filter filt)
Definition: MessageFiltersExport.cpp:409
helicsCoreRegisterFilter
helics_filter helicsCoreRegisterFilter(helics_core core, helics_filter_type type, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:103
helicsFilterSetInfo
void helicsFilterSetInfo(helics_filter filt, const char *info, helics_error *err)
Definition: MessageFiltersExport.cpp:425
helicsCoreRegisterCloningFilter
helics_filter helicsCoreRegisterCloningFilter(helics_core core, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:164
helicsFilterSet
void helicsFilterSet(helics_filter filt, const char *prop, double val, helics_error *err)
Definition: MessageFiltersExport.cpp:294
helicsFilterGetOption
int helicsFilterGetOption(helics_filter filt, int option)
Definition: MessageFiltersExport.cpp:457
helics_core
void * helics_core
Definition: api-data.h:46
helics.h
Common functions for the HELICS C api.
helicsFilterIsValid
helics_bool helicsFilterIsValid(helics_filter filt)
Definition: MessageFiltersExport.cpp:274
helics_filter
void * helics_filter
Definition: api-data.h:41
helicsFilterRemoveDeliveryEndpoint
void helicsFilterRemoveDeliveryEndpoint(helics_filter filt, const char *deliveryEndpoint, helics_error *err)
Definition: MessageFiltersExport.cpp:392
helicsFederateGetFilterByIndex
helics_filter helicsFederateGetFilterByIndex(helics_federate fed, int index, helics_error *err)
Definition: MessageFiltersExport.cpp:224
helicsFilterAddSourceTarget
void helicsFilterAddSourceTarget(helics_filter filt, const char *source, helics_error *err)
Definition: MessageFiltersExport.cpp:341
helics_filter_type
helics_filter_type
Definition: helics_enums.h:308
fed
@ fed
special logging command for message coming from a fed
Definition: loggingHelper.hpp:32
helicsFilterRemoveTarget
void helicsFilterRemoveTarget(helics_filter filt, const char *target, helics_error *err)
Definition: MessageFiltersExport.cpp:375
helicsFilterAddDeliveryEndpoint
void helicsFilterAddDeliveryEndpoint(helics_filter filt, const char *deliveryEndpoint, helics_error *err)
Definition: MessageFiltersExport.cpp:358
helicsFederateGetFilterCount
int helicsFederateGetFilterCount(helics_federate fed)
Definition: MessageFiltersExport.cpp:215
helics_error
Definition: api-data.h:166
helicsFilterAddDestinationTarget
void helicsFilterAddDestinationTarget(helics_filter filt, const char *dst, helics_error *err)
Definition: MessageFiltersExport.cpp:324
helicsFederateRegisterGlobalFilter
helics_filter helicsFederateRegisterGlobalFilter(helics_federate fed, helics_filter_type type, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:79
helicsFederateRegisterGlobalCloningFilter
helics_filter helicsFederateRegisterGlobalCloningFilter(helics_federate fed, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:143
helicsFilterSetString
void helicsFilterSetString(helics_filter filt, const char *prop, const char *val, helics_error *err)
Definition: MessageFiltersExport.cpp:309
helics_bool
int helics_bool
Definition: api-data.h:92
helicsFilterGetName
const char * helicsFilterGetName(helics_filter filt)
Definition: MessageFiltersExport.cpp:284
helicsFilterSetOption
void helicsFilterSetOption(helics_filter filt, int option, int value, helics_error *err)
Definition: MessageFiltersExport.cpp:441
helicsFederateGetFilter
helics_filter helicsFederateGetFilter(helics_federate fed, const char *name, helics_error *err)
Definition: MessageFiltersExport.cpp:187
helics_federate
void * helics_federate
Definition: api-data.h:56