helics
3.5.2
|
#include <Federate.hpp>
Public Member Functions | |
FederateInfo () | |
FederateInfo (const std::string &coretype) | |
FederateInfo (int coretype) | |
FederateInfo (const FederateInfo &fedInfo) | |
FederateInfo & | operator= (const FederateInfo &fedInfo) |
~FederateInfo () | |
void | loadFromArgs (const std::string &argString) |
void | setCoreName (const std::string &corename) |
void | setSeparator (char sep) |
Set the separator character. | |
void | setCoreInit (const std::string &coreInit) |
void | setBrokerInit (const std::string &brokerInit) |
Set a string for the broker initialization in command line argument format. | |
void | setCoreType (const std::string &coretype) |
void | setCoreType (int coretype) |
void | setBroker (const std::string &broker) |
void | setBrokerKey (const std::string &brokerkey) |
void | setFlagOption (int flag, bool value=true) |
void | setProperty (int timeProperty, HelicsTime timeValue) |
void | setProperty (int integerProperty, int propertyValue) |
HelicsFederateInfo | getInfo () |
hold federate information in the C++98 API
|
inline |
constructor
References helicsCreateFederateInfo().
|
inlineexplicit |
construct from a type string
coretype | the type of core to use for the federate |
References helicsCreateFederateInfo(), and helicsFederateInfoSetCoreTypeFromString().
|
inlineexplicit |
construct from a type
coretype | the type of core to use for the federate |
References helicsCreateFederateInfo(), and helicsFederateInfoSetCoreType().
|
inline |
copy constructor for federate info
References helicsFederateClone().
|
inline |
destructor
References helicsFederateInfoFree().
|
inline |
get the underlying HelicsFederateInfo object
Referenced by helicscpp::CombinationFederate::CombinationFederate(), helicscpp::MessageFederate::MessageFederate(), and helicscpp::ValueFederate::ValueFederate().
|
inline |
copy assignment for federateInfo
References helicsFederateClone(), and helicsFederateInfoFree().
|
inline |
set the broker to connect with
broker | a string with the broker connection information or name |
References helicsFederateInfoSetBroker().
|
inline |
set the broker key to use
brokerkey | a string with the broker key information |
References helicsFederateInfoSetBrokerKey().
|
inline |
set the core init string to use in the federateInfo
coreInit | the core name to use |
References helicsFederateInfoSetCoreInitString().
|
inline |
set the core name to use in the federateInfo
corename | the core name to use |
References helicsFederateInfoSetCoreName().
|
inline |
set the core type from a string with the core type
coretype | the string defining a core type |
References helicsFederateInfoSetCoreTypeFromString().
|
inline |
set the core type from an integer HelicsCoreTypes
coretype | an integer code with the federate type |
References helicsFederateInfoSetCoreType().
|
inline |
set a flag
flag | /ref helics_federate_flags |
value | the value of the flag usually HELICS_TRUE or HELICS_FALSE |
References HELICS_FALSE, HELICS_TRUE, and helicsFederateInfoSetFlagOption().
|
inline |
set an integral federate or core property
integerProperty | /ref helics_federate_properties an integer code with the property |
propertyValue | the value to set the property to |
References helicsFederateInfoSetIntegerProperty().
|
inline |
set a time federate or core property
timeProperty | /ref helics_federate_properties an integer code with the property |
timeValue | the value to set the property to |
References helicsFederateInfoSetTimeProperty().