|
| InputT (ValueFederate *valueFed, const std::string &name, const std::string &units=std::string()) |
|
template<class FedPtr > |
| InputT (FedPtr &valueFed, const std::string &name, const std::string &units=std::string()) |
|
X | getValue () |
|
void | getValue (X &out) |
|
void | setInputNotificationCallback (std::function< void(X, Time)> callback) |
|
void | setDefault (const X &val) |
|
| Input ()=default |
|
| Input (ValueFederate *valueFed, interface_handle id, const std::string &actName, const std::string &unitsOut=std::string{}) |
|
| Input (ValueFederate *valueFed, const std::string &key, const std::string &defaultType="def", const std::string &units=std::string{}) |
|
template<class FedPtr > |
| Input (FedPtr &valueFed, const std::string &key, const std::string &defaultType="def", const std::string &units=std::string{}) |
|
| Input (interface_visibility locality, ValueFederate *valueFed, const std::string &key, const std::string &defaultType="def", const std::string &units=std::string{}) |
|
template<class FedPtr > |
| Input (interface_visibility locality, FedPtr &valueFed, const std::string &name, const std::string &defaultType="def", const std::string &units=std::string{}) |
|
| Input (ValueFederate *valueFed, const std::string &name, data_type defType, const std::string &units=std::string{}) |
|
template<class FedPtr > |
| Input (FedPtr &valueFed, const std::string &name, data_type defType, const std::string &units=std::string()) |
|
| Input (interface_visibility locality, ValueFederate *valueFed, const std::string &name, const std::string &units=std::string{}) |
|
template<class FedPtr > |
| Input (interface_visibility locality, FedPtr &valueFed, const std::string &key, const std::string &units=std::string{}) |
|
| Input (interface_visibility locality, ValueFederate *valueFed, const std::string &name, data_type defType, const std::string &units=std::string{}) |
|
template<class FedPtr > |
| Input (interface_visibility locality, FedPtr &valueFed, const std::string &name, data_type defType, const std::string &units=std::string{}) |
|
Time | getLastUpdate () const |
|
interface_handle | getHandle () const |
|
| operator interface_handle () const |
|
bool | isValid () const |
|
bool | operator< (const Input &inp) const |
|
bool | operator> (const Input &inp) const |
|
void | registerNotificationCallback (std::function< void(Time)> callback) |
|
const std::string & | getName () const |
|
const std::string & | getKey () const |
|
const std::string & | getDisplayName () const |
|
const std::string & | getPublicationType () const |
|
const std::string & | getType () const |
|
const std::string & | getUnits () const |
|
const std::string & | getInjectionUnits () const |
|
const std::string & | getTarget () const |
|
void | addTarget (const std::string &newTarget) |
|
void | removeTarget (const std::string &targetToRemove) |
|
const std::string & | getInfo () const |
|
void | setInfo (const std::string &info) |
|
void | setOption (int32_t option, int32_t value=1) |
|
int32_t | getOption (int32_t option) const |
|
bool | checkUpdate (bool assumeUpdate=false) |
|
void | clearUpdate () |
|
bool | isUpdated () |
|
bool | isUpdated () const |
|
template<class X > |
void | setInputNotificationCallback (std::function< void(const X &, Time)> callback) |
|
template<class X > |
void | setDefault (X &&val) |
|
void | setMinimumChange (double deltaV) noexcept |
|
void | enableChangeDetection (bool enabled=true) noexcept |
|
int | getValue (double *data, int maxsize) |
|
int | getValue (char *str, int maxsize) |
|
template<class X > |
void | getValue (X &out) |
|
template<class X > |
auto | getValue () |
|
template<class X > |
const X & | getValueRef () |
|
data_view | getRawValue () |
|
size_t | getRawSize () |
|
size_t | getStringSize () |
|
size_t | getVectorSize () |
|
void | close () |
|
data_type | getHelicsType () const |
|
data_type | getHelicsInjectionType () const |
|
multi_input_handling_method | getMultiInputMode () const |
|
bool | vectorDataProcess (const std::vector< std::shared_ptr< const data_block >> &dataV) |
|
template<class X>
class helics::InputT< X >
class to handle an input and extract a specific type
- Template Parameters
-
X | the class of the value associated with a input |