![]() |
helics
2.8.1
|
#include <HandleManager.hpp>
Public Member Functions | |
HandleManager ()=default | |
BasicHandleInfo & | addHandle (global_federate_id fed_id, handle_type what, const std::string &key, const std::string &type, const std::string &units) |
BasicHandleInfo & | addHandle (global_federate_id fed_id, interface_handle local_id, handle_type what, const std::string &key, const std::string &type, const std::string &units) |
void | addHandle (const BasicHandleInfo &otherHandle) |
void | addHandleAtIndex (const BasicHandleInfo &otherHandle, int32_t index) |
void | removeHandle (global_handle handle) |
BasicHandleInfo * | getHandleInfo (int32_t index) |
const BasicHandleInfo * | getHandleInfo (int32_t index) const |
BasicHandleInfo * | getHandleInfo (interface_handle handle) |
const BasicHandleInfo * | getHandleInfo (interface_handle handle) const |
BasicHandleInfo * | findHandle (global_handle id) |
const BasicHandleInfo * | findHandle (global_handle id) const |
void | setHandleOption (interface_handle handle, int32_t option, int32_t val) |
int32_t | getHandleOption (interface_handle handle, int32_t option) const |
BasicHandleInfo * | getEndpoint (const std::string &name) |
const BasicHandleInfo * | getEndpoint (const std::string &name) const |
BasicHandleInfo * | getEndpoint (interface_handle handle) |
const BasicHandleInfo * | getEndpoint (interface_handle handle) const |
const BasicHandleInfo * | getFilter (const std::string &name) const |
BasicHandleInfo * | getFilter (const std::string &name) |
BasicHandleInfo * | getFilter (interface_handle handle) |
BasicHandleInfo * | getPublication (const std::string &name) |
const BasicHandleInfo * | getPublication (const std::string &name) const |
BasicHandleInfo * | getPublication (interface_handle handle) |
BasicHandleInfo * | getInput (const std::string &name) |
const BasicHandleInfo * | getInput (const std::string &name) const |
local_federate_id | getLocalFedID (interface_handle handle) const |
BasicHandleInfo & | operator[] (size_t index) |
const BasicHandleInfo & | operator[] (size_t index) const |
auto | begin () |
auto | end () |
auto | begin () const |
auto | end () const |
auto | size () const |
class for managing a coordinating the different types of handles used in helics
this class is not designed to be thread safe that would require a wrapper around it
|
default |
default constructor
BasicHandleInfo & helics::HandleManager::addHandle | ( | global_federate_id | fed_id, |
handle_type | what, | ||
const std::string & | key, | ||
const std::string & | type, | ||
const std::string & | units | ||
) |
add a handle to manage
References helics::interface_handle::baseValue().
Referenced by addHandleAtIndex().
BasicHandleInfo & helics::HandleManager::addHandle | ( | global_federate_id | fed_id, |
interface_handle | local_id, | ||
handle_type | what, | ||
const std::string & | key, | ||
const std::string & | type, | ||
const std::string & | units | ||
) |
add a handle to manage
void helics::HandleManager::addHandleAtIndex | ( | const BasicHandleInfo & | otherHandle, |
int32_t | index | ||
) |
add a handle at the specified index
References addHandle(), and helics::isValidIndex().
BasicHandleInfo * helics::HandleManager::findHandle | ( | global_handle | id | ) |
find a handle from both the federate and local id
const BasicHandleInfo * helics::HandleManager::findHandle | ( | global_handle | id | ) | const |
find a const handle from both the federate and local id
BasicHandleInfo * helics::HandleManager::getEndpoint | ( | const std::string & | name | ) |
get an endpoint from its name
Referenced by helics::FilterFederate::processDestFilterReturn(), and helics::FilterFederate::processFilterReturn().
const BasicHandleInfo * helics::HandleManager::getEndpoint | ( | const std::string & | name | ) | const |
get an endpoint from its name
BasicHandleInfo * helics::HandleManager::getEndpoint | ( | interface_handle | handle | ) |
get an endpoint by index
References helics::interface_handle::baseValue(), helics::endpoint, and helics::isValidIndex().
const BasicHandleInfo * helics::HandleManager::getEndpoint | ( | interface_handle | handle | ) | const |
get a const endpoint by index
References helics::interface_handle::baseValue(), helics::endpoint, and helics::isValidIndex().
const BasicHandleInfo * helics::HandleManager::getFilter | ( | const std::string & | name | ) | const |
get a const filter by name
BasicHandleInfo * helics::HandleManager::getFilter | ( | interface_handle | handle | ) |
get a filter by index
References helics::interface_handle::baseValue(), helics::filter, and helics::isValidIndex().
BasicHandleInfo * helics::HandleManager::getHandleInfo | ( | int32_t | index | ) |
get a handle by index
References helics::isValidIndex().
const BasicHandleInfo * helics::HandleManager::getHandleInfo | ( | int32_t | index | ) | const |
get a const handle by index
References helics::isValidIndex().
BasicHandleInfo * helics::HandleManager::getHandleInfo | ( | interface_handle | handle | ) |
get a handle by index
References helics::interface_handle::baseValue(), and helics::isValidIndex().
const BasicHandleInfo * helics::HandleManager::getHandleInfo | ( | interface_handle | handle | ) | const |
get a const handle by index
References helics::interface_handle::baseValue(), and helics::isValidIndex().
BasicHandleInfo * helics::HandleManager::getPublication | ( | interface_handle | handle | ) |
get a publication by index
References helics::interface_handle::baseValue(), helics::isValidIndex(), and helics::publication.
void helics::HandleManager::removeHandle | ( | global_handle | handle | ) |
remove the information at the specified handle
References helics::endpoint, helics::filter, helics::input, and helics::publication.