helics  2.8.1
Public Member Functions | List of all members
helicscpp::CombinationFederate Class Reference

#include <CombinationFederate.hpp>

+ Inheritance diagram for helicscpp::CombinationFederate:

Public Member Functions

 CombinationFederate (const std::string &name, FederateInfo &fi)
 
 CombinationFederate (const std::string &configString)
 
- Public Member Functions inherited from helicscpp::ValueFederate
 ValueFederate (const std::string &fedName, FederateInfo &fi)
 
 ValueFederate (const std::string &configString)
 
 ValueFederate (const ValueFederate &vfed)
 
ValueFederate & operator= (const ValueFederate &fedObj)
 
 ValueFederate () HELICS_NOTHROW
 
Publication registerPublication (const std::string &name, const std::string &type, const std::string &units="")
 
Publication registerPublication (const std::string &name, helics_data_type type, const std::string &units="")
 
Publication registerGlobalPublication (const std::string &name, const std::string &type, const std::string &units="")
 
Publication registerGlobalPublication (const std::string &key, helics_data_type type, const std::string &units="")
 
Publication registerIndexedPublication (const std::string &key, int index1, helics_data_type type, const std::string &units="")
 
Publication registerIndexedPublication (const std::string &key, int index1, int index2, helics_data_type type, const std::string &units=std::string())
 
Publication registerPublicationIndexed (const std::string &key, int index1, helics_data_type type, const std::string &units="")
 
Publication registerPublicationIndexed (const std::string &key, int index1, int index2, helics_data_type type, const std::string &units=std::string())
 
void registerFromPublicationJSON (const std::string &json)
 
Publication getPublication (const std::string &name)
 
Publication getPublication (int index)
 
Input registerSubscription (const std::string &name, const std::string &units=std::string())
 
Input registerIndexedSubscription (const std::string &name, int index1, const std::string &units="")
 
Input registerIndexedSubscription (const std::string &name, int index1, int index2, const std::string &units="")
 
Input registerSubscriptionIndexed (const std::string &name, int index1, const std::string &units="")
 
Input registerSubscriptionIndexed (const std::string &name, int index1, int index2, const std::string &units="")
 
Input registerInput (const std::string &name, const std::string &type, const std::string &units="")
 
Input registerInput (const std::string &name, helics_data_type type, const std::string &units="")
 
Input registerGlobalInput (const std::string &name, const std::string &type, const std::string &units="")
 
Input registerGlobalInput (const std::string &key, helics_data_type type, const std::string &units="")
 
Input registerIndexedInput (const std::string &key, int index1, helics_data_type type, const std::string &units="")
 
Input registerIndexedInput (const std::string &key, int index1, int index2, helics_data_type type, const std::string &units=std::string())
 
Input getInput (const std::string &name)
 
Input getSubscription (int index)
 
int getInputCount () const
 
int getPublicationCount () const
 
std::vector< helics_input > queryUpdates ()
 
void clearUpdates ()
 
void publishJSON (const std::string &json)
 
- Public Member Functions inherited from helicscpp::Federate
 Federate () HELICS_NOTHROW
 Default constructor.
 
 Federate (const Federate &fedObj)
 Copy constructor.
 
Federate & operator= (const Federate &fedObj)
 Copy assignment operator.
 
virtual ~Federate ()
 
 operator helics_federate () const
 
helics_federate baseObject () const
 
void setFlagOption (int flag, bool flagValue=true)
 
void setProperty (int tProperty, helics_time timeValue)
 
void setProperty (int intProperty, int value)
 
bool getFlagOption (int flag) const
 
helics_time getTimeProperty (int tProperty) const
 
int getIntegerProperty (int intProperty) const
 
void setSeparator (char sep)
 
void registerInterfaces (const std::string &configString)
 
helics_federate_state getCurrentMode () const
 
void enterInitializingMode ()
 
void enterInitializingModeAsync ()
 
bool isAsyncOperationCompleted () const
 
void enterInitializingModeComplete ()
 
helics_iteration_result enterExecutingMode (helics_iteration_request iterate=helics_iteration_request_no_iteration)
 
void enterExecutingModeAsync (helics_iteration_request iterate=helics_iteration_request_no_iteration)
 
helics_iteration_result enterExecutingModeComplete ()
 
void finalize ()
 
void finalizeAsync ()
 
void finalizeComplete ()
 
helics_time getCurrentTime ()
 
helics_time requestTime (helics_time time)
 
helics_time requestNextStep ()
 
helics_time requestTimeAdvance (helics_time timeDelta)
 
helics_iteration_time requestTimeIterative (helics_time time, helics_iteration_request iterate)
 
void requestTimeAsync (helics_time time)
 
void requestTimeIterativeAsync (helics_time time, helics_iteration_request iterate)
 
helics_time requestTimeComplete ()
 
helics_iteration_time requestTimeIterativeComplete ()
 
const char * getName () const
 
std::string query (const std::string &target, const std::string &queryStr, helics_sequencing_mode mode=helics_sequencing_mode_fast) const
 
std::string query (const std::string &queryStr, helics_sequencing_mode mode=helics_sequencing_mode_fast) const
 
void setQueryCallback (void(*queryAnswer)(const char *query, int querySize, helics_query_buffer, void *userdata), void *userdata)
 
Filter registerFilter (helics_filter_type type, const std::string &filterName=std::string())
 
CloningFilter registerCloningFilter (const std::string &deliveryEndpoint)
 
Filter registerGlobalFilter (helics_filter_type type, const std::string &filterName=std::string())
 
CloningFilter registerGlobalCloningFilter (const std::string &deliveryEndpoint)
 
Filter getFilter (const std::string &filterName)
 
Filter getFilter (int index)
 
void setGlobal (const std::string &valueName, const std::string &value)
 
void addDependency (const std::string &fedName)
 
void localError (int errorCode, const std::string &errorString)
 
void globalError (int errorCode, const std::string &errorString)
 
void logErrorMessage (const std::string &message)
 
void logWarningMessage (const std::string &message)
 
void logInfoMessage (const std::string &message)
 
void logDebugMessage (const std::string &message)
 
void logMessage (int level, const std::string &message)
 
helics_core getCore ()
 
helics_federate getObject () const
 
- Public Member Functions inherited from helicscpp::MessageFederate
 MessageFederate (const std::string &fedName, FederateInfo &fi)
 
 MessageFederate (const std::string &configString)
 
 MessageFederate () HELICS_NOTHROW
 
Endpoint registerEndpoint (const std::string &name, const std::string &type=std::string())
 
Endpoint registerGlobalEndpoint (const std::string &name, const std::string &type=std::string())
 
Endpoint getEndpoint (const std::string &name)
 
Endpoint getEndpoint (int index)
 
bool hasMessage () const
 
int pendingMessages () const
 
Message getMessage ()
 
Message createMessage ()
 
int getEndpointCount () const
 

Additional Inherited Members

- Protected Attributes inherited from helicscpp::Federate
helics_federate fed
 underlying helics_federate object
 
bool exec_async_iterate
 indicator that the federate is in an async operation
 

Detailed Description

combination federate object in the C++98 API

a combination federate merges a ValueFederate and a MessageFederate

Constructor & Destructor Documentation

◆ CombinationFederate() [1/2]

helicscpp::CombinationFederate::CombinationFederate ( const std::string &  name,
FederateInfo &  fi 
)
inlineexplicit

construct a combination federate

Parameters
namethe name of the federate
fithe federateInfo object to use for the construction information

References helicscpp::Federate::fed, helicscpp::FederateInfo::getInfo(), and helicsCreateCombinationFederate().

◆ CombinationFederate() [2/2]

helicscpp::CombinationFederate::CombinationFederate ( const std::string &  configString)
inlineexplicit

construct a combination Federate from a configuration string either a file or json/toml string

References helicscpp::Federate::fed, and helicsCreateCombinationFederateFromConfig().

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17