 |
helics
3.3.0
|
Go to the documentation of this file.
9 #include "LocalFederateId.hpp"
38 class CoreFederateInfo;
46 virtual ~Core() =
default;
54 virtual void configure(std::string_view configureString) = 0;
90 virtual bool hasError()
const = 0;
95 std::chrono::milliseconds msToWait = std::chrono::milliseconds(0))
const = 0;
104 virtual const std::string&
getAddress()
const = 0;
114 std::string_view errorString) = 0;
275 std::chrono::milliseconds msToWait) = 0;
337 std::string_view key,
338 std::string_view type,
339 std::string_view units) = 0;
346 std::string_view key)
const = 0;
358 std::string_view key,
359 std::string_view type,
360 std::string_view units) = 0;
441 uint32_t* inputIndex =
nullptr) = 0;
447 virtual const std::vector<std::shared_ptr<const SmallBuffer>>&
472 std::string_view name,
473 std::string_view type) = 0;
482 std::string_view name,
483 std::string_view type) = 0;
490 std::string_view name)
const = 0;
504 std::string_view type_in,
505 std::string_view type_out) = 0;
519 std::string_view type_in,
520 std::string_view type_out) = 0;
532 std::string_view endpointType,
533 std::string_view units) = 0;
547 std::string_view dest,
560 std::string_view name,
603 virtual void linkEndpoints(std::string_view source, std::string_view dest) = 0;
610 virtual void addAlias(std::string_view interfaceKey, std::string_view alias) = 0;
619 virtual void dataLink(std::string_view source, std::string_view target) = 0;
630 std::string_view target) = 0;
660 std::string_view destination) = 0;
699 std::string_view destination,
748 std::shared_ptr<FilterOperator> callback) = 0;
755 std::shared_ptr<TranslatorOperator> callback) = 0;
766 std::function<
void(
int, std::string_view, std::string_view)> logFunction) = 0;
772 virtual void setLogFile(std::string_view lfile) = 0;
779 virtual void setGlobal(std::string_view valueName, std::string_view value) = 0;
790 std::string_view commandStr,
791 std::string_view source,
826 std::function<std::string(std::string_view)> queryFunction) = 0;
855 std::string_view 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 processCommunications(LocalFederateId fedId, std::chrono::milliseconds msToWait)=0
virtual void setTimeProperty(LocalFederateId federateID, int32_t property, Time timeValue)=0
virtual InterfaceHandle getEndpoint(LocalFederateId federateID, std::string_view name) const =0
virtual uint64_t receiveCountAny(LocalFederateId federateID)=0
constexpr auto NO_ITERATION
simplified alias to indicate that no iterations are needed
Definition: CoreTypes.hpp:112
virtual InterfaceHandle getPublication(LocalFederateId federateID, std::string_view key) const =0
virtual void setCoreReadyToInit()=0
virtual void finalize(LocalFederateId federateID)=0
virtual void setInterfaceTag(InterfaceHandle handle, std::string_view tag, std::string_view value)=0
virtual InterfaceHandle getInput(LocalFederateId federateID, std::string_view key) const =0
virtual const std::vector< InterfaceHandle > & getValueUpdates(LocalFederateId federateID)=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 int32_t getHandleOption(InterfaceHandle handle, int32_t option) const =0
virtual std::string query(std::string_view target, std::string_view queryStr, HelicsSequencingModes mode)=0
virtual const std::string & getSourceTargets(InterfaceHandle handle) const =0
virtual void configureFromArgs(int argc, char *argv[])=0
InterfaceType
Definition: CoreTypes.hpp:99
virtual void setIntegerProperty(LocalFederateId federateID, int32_t property, int16_t propValue)=0
virtual void logMessage(LocalFederateId federateID, int logLevel, std::string_view messageToLog)=0
virtual InterfaceHandle registerEndpoint(LocalFederateId federateID, std::string_view name, std::string_view type)=0
Definition: LocalFederateId.hpp:65
virtual bool isConfigured() const =0
virtual InterfaceHandle registerPublication(LocalFederateId federateID, std::string_view key, std::string_view type, std::string_view units)=0
TimeRepresentation< count_time< 9 > > Time
Definition: helicsTime.hpp:27
virtual std::unique_ptr< Message > receive(InterfaceHandle destination)=0
virtual void sendCommand(std::string_view target, std::string_view commandStr, std::string_view source, HelicsSequencingModes mode)=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 InterfaceHandle registerCloningFilter(std::string_view filterName, std::string_view type_in, std::string_view type_out)=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 int32_t getFederationSize()=0
virtual void setValue(InterfaceHandle handle, const char *data, uint64_t len)=0
virtual const std::string & getAddress() const =0
virtual void setQueryCallback(LocalFederateId federateID, std::function< std::string(std::string_view)> queryFunction)=0
virtual void setGlobal(std::string_view valueName, std::string_view value)=0
virtual void localError(LocalFederateId federateID, int32_t errorCode, std::string_view errorString)=0
Definition: core/Core.hpp:41
virtual InterfaceHandle getTranslator(std::string_view name) const =0
virtual void addSourceFilterToEndpoint(std::string_view filter, std::string_view target)=0
virtual const std::string & getDestinationTargets(InterfaceHandle handle) const =0
virtual const std::string & getExtractionType(InterfaceHandle handle) const =0
virtual bool isConnected() const =0
virtual void sendMessage(InterfaceHandle sourceHandle, std::unique_ptr< Message > message)=0
virtual LocalFederateId getFederateId(std::string_view name) const =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:92
virtual Time timeRequest(LocalFederateId federateID, Time next)=0
virtual void setLogFile(std::string_view lfile)=0
virtual std::pair< std::string, std::string > getCommand(LocalFederateId federateID)=0
virtual const std::string & getInjectionType(InterfaceHandle handle) const =0
virtual void setFlagOption(LocalFederateId federateID, int32_t flag, bool flagValue)=0
virtual void sendAt(InterfaceHandle sourceHandle, const void *data, uint64_t length, Time time)=0
IterationResult
Definition: CoreTypes.hpp:83
virtual const std::string & getInjectionUnits(InterfaceHandle handle) const =0
virtual InterfaceHandle registerTranslator(std::string_view translatorName, std::string_view endpointType, std::string_view units)=0
virtual iteration_time requestTimeIterative(LocalFederateId federateID, Time next, IterationRequest iterate)=0
virtual void configure(std::string_view configureString)=0
HelicsSequencingModes
Definition: helics_enums.h:395
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 const std::string & getIdentifier() const =0
virtual void linkEndpoints(std::string_view source, std::string_view dest)=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 void globalError(LocalFederateId federateID, int32_t errorCode, std::string_view errorString)=0
virtual const std::string & getFederateName(LocalFederateId federateID) const =0
virtual void setLoggingLevel(int logLevel)=0
virtual void addAlias(std::string_view interfaceKey, std::string_view alias)=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 setInterfaceInfo(InterfaceHandle handle, std::string_view info)=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
Definition: helicsTime.hpp:49
virtual InterfaceHandle registerTargetedEndpoint(LocalFederateId federateID, std::string_view name, std::string_view type)=0
Definition: LocalFederateId.hpp:22
virtual InterfaceHandle registerFilter(std::string_view filterName, std::string_view type_in, std::string_view 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 void dataLink(std::string_view source, std::string_view target)=0
virtual const std::string & getFederateTag(LocalFederateId fid, std::string_view tag) const =0
virtual int16_t getIntegerProperty(LocalFederateId federateID, int32_t property) const =0
virtual const std::string & getInterfaceTag(InterfaceHandle handle, std::string_view tag) const =0
virtual InterfaceHandle registerInput(LocalFederateId federateID, std::string_view key, std::string_view type, std::string_view units)=0
virtual void setLoggingCallback(LocalFederateId federateID, std::function< void(int, std::string_view, std::string_view)> logFunction)=0
virtual void addDestinationFilterToEndpoint(std::string_view filter, std::string_view target)=0
virtual void setFederateTag(LocalFederateId fid, std::string_view tag, std::string_view value)=0
virtual InterfaceHandle getFilter(std::string_view name) const =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 LocalFederateId registerFederate(std::string_view name, const CoreFederateInfo &info)=0
virtual void setTranslatorOperator(InterfaceHandle translator, std::shared_ptr< TranslatorOperator > callback)=0
virtual void addDependency(LocalFederateId federateID, std::string_view federateName)=0
virtual std::pair< std::string, std::string > waitCommand(LocalFederateId federateID)=0