 |
helics
3.0.1
|
Go to the documentation of this file.
9 #include "LocalFederateId.hpp"
39 class CoreFederateInfo;
47 virtual ~Core() =
default;
55 virtual void configure(
const std::string& configureString) = 0;
91 virtual bool hasError()
const = 0;
96 std::chrono::milliseconds msToWait = std::chrono::milliseconds(0))
const = 0;
105 virtual const std::string&
getAddress()
const = 0;
115 const std::string& errorString) = 0;
125 const std::string& errorString) = 0;
330 const std::string& key,
331 const std::string& type,
332 const std::string& units) = 0;
339 const std::string& key)
const = 0;
351 const std::string& key,
352 const std::string& type,
353 const std::string& units) = 0;
434 uint32_t* inputIndex =
nullptr) = 0;
440 virtual const std::vector<std::shared_ptr<const SmallBuffer>>&
465 const std::string& name,
466 const std::string& type) = 0;
475 const std::string& name,
476 const std::string& type) = 0;
483 const std::string& name)
const = 0;
497 const std::string& type_in,
498 const std::string& type_out) = 0;
512 const std::string& type_in,
513 const std::string& type_out) = 0;
525 std::string_view dest,
537 std::string_view name,
574 virtual void linkEndpoints(
const std::string& source,
const std::string& dest) = 0;
583 virtual void dataLink(
const std::string& source,
const std::string& target) = 0;
589 const std::string& target) = 0;
595 const std::string& target) = 0;
625 std::string_view destination) = 0;
664 std::string_view destination,
713 std::shared_ptr<FilterOperator> callback) = 0;
724 std::function<
void(
int, std::string_view, std::string_view)> logFunction) = 0;
730 virtual void setLogFile(
const std::string& lfile) = 0;
737 virtual void setGlobal(
const std::string& valueName,
const std::string& value) = 0;
747 virtual void sendCommand(
const std::string& target,
748 const std::string& commandStr,
749 const std::string& source,
771 virtual std::string
query(
const std::string& target,
772 const std::string& queryStr,
785 std::function<std::string(std::string_view)> queryFunction) = 0;
807 const std::string& tag,
808 const std::string& value) = 0;
815 const std::string& tag)
const = 0;
832 const std::string& tag)
const = 0;
virtual Time getCurrentTime(LocalFederateId federateID) const =0
virtual const std::vector< std::shared_ptr< const SmallBuffer > > & getAllValues(InterfaceHandle handle)=0
virtual IterationResult enterExecutingMode(LocalFederateId federateID, IterationRequest iterate=NO_ITERATION)=0
virtual void setTimeProperty(LocalFederateId federateID, int32_t property, Time timeValue)=0
virtual uint64_t receiveCountAny(LocalFederateId federateID)=0
constexpr auto NO_ITERATION
Definition: CoreTypes.hpp:109
virtual void setCoreReadyToInit()=0
virtual void finalize(LocalFederateId federateID)=0
virtual const std::vector< InterfaceHandle > & getValueUpdates(LocalFederateId federateID)=0
virtual InterfaceHandle getEndpoint(LocalFederateId federateID, const std::string &name) const =0
virtual LocalFederateId getFederateId(const std::string &name) const =0
virtual bool isOpenToNewFederates() const =0
virtual void closeHandle(InterfaceHandle handle)=0
virtual int getErrorCode() const =0
virtual void send(InterfaceHandle sourceHandle, const void *data, uint64_t length)=0
virtual InterfaceHandle registerPublication(LocalFederateId federateID, const std::string &key, const std::string &type, const std::string &units)=0
virtual int32_t getHandleOption(InterfaceHandle handle, int32_t option) const =0
virtual void sendCommand(const std::string &target, const std::string &commandStr, const std::string &source, HelicsSequencingModes mode)=0
virtual void addSourceFilterToEndpoint(const std::string &filter, const std::string &target)=0
virtual const std::string & getSourceTargets(InterfaceHandle handle) const =0
virtual void configureFromArgs(int argc, char *argv[])=0
InterfaceType
Definition: CoreTypes.hpp:96
virtual void setIntegerProperty(LocalFederateId federateID, int32_t property, int16_t propValue)=0
virtual std::string query(const std::string &target, const std::string &queryStr, HelicsSequencingModes mode)=0
virtual void localError(LocalFederateId federateID, int32_t errorCode, const std::string &errorString)=0
virtual InterfaceHandle getFilter(const std::string &name) const =0
Definition: LocalFederateId.hpp:65
virtual bool isConfigured() const =0
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
virtual std::unique_ptr< Message > receive(InterfaceHandle destination)=0
virtual void setFederateTag(LocalFederateId fid, const std::string &tag, const std::string &value)=0
virtual void addSourceTarget(InterfaceHandle handle, std::string_view name, InterfaceType hint=InterfaceType::UNKNOWN)=0
virtual const std::shared_ptr< const SmallBuffer > & getValue(InterfaceHandle handle, uint32_t *inputIndex=nullptr)=0
virtual Time getTimeProperty(LocalFederateId federateID, int32_t property) const =0
virtual void sendToAt(InterfaceHandle sourceHandle, const void *data, uint64_t length, std::string_view destination, Time time)=0
virtual void linkEndpoints(const std::string &source, const std::string &dest)=0
virtual int32_t getFederationSize()=0
virtual InterfaceHandle getPublication(LocalFederateId federateID, const std::string &key) const =0
virtual void setValue(InterfaceHandle handle, const char *data, uint64_t len)=0
virtual void setInterfaceTag(InterfaceHandle handle, const std::string &tag, const std::string &value)=0
virtual const std::string & getAddress() const =0
virtual const std::string & getInterfaceTag(InterfaceHandle handle, const std::string &tag) const =0
virtual void setQueryCallback(LocalFederateId federateID, std::function< std::string(std::string_view)> queryFunction)=0
Definition: core/Core.hpp:42
virtual void addDestinationFilterToEndpoint(const std::string &filter, const std::string &target)=0
virtual InterfaceHandle registerEndpoint(LocalFederateId federateID, const std::string &name, const std::string &type)=0
virtual const std::string & getDestinationTargets(InterfaceHandle handle) const =0
virtual const std::string & getExtractionType(InterfaceHandle handle) const =0
virtual const std::string & getFederateTag(LocalFederateId fid, const std::string &tag) const =0
virtual bool isConnected() const =0
virtual void sendMessage(InterfaceHandle sourceHandle, std::unique_ptr< Message > message)=0
virtual LocalFederateId registerFederate(const std::string &name, const CoreFederateInfo &info)=0
virtual void configureFromVector(std::vector< std::string > args)=0
virtual std::unique_ptr< Message > receiveAny(LocalFederateId federateID, InterfaceHandle &endpoint_id)=0
virtual uint64_t getCurrentReiteration(LocalFederateId federateID) const =0
IterationRequest
Definition: CoreTypes.hpp:89
virtual void setInterfaceInfo(InterfaceHandle handle, std::string info)=0
virtual Time timeRequest(LocalFederateId federateID, Time next)=0
virtual std::pair< std::string, std::string > getCommand(LocalFederateId federateID)=0
virtual InterfaceHandle registerFilter(const std::string &filterName, const std::string &type_in, const std::string &type_out)=0
virtual void setGlobal(const std::string &valueName, const std::string &value)=0
virtual void globalError(LocalFederateId federateID, int32_t errorCode, const std::string &errorString)=0
virtual const std::string & getInjectionType(InterfaceHandle handle) const =0
virtual void configure(const std::string &configureString)=0
virtual void setFlagOption(LocalFederateId federateID, int32_t flag, bool flagValue)=0
virtual void logMessage(LocalFederateId federateID, int logLevel, const std::string &messageToLog)=0
virtual void sendAt(InterfaceHandle sourceHandle, const void *data, uint64_t length, Time time)=0
IterationResult
Definition: CoreTypes.hpp:80
virtual const std::string & getInjectionUnits(InterfaceHandle handle) const =0
virtual iteration_time requestTimeIterative(LocalFederateId federateID, Time next, IterationRequest iterate)=0
HelicsSequencingModes
Definition: helics_enums.h:363
virtual bool getFlagOption(LocalFederateId federateID, int32_t flag) const =0
virtual void setFilterOperator(InterfaceHandle filter, std::shared_ptr< FilterOperator > callback)=0
virtual const std::string & getInterfaceInfo(InterfaceHandle handle) const =0
virtual InterfaceHandle registerInput(LocalFederateId federateID, const std::string &key, const std::string &type, const std::string &units)=0
virtual InterfaceHandle registerTargetedEndpoint(LocalFederateId federateID, const std::string &name, const std::string &type)=0
virtual const std::string & getIdentifier() const =0
virtual void addDestinationTarget(InterfaceHandle handle, std::string_view dest, InterfaceType hint=InterfaceType::UNKNOWN)=0
virtual uint64_t receiveCount(InterfaceHandle destination)=0
virtual void sendTo(InterfaceHandle sourceHandle, const void *data, uint64_t length, std::string_view destination)=0
virtual const std::string & getFederateName(LocalFederateId federateID) const =0
virtual void setLoggingLevel(int logLevel)=0
virtual InterfaceHandle getInput(LocalFederateId federateID, const std::string &key) const =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 const std::string & getHandleName(InterfaceHandle handle) const =0
virtual void setHandleOption(InterfaceHandle handle, int32_t option, int32_t option_value)=0
Definition: CoreFederateInfo.hpp:16
virtual void addDependency(LocalFederateId federateID, const std::string &federateName)=0
Definition: helicsTime.hpp:47
virtual void dataLink(const std::string &source, const std::string &target)=0
Definition: LocalFederateId.hpp:22
virtual InterfaceHandle registerCloningFilter(const std::string &filterName, const std::string &type_in, const std::string &type_out)=0
virtual const std::string & getExtractionUnits(InterfaceHandle handle) const =0
virtual std::string getErrorMessage() const =0
virtual bool waitForDisconnect(std::chrono::milliseconds msToWait=std::chrono::milliseconds(0)) const =0
virtual int16_t getIntegerProperty(LocalFederateId federateID, int32_t property) const =0
virtual void setLoggingCallback(LocalFederateId federateID, std::function< void(int, std::string_view, std::string_view)> logFunction)=0
virtual void makeConnections(const std::string &file)=0
virtual void enterInitializingMode(LocalFederateId federateID)=0
virtual void removeTarget(InterfaceHandle handle, std::string_view targetToRemove)=0
virtual std::pair< std::string, std::string > waitCommand(LocalFederateId federateID)=0