|
void | helicsInputSetDefaultRaw (helics_input ipt, const void *data, int inputDataLength, helics_error *err) |
|
void | helicsInputSetDefaultString (helics_input ipt, const char *str, helics_error *err) |
|
void | helicsInputSetDefaultInteger (helics_input ipt, int64_t val, helics_error *err) |
|
void | helicsInputSetDefaultBoolean (helics_input ipt, helics_bool val, helics_error *err) |
|
void | helicsInputSetDefaultTime (helics_input ipt, helics_time val, helics_error *err) |
|
void | helicsInputSetDefaultChar (helics_input ipt, char val, helics_error *err) |
|
void | helicsInputSetDefaultDouble (helics_input ipt, double val, helics_error *err) |
|
void | helicsInputSetDefaultComplex (helics_input ipt, double real, double imag, helics_error *err) |
|
void | helicsInputSetDefaultVector (helics_input ipt, const double *vectorInput, int vectorLength, helics_error *err) |
|
void | helicsInputSetDefaultNamedPoint (helics_input ipt, const char *str, double val, helics_error *err) |
|
These functions set the default value for a subscription. That is the value returned if nothing was published from elsewhere.
◆ helicsInputSetDefaultBoolean()
Set the default as a boolean.
- Parameters
-
| ipt | The input to set the default for. |
| val | The default boolean value. @forcpponly |
[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 |
References helics_false.
Referenced by helicscpp::Input::setDefault().
◆ helicsInputSetDefaultChar()
Set the default as a char.
- Parameters
-
| ipt | The input to set the default for. |
| val | The default char value. @forcpponly |
[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 |
◆ helicsInputSetDefaultComplex()
Set the default as a complex number.
- Parameters
-
| ipt | The input to set the default for. |
| real | The default real value. |
| imag | The default imaginary value. @forcpponly |
[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 |
Referenced by helicscpp::Input::setDefault().
◆ helicsInputSetDefaultDouble()
Set the default as a double.
- Parameters
-
| ipt | The input to set the default for. |
| val | The default double value. @forcpponly |
[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 |
Referenced by helicscpp::Input::setDefault().
◆ helicsInputSetDefaultInteger()
Set the default as an integer.
- Parameters
-
| ipt | The input to set the default for. |
| val | The default integer. @forcpponly |
[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 |
Referenced by helicscpp::Input::setDefault().
◆ helicsInputSetDefaultNamedPoint()
Set the default as a NamedPoint.
- Parameters
-
| ipt | The input to set the default for. |
| str | A pointer to a string representing the name. |
| val | A double value for the value of the named point. @forcpponly |
[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 |
◆ helicsInputSetDefaultRaw()
Set the default as a raw data array.
- Parameters
-
| ipt | The input to set the default for. |
| data | A pointer to the raw data to use for the default. @forcpponly |
| inputDataLength | The size of the raw data. |
[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 |
References data.
Referenced by helicscpp::Input::setDefault().
◆ helicsInputSetDefaultString()
Set the default as a string.
- Parameters
-
| ipt | The input to set the default for. |
| str | A pointer to the default string. @forcpponly |
[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 |
Referenced by helicscpp::Input::setDefault().
◆ helicsInputSetDefaultTime()
Set the default as a time.
- Parameters
-
| ipt | The input to set the default for. |
| val | The default time value. @forcpponly |
[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 |
◆ helicsInputSetDefaultVector()
Set the default as a vector of doubles.
- Parameters
-
| ipt | The input to set the default for. |
| vectorInput | A pointer to an array of double data. |
| vectorLength | The number of points to publish. @forcpponly |
[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 |
Referenced by helicscpp::Input::setDefault().