helics  2.8.1
Functions
retrieval

Functions

const char * helicsInputGetType (helics_input ipt)
 
const char * helicsInputGetPublicationType (helics_input ipt)
 
const char * helicsPublicationGetType (helics_publication pub)
 
const char * helicsInputGetKey (helics_input ipt)
 
const char * helicsSubscriptionGetKey (helics_input ipt)
 
const char * helicsPublicationGetKey (helics_publication pub)
 
const char * helicsInputGetUnits (helics_input ipt)
 
const char * helicsInputGetInjectionUnits (helics_input ipt)
 
const char * helicsInputGetExtractionUnits (helics_input ipt)
 
const char * helicsPublicationGetUnits (helics_publication pub)
 
const char * helicsInputGetInfo (helics_input inp)
 
void helicsInputSetInfo (helics_input inp, const char *info, helics_error *err)
 
const char * helicsPublicationGetInfo (helics_publication pub)
 
void helicsPublicationSetInfo (helics_publication pub, const char *info, helics_error *err)
 
int helicsInputGetOption (helics_input inp, int option)
 
void helicsInputSetOption (helics_input inp, int option, int value, helics_error *err)
 
int helicsPublicationGetOption (helics_publication pub, int option)
 
void helicsPublicationSetOption (helics_publication pub, int option, int val, helics_error *err)
 
void helicsPublicationSetMinimumChange (helics_publication pub, double tolerance, helics_error *err)
 
void helicsInputSetMinimumChange (helics_input inp, double tolerance, helics_error *err)
 

Detailed Description

Function Documentation

◆ helicsInputGetExtractionUnits()

const char* helicsInputGetExtractionUnits ( helics_input  ipt)

Get the units of an input.

The same as helicsInputGetUnits.

Parameters
iptThe input to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Input::getUnits(), and helicsInputGetUnits().

◆ helicsInputGetInfo()

const char* helicsInputGetInfo ( helics_input  inp)

Get the data in the info field of an input.

Parameters
inpThe input to query.
Returns
A string with the info field string.

Referenced by helicscpp::Input::getInfo().

◆ helicsInputGetInjectionUnits()

const char* helicsInputGetInjectionUnits ( helics_input  ipt)

Get the units of the publication that an input is linked to.

Parameters
iptThe input to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Input::getInjectionUnits().

◆ helicsInputGetKey()

const char* helicsInputGetKey ( helics_input  ipt)

Get the key of an input.

Parameters
iptThe input to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Input::getKey().

◆ helicsInputGetOption()

int helicsInputGetOption ( helics_input  inp,
int  option 
)

Get the current value of an input handle option

Parameters
inpThe input to query.
optionInteger representation of the option in question see /ref helics_handle_options.
Returns
An integer value with the current value of the given option.

References helics_false.

◆ helicsInputGetPublicationType()

const char* helicsInputGetPublicationType ( helics_input  ipt)

Get the type the publisher to an input is sending.

Parameters
iptThe input to query.
Returns
A const char * with the type name.

Referenced by helicscpp::Input::getPublicationType().

◆ helicsInputGetType()

const char* helicsInputGetType ( helics_input  ipt)

Get the type of an input.

Parameters
iptThe input to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Input::getType().

◆ helicsInputGetUnits()

const char* helicsInputGetUnits ( helics_input  ipt)

Get the units of an input.

Parameters
iptThe input to query.
Returns
A void enumeration, helics_ok if everything worked.

References helicsInputGetExtractionUnits().

◆ helicsInputSetInfo()

void helicsInputSetInfo ( helics_input  inp,
const char *  info,
helics_error err 
)

Set the data in the info field for an input.

Parameters
inpThe input to query.
infoThe string to set. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

Referenced by helicscpp::Input::setInfo().

◆ helicsInputSetMinimumChange()

void helicsInputSetMinimumChange ( helics_input  inp,
double  tolerance,
helics_error err 
)

Set the minimum change detection tolerance.

Parameters
inpThe input to modify.
toleranceThe tolerance level for registering an update, values changing less than this value will not show as being updated. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

◆ helicsInputSetOption()

void helicsInputSetOption ( helics_input  inp,
int  option,
int  value,
helics_error err 
)

Set an option on an input

Parameters
inpThe input to query.
optionThe option to set for the input /ref helics_handle_options.
valueThe value to set the option to. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

◆ helicsPublicationGetInfo()

const char* helicsPublicationGetInfo ( helics_publication  pub)

Get the data in the info field of an publication.

Parameters
pubThe publication to query.
Returns
A string with the info field string.

Referenced by helicscpp::Publication::getInfo().

◆ helicsPublicationGetKey()

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.

Parameters
pubThe publication to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Publication::getKey().

◆ helicsPublicationGetOption()

int helicsPublicationGetOption ( helics_publication  pub,
int  option 
)

Get the value of an option for a publication

Parameters
pubThe publication to query.
optionThe value to query see /ref helics_handle_options.
Returns
A string with the info field string.

References helics_false.

◆ helicsPublicationGetType()

const char* helicsPublicationGetType ( helics_publication  pub)

Get the type of a publication.

Parameters
pubThe publication to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Publication::getType().

◆ helicsPublicationGetUnits()

const char* helicsPublicationGetUnits ( helics_publication  pub)

Get the units of a publication.

Parameters
pubThe publication to query.
Returns
A void enumeration, helics_ok if everything worked.

Referenced by helicscpp::Publication::getUnits().

◆ helicsPublicationSetInfo()

void helicsPublicationSetInfo ( helics_publication  pub,
const char *  info,
helics_error err 
)

Set the data in the info field for a publication.

Parameters
pubThe publication to set the info field for.
infoThe string to set. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

Referenced by helicscpp::Publication::setInfo().

◆ helicsPublicationSetMinimumChange()

void helicsPublicationSetMinimumChange ( helics_publication  pub,
double  tolerance,
helics_error err 
)

Set the minimum change detection tolerance.

Parameters
pubThe publication to modify.
toleranceThe tolerance level for publication, values changing less than this value will not be published. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

◆ helicsPublicationSetOption()

void helicsPublicationSetOption ( helics_publication  pub,
int  option,
int  val,
helics_error err 
)

Set the value of an option for a publication

Parameters
pubThe publication to query.
optionInteger code for the option to set /ref helics_handle_options.
valThe value to set the option to. @forcpponly
[in,out]errAn error object to fill out in case of an error. @endforcpponly

◆ helicsSubscriptionGetKey()

const char* helicsSubscriptionGetKey ( helics_input  ipt)

Get the key of a subscription.

Returns
A const char with the subscription key.

Referenced by helicscpp::Input::getTarget().