helics
3.5.2
|
#include <Input.hpp>
Public Member Functions | |
Input (HelicsInput hsub) HELICS_NOTHROW | |
Input () HELICS_NOTHROW | |
Input (const Input &inputs) HELICS_NOTHROW | |
Input & | operator= (const Input &input) |
operator HelicsInput () const | |
HelicsInput | 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) |
void | setDefault (const std::vector< std::complex< double > > &data) |
int | getBytes (std::vector< char > &data) |
int | getByteCount () |
int | getStringSize () |
std::string | getString () |
void | getString (std::string &str) |
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) |
int | getComplexVector (double *data, int maxlen) |
void | getComplexVector (std::vector< std::complex< double > > &data) |
DataBuffer | getDataBuffer () |
bool | isUpdated () const |
HelicsTime | getLastUpdateTime () const |
void | clearUpdate () |
const char * | getName () 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) |
const char * | getTag (const std::string &tagname) const |
void | setTag (const std::string &tagname, const std::string &tagvalue) |
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 HelicsInput 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 size of the raw value
References helicsInputGetByteCount().
|
inline |
Methods to get subscription values get a raw value as a character vector
References helicsInputGetByteCount(), and helicsInputGetBytes().
|
inline |
get the value as a complex number
References helicsInputGetComplexObject().
|
inline |
get the current value as a vector of doubles in alternating real and imaginary
data | pointer to space to store the current values |
maxlen | the maximum size of the allowed vector |
References helicsInputGetComplexVector().
|
inline |
get the current value and store it in a std::vector<std::complex<double>>
References helicsInputGetComplexVector(), and helicsInputGetVectorSize().
|
inline |
get a data buffer with the input value
References helicsInputGetDataBuffer().
|
inline |
get the value as a double
References helicsInputGetDouble().
|
inline |
get the interface information field of the input`
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 last time an input was updated
References helicsInputLastUpdateTime().
|
inline |
get the Name for the input
the name is full name vs the local one for non-global interfaces
References helicsInputGetName().
|
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 |
get the current value as a string
References helicsInputGetString(), and helicsInputGetStringSize().
|
inline |
get the current value as a string
References helicsInputGetString(), and helicsInputGetStringSize().
|
inline |
get the size of the value as a string
References helicsInputGetStringSize().
|
inline |
get the value of a tag for the input
References helicsInputGetTag().
|
inline |
get an associated target
References helicsInputGetTarget().
|
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 helicsInputGetVector().
|
inline |
get the current value and store it in a std::vector<double>
References 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 HelicsInput 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 helicsInputSetDefaultBytes().
|
inline |
set the default complex value
References helicsInputSetDefaultComplex().
|
inline |
set the default value as a string
References helicsInputSetDefaultString().
|
inline |
set the default complex vector data value
References helicsInputSetDefaultVector().
|
inline |
set the default complex vector data value
References helicsInputSetDefaultComplexVector().
|
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 input
References helicsInputSetInfo().
|
inline |
set the value of a tag for the input
References helicsInputSetTag().