![]() |
helics
2.8.1
|
const char* helicsInputGetExtractionUnits | ( | helics_input | ipt | ) |
Get the units of an input.
The same as helicsInputGetUnits.
ipt | The input to query. |
Referenced by helicscpp::Input::getUnits(), and helicsInputGetUnits().
const char* helicsInputGetInfo | ( | helics_input | inp | ) |
Get the data in the info field of an input.
inp | The input to query. |
Referenced by helicscpp::Input::getInfo().
const char* helicsInputGetInjectionUnits | ( | helics_input | ipt | ) |
Get the units of the publication that an input is linked to.
ipt | The input to query. |
Referenced by helicscpp::Input::getInjectionUnits().
const char* helicsInputGetKey | ( | helics_input | ipt | ) |
Get the key of an input.
ipt | The input to query. |
Referenced by helicscpp::Input::getKey().
int helicsInputGetOption | ( | helics_input | inp, |
int | option | ||
) |
Get the current value of an input handle option
inp | The input to query. |
option | Integer representation of the option in question see /ref helics_handle_options. |
References helics_false.
const char* helicsInputGetPublicationType | ( | helics_input | ipt | ) |
Get the type the publisher to an input is sending.
ipt | The input to query. |
Referenced by helicscpp::Input::getPublicationType().
const char* helicsInputGetType | ( | helics_input | ipt | ) |
Get the type of an input.
ipt | The input to query. |
Referenced by helicscpp::Input::getType().
const char* helicsInputGetUnits | ( | helics_input | ipt | ) |
Get the units of an input.
ipt | The input to query. |
References helicsInputGetExtractionUnits().
void helicsInputSetInfo | ( | helics_input | inp, |
const char * | info, | ||
helics_error * | err | ||
) |
Set the data in the info field for an input.
inp | The input to query. | |
info | The string to set. @forcpponly | |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
Referenced by helicscpp::Input::setInfo().
void helicsInputSetMinimumChange | ( | helics_input | inp, |
double | tolerance, | ||
helics_error * | err | ||
) |
Set the minimum change detection tolerance.
inp | The input to modify. | |
tolerance | The tolerance level for registering an update, values changing less than this value will not show as being updated. @forcpponly | |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
void helicsInputSetOption | ( | helics_input | inp, |
int | option, | ||
int | value, | ||
helics_error * | err | ||
) |
Set an option on an input
inp | The input to query. | |
option | The option to set for the input /ref helics_handle_options. | |
value | The value to set the option to. @forcpponly | |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
const char* helicsPublicationGetInfo | ( | helics_publication | pub | ) |
Get the data in the info field of an publication.
pub | The publication to query. |
Referenced by helicscpp::Publication::getInfo().
const char* helicsPublicationGetKey | ( | helics_publication | pub | ) |
Get the key of a publication.
This will be the global key used to identify the publication to the federation.
pub | The publication to query. |
Referenced by helicscpp::Publication::getKey().
int helicsPublicationGetOption | ( | helics_publication | pub, |
int | option | ||
) |
Get the value of an option for a publication
pub | The publication to query. |
option | The value to query see /ref helics_handle_options. |
References helics_false.
const char* helicsPublicationGetType | ( | helics_publication | pub | ) |
Get the type of a publication.
pub | The publication to query. |
Referenced by helicscpp::Publication::getType().
const char* helicsPublicationGetUnits | ( | helics_publication | pub | ) |
Get the units of a publication.
pub | The publication to query. |
Referenced by helicscpp::Publication::getUnits().
void helicsPublicationSetInfo | ( | helics_publication | pub, |
const char * | info, | ||
helics_error * | err | ||
) |
Set the data in the info field for a publication.
pub | The publication to set the info field for. | |
info | The string to set. @forcpponly | |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
Referenced by helicscpp::Publication::setInfo().
void helicsPublicationSetMinimumChange | ( | helics_publication | pub, |
double | tolerance, | ||
helics_error * | err | ||
) |
Set the minimum change detection tolerance.
pub | The publication to modify. | |
tolerance | The tolerance level for publication, values changing less than this value will not be published. @forcpponly | |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
void helicsPublicationSetOption | ( | helics_publication | pub, |
int | option, | ||
int | val, | ||
helics_error * | err | ||
) |
Set the value of an option for a publication
pub | The publication to query. | |
option | Integer code for the option to set /ref helics_handle_options. | |
val | The value to set the option to. @forcpponly | |
[in,out] | err | An error object to fill out in case of an error. @endforcpponly |
const char* helicsSubscriptionGetKey | ( | helics_input | ipt | ) |
Get the key of a subscription.
Referenced by helicscpp::Input::getTarget().