![]() |
helics
2.8.1
|
#include <Input.hpp>
Public Member Functions | |
Input (helics_input hsub) HELICS_NOTHROW | |
Input () HELICS_NOTHROW | |
Input (const Input &inputs) HELICS_NOTHROW | |
Input & | operator= (const Input &input) |
operator helics_input () const | |
helics_input | baseObject () const |
bool | isValid () const |
void | addTarget (const std::string &target) |
void | setDefault (const char *data, int len) |
void | setDefault (const std::string &str) |
void | setDefault (int64_t val) |
void | setDefault (bool val) |
void | setDefault (double val) |
void | setDefault (const std::complex< double > &cmplx) |
void | setDefault (const std::vector< double > &data) |
int | getRawValue (std::vector< char > &data) |
int | getRawValueSize () |
std::string | getString () |
void | getNamedPoint (std::string &name, double *val) |
int64_t | getInteger () |
bool | getBoolean () |
double | getDouble () |
std::complex< double > | getComplex () |
int | getVector (double *data, int maxlen) |
void | getVector (std::vector< double > &data) |
bool | isUpdated () const |
helics_time | getLastUpdateTime () const |
void | clearUpdate () |
const char * | getKey () const |
const char * | getUnits () const |
const char * | getInjectionUnits () const |
const char * | getPublicationType () const |
const char * | getType () const |
const char * | getTarget () const |
const char * | getInfo () const |
void | setInfo (const std::string &info) |
void | setOption (int32_t option, int32_t value=1) |
int32_t | getOption (int32_t option) |
C++98 interface for a helics Input
|
inlineexplicit |
construct from a helics_input object
|
inline |
default constructor
|
inline |
copy constructor
|
inline |
add a publication target to the input
References helicsInputAddTarget().
|
inline |
extract the base object
|
inline |
clear the updated flag
References helicsInputClearUpdate().
|
inline |
get the value as a boolean
References helics_true, and helicsInputGetBoolean().
|
inline |
get the value as a complex number
References helicsInputGetComplexObject().
|
inline |
get the value as a double
References helicsInputGetDouble().
|
inline |
get the interface information field of the filter
References helicsInputGetInfo().
|
inline |
get the units associated with an inputs publication
References helicsInputGetInjectionUnits().
|
inline |
get the current value as a 64 bit integer
References helicsInputGetInteger().
|
inline |
get the Name/Key for the input
the name is the local name if given, key is the full key name
References helicsInputGetKey().
|
inline |
Get the last time an input was updated
References helicsInputLastUpdateTime().
|
inline |
get the current value as a named point
References helicsInputGetNamedPoint(), and helicsInputGetStringSize().
|
inline |
get the units associated with a publication of an input
References helicsInputGetPublicationType().
|
inline |
Methods to get subscription values get a raw value as a character vector
References data, helicsInputGetRawValue(), and helicsInputGetRawValueSize().
|
inline |
get the size of the raw value
References helicsInputGetRawValueSize().
|
inline |
get the current value as a string
References helicsInputGetString(), and helicsInputGetStringSize().
|
inline |
get an associated target
References helicsSubscriptionGetKey().
|
inline |
get the type of the input
References helicsInputGetType().
|
inline |
get the units associated with a input
References helicsInputGetExtractionUnits().
|
inline |
get the current value as a vector of doubles
data | pointer to space to store the current values |
maxlen | the maximum size of the allowed vector |
References data, and helicsInputGetVector().
|
inline |
get the current value and store it in a std::vector<double>
References data, helicsInputGetVector(), and helicsInputGetVectorSize().
|
inline |
Check if an input is updated
References helicsInputIsUpdated().
|
inline |
check if the input is valid
References helics_true, and helicsInputIsValid().
|
inline |
cast to helics_input object
|
inline |
set the default bool value
References helics_false, helics_true, and helicsInputSetDefaultBoolean().
|
inline |
Methods to set default values for inputs set the default value as a raw data with length
References data, and helicsInputSetDefaultRaw().
|
inline |
set the default complex value
References helicsInputSetDefaultComplex().
|
inline |
set the default value as a string
References helicsInputSetDefaultString().
|
inline |
set the default vector data value
References data, and helicsInputSetDefaultVector().
|
inline |
set the default double value
References helicsInputSetDefaultDouble().
|
inline |
set the default value as an integer
References helicsInputSetDefaultInteger().
|
inline |
set the interface information field of the publication
References helicsInputSetInfo().