![]() |
helics
2.8.1
|
Data can be returned in a number of formats, for instance if data is published as a double it can be returned as a string and vice versa, not all translations make that much sense but they do work.
helics_bool helicsInputGetBoolean | ( | helics_input | ipt, |
helics_error * | err | ||
) |
Get a boolean value from a subscription.
ipt | The input to get the data for. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
References helics_false, and helics_true.
Referenced by helicscpp::Input::getBoolean().
char helicsInputGetChar | ( | helics_input | ipt, |
helics_error * | err | ||
) |
Get a single character value from an input.
ipt | The input to get the data for. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
void helicsInputGetComplex | ( | helics_input | ipt, |
double * | real, | ||
double * | imag, | ||
helics_error * | err | ||
) |
Get a pair of double forming a complex number from a subscriptions.
ipt | The input to get the data for. @forcpponly | |
[out] | real | Memory location to place the real part of a value. |
[out] | imag | Memory location to place the imaginary part of a value. |
[in,out] | err | An error object that will contain an error code and string if any error occurred during the execution of the function. On error the values will not be altered. @endforcpponly |
@beginPythonOnly
helics_complex helicsInputGetComplexObject | ( | helics_input | ipt, |
helics_error * | err | ||
) |
Get a complex object from an input object.
ipt | The input to get the data for. @forcpponly | |
[in,out] | err | A helics error object, if the object is not empty the function is bypassed otherwise it is filled in if there is an error. @endforcpponly |
References helics_time_invalid.
Referenced by helicscpp::Input::getComplex().
double helicsInputGetDouble | ( | helics_input | ipt, |
helics_error * | err | ||
) |
Get a double value from a subscription.
ipt | The input to get the data for. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
References helics_time_invalid.
Referenced by helicscpp::Input::getDouble().
int64_t helicsInputGetInteger | ( | helics_input | ipt, |
helics_error * | err | ||
) |
Get an integer value from a subscription.
ipt | The input to get the data for. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
Referenced by helicscpp::Input::getInteger().
void helicsInputGetNamedPoint | ( | helics_input | ipt, |
char * | outputString, | ||
int | maxStringLength, | ||
int * | actualLength, | ||
double * | val, | ||
helics_error * | err | ||
) |
Get a named point from a subscription.
ipt | The input to get the result for. @forcpponly | |
[out] | outputString | Storage for copying a null terminated string. |
maxStringLength | The maximum size of information that str can hold. | |
[out] | actualLength | The actual length of the string |
[out] | val | The double value for the named point. |
[in,out] | err | An error object that will contain an error code and string if any error occurred during the execution of the function. @endforcpponly |
@beginPythonOnly
References helics::NamedPoint::name, and helics::NamedPoint::value.
Referenced by helicscpp::Input::getNamedPoint().
void helicsInputGetRawValue | ( | helics_input | ipt, |
void * | data, | ||
int | maxDataLength, | ||
int * | actualSize, | ||
helics_error * | err | ||
) |
Get the raw data for the latest value of a subscription.
ipt | The input to get the data for. @forcpponly | |
[out] | data | The memory location of the data |
maxDataLength | The maximum size of information that data can hold. | |
[out] | actualSize | The actual length of data copied to data. |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
@beginPythonOnly
References data.
Referenced by helicscpp::Input::getRawValue().
int helicsInputGetRawValueSize | ( | helics_input | ipt | ) |
Get the size of the raw value for subscription.
Referenced by helicscpp::Input::getRawValue(), and helicscpp::Input::getRawValueSize().
void helicsInputGetString | ( | helics_input | ipt, |
char * | outputString, | ||
int | maxStringLength, | ||
int * | actualLength, | ||
helics_error * | err | ||
) |
Get a string value from a subscription.
ipt | The input to get the data for. @forcpponly | |
[out] | outputString | Storage for copying a null terminated string. |
maxStringLength | The maximum size of information that str can hold. | |
[out] | actualLength | The actual length of the string. |
[in,out] | err | Error term for capturing errors. @endforcpponly |
@beginPythonOnly
Referenced by helicscpp::Input::getString().
int helicsInputGetStringSize | ( | helics_input | ipt | ) |
Get the size of a value for subscription assuming return as a string.
Referenced by helicscpp::Input::getNamedPoint(), and helicscpp::Input::getString().
helics_time helicsInputGetTime | ( | helics_input | ipt, |
helics_error * | err | ||
) |
Get a time value from a subscription.
ipt | The input to get the data for. @forcpponly | |
[in,out] | err | A pointer to an error object for catching errors. @endforcpponly |
References helics_time_invalid.
void helicsInputGetVector | ( | helics_input | ipt, |
double | data[], | ||
int | maxLength, | ||
int * | actualSize, | ||
helics_error * | err | ||
) |
Get a vector from a subscription.
ipt | The input to get the result for. @forcpponly | |
[out] | data | The location to store the data. |
maxLength | The maximum size of the vector. | |
[out] | actualSize | Location to place the actual length of the resulting vector. |
[in,out] | err | An error object that will contain an error code and string if any error occurred during the execution of the function. @endforcpponly |
@beginPythonOnly
References data.
Referenced by helicscpp::Input::getVector().
int helicsInputGetVectorSize | ( | helics_input | ipt | ) |
Get the size of a value for subscription assuming return as an array of doubles.
Referenced by helicscpp::Input::getVector().