helics  2.8.1
Functions
Default Value functions

Functions

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)
 

Detailed Description

These functions set the default value for a subscription. That is the value returned if nothing was published from elsewhere.

Function Documentation

◆ helicsInputSetDefaultBoolean()

void helicsInputSetDefaultBoolean ( helics_input  ipt,
helics_bool  val,
helics_error err 
)

Set the default as a boolean.

Parameters
iptThe input to set the default for.
valThe default boolean value. @forcpponly
[in,out]errAn 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()

void helicsInputSetDefaultChar ( helics_input  ipt,
char  val,
helics_error err 
)

Set the default as a char.

Parameters
iptThe input to set the default for.
valThe default char value. @forcpponly
[in,out]errAn error object that will contain an error code and string if any error occurred during the execution of the function. @endforcpponly

◆ helicsInputSetDefaultComplex()

void helicsInputSetDefaultComplex ( helics_input  ipt,
double  real,
double  imag,
helics_error err 
)

Set the default as a complex number.

Parameters
iptThe input to set the default for.
realThe default real value.
imagThe default imaginary value. @forcpponly
[in,out]errAn 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()

void helicsInputSetDefaultDouble ( helics_input  ipt,
double  val,
helics_error err 
)

Set the default as a double.

Parameters
iptThe input to set the default for.
valThe default double value. @forcpponly
[in,out]errAn 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()

void helicsInputSetDefaultInteger ( helics_input  ipt,
int64_t  val,
helics_error err 
)

Set the default as an integer.

Parameters
iptThe input to set the default for.
valThe default integer. @forcpponly
[in,out]errAn 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()

void helicsInputSetDefaultNamedPoint ( helics_input  ipt,
const char *  str,
double  val,
helics_error err 
)

Set the default as a NamedPoint.

Parameters
iptThe input to set the default for.
strA pointer to a string representing the name.
valA double value for the value of the named point. @forcpponly
[in,out]errAn error object that will contain an error code and string if any error occurred during the execution of the function. @endforcpponly

◆ helicsInputSetDefaultRaw()

void helicsInputSetDefaultRaw ( helics_input  ipt,
const void *  data,
int  inputDataLength,
helics_error err 
)

Set the default as a raw data array.

Parameters
iptThe input to set the default for.
dataA pointer to the raw data to use for the default. @forcpponly
inputDataLengthThe size of the raw data.
[in,out]errAn 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()

void helicsInputSetDefaultString ( helics_input  ipt,
const char *  str,
helics_error err 
)

Set the default as a string.

Parameters
iptThe input to set the default for.
strA pointer to the default string. @forcpponly
[in,out]errAn 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()

void helicsInputSetDefaultTime ( helics_input  ipt,
helics_time  val,
helics_error err 
)

Set the default as a time.

Parameters
iptThe input to set the default for.
valThe default time value. @forcpponly
[in,out]errAn error object that will contain an error code and string if any error occurred during the execution of the function. @endforcpponly

◆ helicsInputSetDefaultVector()

void helicsInputSetDefaultVector ( helics_input  ipt,
const double *  vectorInput,
int  vectorLength,
helics_error err 
)

Set the default as a vector of doubles.

Parameters
iptThe input to set the default for.
vectorInputA pointer to an array of double data.
vectorLengthThe number of points to publish. @forcpponly
[in,out]errAn 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().