|
| Core () HELICS_NOTHROW |
|
| Core (const std::string &type, const std::string &name, const std::string &initString) |
|
| Core (const std::string &type, const std::string &name, int argc, char **argv) |
|
| Core (HelicsCore cr) HELICS_NOTHROW |
|
| ~Core () |
|
| operator HelicsCore () |
|
HelicsCore | baseObject () const |
|
bool | isConnected () const |
|
| Core (const Core &cr) |
|
Core & | operator= (const Core &cr) |
|
void | setReadyToInit () |
|
void | disconnect () |
|
bool | waitForDisconnect (int msToWait=-1) |
|
const char * | getIdentifier () const |
|
const char * | getAddress () const |
|
Filter | registerFilter (HelicsFilterTypes type, const std::string &name=std::string()) |
|
CloningFilter | registerCloningFilter (const std::string &deliveryEndpoint) |
|
void | setGlobal (const std::string &valueName, const std::string &value) |
|
void | addAlias (const std::string &interfaceName, const std::string &alias) |
|
void | globalError (int errorCode, const std::string &errorString) |
|
void | sendCommand (const std::string &target, const std::string &command) |
|
std::string | query (const std::string &target, const std::string &queryStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST) const |
|
◆ Core() [1/5]
helicscpp::Core::Core |
( |
| ) |
|
|
inline |
◆ Core() [2/5]
helicscpp::Core::Core |
( |
const std::string & |
type, |
|
|
const std::string & |
name, |
|
|
const std::string & |
initString |
|
) |
| |
|
inline |
◆ Core() [3/5]
helicscpp::Core::Core |
( |
const std::string & |
type, |
|
|
const std::string & |
name, |
|
|
int |
argc, |
|
|
char ** |
argv |
|
) |
| |
|
inline |
◆ Core() [4/5]
construct a core from a core pointer
◆ ~Core()
helicscpp::Core::~Core |
( |
| ) |
|
|
inline |
◆ Core() [5/5]
helicscpp::Core::Core |
( |
const Core & |
cr | ) |
|
|
inline |
◆ addAlias()
void helicscpp::Core::addAlias |
( |
const std::string & |
interfaceName, |
|
|
const std::string & |
alias |
|
) |
| |
|
inline |
add a global alias for an interface
- Parameters
-
interfaceName | the given name of the interface |
alias | the new name by which the interface can be referenced |
References core, and helicsCoreAddAlias().
◆ baseObject()
explicitly get the base HelicsCore object
References core.
◆ disconnect()
void helicscpp::Core::disconnect |
( |
| ) |
|
|
inline |
◆ getAddress()
const char* helicscpp::Core::getAddress |
( |
| ) |
const |
|
inline |
◆ getIdentifier()
const char* helicscpp::Core::getIdentifier |
( |
| ) |
const |
|
inline |
◆ isConnected()
bool helicscpp::Core::isConnected |
( |
| ) |
const |
|
inline |
◆ operator HelicsCore()
implicit operator so the object can be used with the c api functions natively
References core.
◆ operator=()
Core& helicscpp::Core::operator= |
( |
const Core & |
cr | ) |
|
|
inline |
◆ query()
make a query of the core
this call is blocking until the value is returned which may take some time depending on the size of the federation and the specific string being queried
- Parameters
-
target | the target of the query can be "federation", "federate", "broker", "core", or a specific name of a federate, core, or broker |
queryStr | a string with the query, see other documentation for specific properties to query, can be defined by the federate |
mode | the ordering mode to use for the query (fast-priority channels, ordered for normal channels ordered with all other messages) |
- Returns
- a string with the value requested. this is either going to be a vector of strings value or a JSON string stored in the first element of the vector. The string "#invalid" is returned if the query was not valid
References core, HELICS_SEQUENCING_MODE_FAST, helicsCreateQuery(), helicsQueryCoreExecute(), helicsQueryFree(), and helicsQuerySetOrdering().
◆ registerCloningFilter()
CloningFilter helicscpp::Core::registerCloningFilter |
( |
const std::string & |
deliveryEndpoint | ) |
|
|
inline |
create a cloning Filter on the specified federate
cloning filters copy a message and send it to multiple locations source and destination can be added through other functions
- Parameters
-
deliveryEndpoint | the specified endpoint to deliver the message |
- Returns
- a HelicsFilter object
References core, and helicsCoreRegisterCloningFilter().
◆ registerFilter()
create a destination Filter on the specified federate
filters can be created through a federate or a core , linking through a federate allows a few extra features of name matching to function on the federate interface but otherwise equivalent behavior
- Parameters
-
type | the type of filter to create |
name | the name of the filter (can be NULL) |
- Returns
- a HelicsFilter object
References core, and helicsCoreRegisterFilter().
◆ sendCommand()
void helicscpp::Core::sendCommand |
( |
const std::string & |
target, |
|
|
const std::string & |
command |
|
) |
| |
|
inline |
send an asynchronous command to another object
- Parameters
-
target | the name of the target of the command |
command | the command message to send |
References core, and helicsCoreSendCommand().
◆ setGlobal()
void helicscpp::Core::setGlobal |
( |
const std::string & |
valueName, |
|
|
const std::string & |
value |
|
) |
| |
|
inline |
set a global federation value
- Parameters
-
valueName | the name of the global value to set |
value | actual value of the global variable |
References core, and helicsCoreSetGlobal().
◆ setReadyToInit()
void helicscpp::Core::setReadyToInit |
( |
| ) |
|
|
inline |
set the core to ready to enter init
this function only needs to be called for cores that don't have any federates but may have filters for cores with federates it won't do anything
References core, and helicsCoreSetReadyToInit().
◆ waitForDisconnect()
bool helicscpp::Core::waitForDisconnect |
( |
int |
msToWait = -1 | ) |
|
|
inline |
waits in the current thread until the broker is disconnected
- Parameters
-
msToWait | the timeout to wait for disconnect (-1) implies no timeout |
- Returns
- true if the disconnect was successful false if it timed out
References core, HELICS_FALSE, and helicsCoreWaitForDisconnect().
The documentation for this class was generated from the following file: