 |
helics
2.8.1
|
Go to the documentation of this file.
10 #include "federate_id.hpp"
39 class CoreFederateInfo;
47 virtual ~Core() =
default;
58 [[deprecated(
"please use configure instead")]]
void
79 virtual void configure(
const std::string& configureString) = 0;
101 [[deprecated(
"please use isConfigured instead")]]
bool isInitialized()
const
121 virtual bool hasError()
const = 0;
126 std::chrono::milliseconds msToWait = std::chrono::milliseconds(0))
const = 0;
135 virtual const std::string&
getAddress()
const = 0;
143 const std::string& errorString) = 0;
150 const std::string& errorString) = 0;
364 const std::string& key,
365 const std::string& type,
366 const std::string& units) = 0;
373 const std::string& key)
const = 0;
385 const std::string& key,
386 const std::string& type,
387 const std::string& units) = 0;
393 const std::string& key)
const = 0;
422 [[deprecated(
"please use getExtractionUnits instead")]]
const std::string&
477 uint32_t* inputIndex =
nullptr) = 0;
483 virtual const std::vector<std::shared_ptr<const data_block>>&
507 const std::string& name,
508 const std::string& type) = 0;
515 const std::string& name)
const = 0;
529 const std::string& type_in,
530 const std::string& type_out) = 0;
544 const std::string& type_in,
545 const std::string& type_out) = 0;
590 const std::string& dest) = 0;
599 virtual void dataLink(
const std::string& source,
const std::string& target) = 0;
605 const std::string& target) = 0;
611 const std::string& target) = 0;
625 const std::string& destination,
627 uint64_t length) = 0;
647 const std::string& destination,
649 uint64_t length) = 0;
697 std::shared_ptr<FilterOperator> callback) = 0;
708 std::function<
void(
int,
const std::string&,
const std::string&)> logFunction) = 0;
714 virtual void setLogFile(
const std::string& lfile) = 0;
721 virtual void setGlobal(
const std::string& valueName,
const std::string& value) = 0;
732 virtual std::string
query(
const std::string& target,
733 const std::string& queryStr,
746 std::function<std::string(
const std::string&)> queryFunction) = 0;
@ data
print timing+data transmissions
Definition: loggingHelper.hpp:30
virtual uint64_t receiveCountAny(local_federate_id federateID)=0
virtual std::string query(const std::string &target, const std::string &queryStr, helics_sequencing_mode mode)=0
virtual const std::string & getFederateName(local_federate_id federateID) const =0
virtual void setValue(interface_handle handle, const char *data, uint64_t len)=0
virtual void setCoreReadyToInit()=0
void initializeFromArgs(int argc, char *argv[])
Definition: core/Core.hpp:68
virtual void send(interface_handle sourceHandle, const std::string &destination, const char *data, uint64_t length)=0
virtual void setHandleOption(interface_handle handle, int32_t option, int32_t option_value)=0
virtual iteration_result enterExecutingMode(local_federate_id federateID, iteration_request iterate=NO_ITERATION)=0
virtual bool getFlagOption(local_federate_id federateID, int32_t flag) const =0
virtual const std::string & getInterfaceInfo(interface_handle handle) const =0
iteration_request
Definition: core-types.hpp:90
virtual bool isOpenToNewFederates() const =0
virtual int getErrorCode() const =0
virtual std::unique_ptr< Message > receive(interface_handle destination)=0
virtual void addDestinationTarget(interface_handle handle, const std::string &dest)=0
Definition: federate_id.hpp:22
virtual void addSourceFilterToEndpoint(const std::string &filter, const std::string &target)=0
virtual void configureFromArgs(int argc, char *argv[])=0
virtual const std::string & getExtractionType(interface_handle handle) const =0
iteration_result
Definition: core-types.hpp:81
bool isInitialized() const
Definition: core/Core.hpp:101
virtual bool isConfigured() const =0
virtual void addSourceTarget(interface_handle handle, const std::string &name)=0
TimeRepresentation< count_time< 9 > > Time
Definition: helics-time.hpp:27
virtual interface_handle registerPublication(local_federate_id federateID, const std::string &key, const std::string &type, const std::string &units)=0
virtual void sendMessage(interface_handle sourceHandle, std::unique_ptr< Message > message)=0
virtual const std::string & getInjectionType(interface_handle handle) const =0
void error(local_federate_id federateID, int32_t errorCode=-1)
Definition: core/Core.hpp:155
virtual const std::vector< std::shared_ptr< const data_block > > & getAllValues(interface_handle handle)=0
virtual int32_t getFederationSize()=0
virtual interface_handle getPublication(local_federate_id federateID, const std::string &key) const =0
virtual interface_handle getEndpoint(local_federate_id federateID, const std::string &name) const =0
virtual void sendEvent(Time time, interface_handle sourceHandle, const std::string &destination, const char *data, uint64_t length)=0
virtual void setTimeProperty(local_federate_id federateID, int32_t property, Time timeValue)=0
virtual const std::string & getAddress() const =0
helics_sequencing_mode
Definition: helics_enums.h:333
virtual void removeTarget(interface_handle handle, const std::string &targetToRemove)=0
virtual void localError(local_federate_id federateID, int32_t errorCode, const std::string &errorString)=0
Definition: core/Core.hpp:42
virtual void closeHandle(interface_handle handle)=0
virtual void addDestinationFilterToEndpoint(const std::string &filter, const std::string &target)=0
virtual bool isConnected() const =0
virtual interface_handle registerFilter(const std::string &filterName, const std::string &type_in, const std::string &type_out)=0
virtual void configureFromVector(std::vector< std::string > args)=0
void initialize(const std::string &configureString)
Definition: core/Core.hpp:59
virtual void setIntegerProperty(local_federate_id federateID, int32_t property, int16_t propValue)=0
virtual void setGlobal(const std::string &valueName, const std::string &value)=0
const std::string & getUnits(interface_handle handle) const
Definition: core/Core.hpp:423
virtual void configure(const std::string &configureString)=0
virtual interface_handle registerInput(local_federate_id federateID, const std::string &key, const std::string &type, const std::string &units)=0
virtual void logMessage(local_federate_id federateID, int logLevel, const std::string &messageToLog)=0
constexpr auto NO_ITERATION
Definition: core-types.hpp:101
virtual Time getCurrentTime(local_federate_id federateID) const =0
virtual const std::string & getInjectionUnits(interface_handle handle) const =0
Definition: federate_id.hpp:65
virtual void addDependency(local_federate_id federateID, const std::string &federateName)=0
virtual uint64_t receiveCount(interface_handle destination)=0
virtual int16_t getIntegerProperty(local_federate_id federateID, int32_t property) const =0
virtual const std::string & getIdentifier() const =0
virtual void enterInitializingMode(local_federate_id federateID)=0
virtual const std::string & getHandleName(interface_handle handle) const =0
virtual interface_handle getFilter(const std::string &name) const =0
virtual void setLoggingLevel(int logLevel)=0
virtual Time timeRequest(local_federate_id federateID, Time next)=0
virtual std::unique_ptr< Message > receiveAny(local_federate_id federateID, interface_handle &endpoint_id)=0
virtual void disconnect()=0
the main namespace for the helics co-simulation library User functions will be in the helics namespac...
Definition: AsyncFedCallInfo.hpp:14
virtual void setLogFile(const std::string &lfile)=0
virtual void setLoggingCallback(local_federate_id federateID, std::function< void(int, const std::string &, const std::string &)> logFunction)=0
Definition: CoreFederateInfo.hpp:16
Definition: helics-time.hpp:47
virtual Time getTimeProperty(local_federate_id federateID, int32_t property) const =0
virtual interface_handle registerEndpoint(local_federate_id federateID, const std::string &name, const std::string &type)=0
virtual void finalize(local_federate_id federateID)=0
virtual void globalError(local_federate_id federateID, int32_t errorCode, const std::string &errorString)=0
virtual const std::shared_ptr< const data_block > & getValue(interface_handle handle, uint32_t *inputIndex=nullptr)=0
virtual void dataLink(const std::string &source, const std::string &target)=0
virtual local_federate_id registerFederate(const std::string &name, const CoreFederateInfo &info)=0
virtual interface_handle getInput(local_federate_id federateID, const std::string &key) const =0
virtual local_federate_id getFederateId(const std::string &name) const =0
virtual iteration_time requestTimeIterative(local_federate_id federateID, Time next, iteration_request iterate)=0
virtual void setFilterOperator(interface_handle filter, std::shared_ptr< FilterOperator > callback)=0
virtual std::string getErrorMessage() const =0
virtual bool waitForDisconnect(std::chrono::milliseconds msToWait=std::chrono::milliseconds(0)) const =0
virtual void setInterfaceInfo(interface_handle handle, std::string info)=0
virtual const std::vector< interface_handle > & getValueUpdates(local_federate_id federateID)=0
virtual uint64_t getCurrentReiteration(local_federate_id federateID) const =0
virtual int32_t getHandleOption(interface_handle handle, int32_t option) const =0
virtual interface_handle registerCloningFilter(const std::string &filterName, const std::string &type_in, const std::string &type_out)=0
virtual void makeConnections(const std::string &file)=0
virtual void registerFrequentCommunicationsPair(const std::string &source, const std::string &dest)=0
virtual const std::string & getExtractionUnits(interface_handle handle) const =0
virtual void setFlagOption(local_federate_id federateID, int32_t flag, bool flagValue)=0
virtual void setQueryCallback(local_federate_id federateID, std::function< std::string(const std::string &)> queryFunction)=0