helics
3.5.2
|
#include <InterfaceInfo.hpp>
Public Member Functions | |
const PublicationInfo * | getPublication (const std::string &pubName) const |
const PublicationInfo * | getPublication (InterfaceHandle handle) const |
PublicationInfo * | getPublication (const std::string &pubName) |
PublicationInfo * | getPublication (InterfaceHandle handle) |
const InputInfo * | getInput (const std::string &inputName) const |
const InputInfo * | getInput (InterfaceHandle handle) const |
InputInfo * | getInput (const std::string &inputName) |
InputInfo * | getInput (InterfaceHandle handle) |
const EndpointInfo * | getEndpoint (const std::string &endpointName) const |
const EndpointInfo * | getEndpoint (InterfaceHandle handle) const |
EndpointInfo * | getEndpoint (const std::string &endpointName) |
EndpointInfo * | getEndpoint (InterfaceHandle handle) |
void | createPublication (InterfaceHandle handle, std::string_view key, std::string_view type, std::string_view units, std::uint16_t flags) |
void | createInput (InterfaceHandle handle, std::string_view key, std::string_view type, std::string_view units, std::uint16_t flags) |
void | createEndpoint (InterfaceHandle handle, std::string_view endpointName, std::string_view type, std::uint16_t flags) |
auto | getEndpoints () |
auto | getPublications () |
auto | getInputs () |
auto | getEndpoints () const |
auto | getPublications () const |
auto | getInputs () const |
auto | cgetEndpoints () const |
auto | cgetPublications () const |
auto | cgetInputs () const |
void | setGlobalId (GlobalFederateId newglobalId) |
void | setChangeUpdateFlag (bool updateFlag) |
bool | getChangeUpdateFlag () const |
bool | setInputProperty (InterfaceHandle hid, int32_t option, int32_t value) |
bool | setPublicationProperty (InterfaceHandle hid, int32_t option, int32_t value) |
bool | setEndpointProperty (InterfaceHandle hid, int32_t option, int32_t value) |
int32_t | getInputProperty (InterfaceHandle hid, int32_t option) const |
int32_t | getPublicationProperty (InterfaceHandle hid, int32_t option) const |
int32_t | getEndpointProperty (InterfaceHandle hid, int32_t option) const |
std::vector< std::pair< int, std::string > > | checkInterfacesForIssues () |
void | generateInferfaceConfig (Json::Value &base) const |
void | generateDataFlowGraph (Json::Value &base) const |
void | getUnconnectedInterfaces (Json::Value &base) const |
void | reset () |
void | disconnectFederate (GlobalFederateId fedToDisconnect, Time disconnectTime) |
generic class for holding information about interfaces for a core federate structure
std::vector< std::pair< int, std::string > > helics::InterfaceInfo::checkInterfacesForIssues | ( | ) |
check the interfaces for specific issues
void helics::InterfaceInfo::disconnectFederate | ( | GlobalFederateId | fedToDisconnect, |
Time | disconnectTime | ||
) |
disconnect a federate from communications
References helics::cBigTime.
void helics::InterfaceInfo::generateDataFlowGraph | ( | Json::Value & | base | ) | const |
load a dependency graph for the interfaces
void helics::InterfaceInfo::generateInferfaceConfig | ( | Json::Value & | base | ) | const |
generate a configuration script for the interfaces
|
inline |
get the current value of the change update flag
int32_t helics::InterfaceInfo::getInputProperty | ( | InterfaceHandle | hid, |
int32_t | option | ||
) | const |
get properties for an interface
void helics::InterfaceInfo::getUnconnectedInterfaces | ( | Json::Value & | base | ) | const |
generate a list of unconnected interfaces
void helics::InterfaceInfo::reset | ( | ) |
reset the interfaceInfo to a new state
Referenced by helics::FederateState::reset().
void helics::InterfaceInfo::setChangeUpdateFlag | ( | bool | updateFlag | ) |
set the change update flag which controls when a subscription is updated
|
inline |
set the global id of the federate for use in the interfaces
bool helics::InterfaceInfo::setInputProperty | ( | InterfaceHandle | hid, |
int32_t | option, | ||
int32_t | value | ||
) |
set a property on a specific interface