#include <Federate.hpp>

Inheritance diagram for helicscpp::Federate:

Public Member Functions
	Federate () HELICS_NOTHROW
	Default constructor.

	Federate (const Federate &fedObj)
	Copy constructor.

Federate &	operator= (const Federate &fedObj)
	Copy assignment operator.

virtual	~Federate ()

	operator HelicsFederate () const

HELICS_NODISCARD HelicsFederate	baseObject () const

void	setFlagOption (int flag, bool flagValue=true)

void	setProperty (int tProperty, HelicsTime timeValue)

void	setProperty (int intProperty, int value)

HELICS_NODISCARD bool	getFlagOption (int flag) const

HELICS_NODISCARD HelicsTime	getTimeProperty (int tProperty) const

HELICS_NODISCARD int	getIntegerProperty (int intProperty) const

void	setSeparator (char sep)

void	registerInterfaces (const std::string &configString)

HELICS_NODISCARD HelicsFederateState	getCurrentMode () const

HELICS_NODISCARD bool	isAsyncOperationCompleted () const

void	enterInitializingMode ()

void	enterInitializingModeAsync ()

void	enterInitializingModeComplete ()

void	enterInitializingModeIterative ()

void	enterInitializingModeIterativeAsync ()

void	enterInitializingModeIterativeComplete ()

HelicsIterationResult	enterExecutingMode (HelicsIterationRequest iterate=HELICS_ITERATION_REQUEST_NO_ITERATION)

void	enterExecutingModeAsync (HelicsIterationRequest iterate=HELICS_ITERATION_REQUEST_NO_ITERATION)

HelicsIterationResult	enterExecutingModeComplete ()

void	finalize ()

void	finalizeAsync ()

void	finalizeComplete ()

HELICS_NODISCARD HelicsTime	getCurrentTime ()

HelicsTime	requestTime (HelicsTime time)

HelicsTime	requestNextStep ()

HelicsTime	requestTimeAdvance (HelicsTime timeDelta)

HelicsIterationTime	requestTimeIterative (HelicsTime time, HelicsIterationRequest iterate)

void	requestTimeAsync (HelicsTime time)

void	requestTimeIterativeAsync (HelicsTime time, HelicsIterationRequest iterate)

HelicsTime	requestTimeComplete ()

HelicsIterationTime	requestTimeIterativeComplete ()

void	processCommunication (HelicsTime period)

HELICS_NODISCARD const char *	getName () const

void	protect ()

void	unProtect ()

std::string	query (const std::string &target, const std::string &queryStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST) const

std::string	query (const std::string &queryStr, HelicsSequencingModes mode=HELICS_SEQUENCING_MODE_FAST) const

void	sendCommand (const std::string &target, const std::string &cmd)

HELICS_NODISCARD const char *	getCommand ()

HELICS_NODISCARD const char *	waitCommand ()

HELICS_NODISCARD const char *	getCommandSource ()

void	setQueryCallback (void(queryAnswer)(const char query, int querySize, HelicsQueryBuffer, void userdata), void userdata)

void	setTimeRequestEntryCallback (void(timeRequestEntry)(HelicsTime currentTime, HelicsTime requestTime, HelicsBool iterating, void userdata), void *userdata)

void	setTimeUpdateCallback (void(timeUpdate)(HelicsTime time, HelicsBool iterating, void userdata), void *userdata)

void	setStateChangeCallback (void(stateChange)(HelicsFederateState newState, HelicsFederateState oldState, void userdata), void *userdata)

void	setTimeRequestReturnCallback (void(timeRequestReturn)(HelicsTime newTime, HelicsBool iterating, void userdata), void *userdata)

Filter	registerFilter (HelicsFilterTypes type, const std::string &filterName=std::string())

CloningFilter	registerCloningFilter (const std::string &deliveryEndpoint)

Filter	registerGlobalFilter (HelicsFilterTypes type, const std::string &filterName=std::string())

CloningFilter	registerGlobalCloningFilter (const std::string &deliveryEndpoint)

HELICS_NODISCARD int	getFilterCount () const

HELICS_NODISCARD Filter	getFilter (const std::string &filterName)

HELICS_NODISCARD Filter	getFilter (int index)

void	setGlobal (const std::string &valueName, const std::string &value)

void	addAlias (const std::string &interfaceName, const std::string &alias)

void	setTag (const std::string &tag, const std::string &value)

HELICS_NODISCARD const char *	getTag (const std::string &tag) const

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_NODISCARD HelicsCore	getCore ()

HELICS_NODISCARD HelicsFederate	getObject () const

Protected Attributes
HelicsFederate	fed
	underlying HelicsFederate object

bool	exec_async_iterate
	indicator that the federate is in an async operation

Detailed Description

Federate object managing a C++98 Federate object

Constructor & Destructor Documentation

◆ ~Federate()

virtual helicscpp::Federate::~Federate ( )

inlinevirtual

destructor

References fed, and helicsFederateFree().

Member Function Documentation

◆ addAlias()

void helicscpp::Federate::addAlias	(	const std::string &	interfaceName,
		const std::string &	alias
	)

inline

add a global alias for an interface

Parameters

interfaceName	the given name of the interface
alias	the new name by which the interface can be referenced

References fed.

◆ addDependency()

void helicscpp::Federate::addDependency ( const std::string & fedName )

inline

add a dependency for this federate

adds an additional internal time dependency for the federate

Parameters

fedName the name of the federate to add a dependency on

References fed.

◆ baseObject()

HELICS_NODISCARD HelicsFederate helicscpp::Federate::baseObject ( ) const

inline

get the underlying HelicsFederate object

References fed.

◆ enterExecutingMode()

HelicsIterationResult helicscpp::Federate::enterExecutingMode ( HelicsIterationRequest iterate = HELICS_ITERATION_REQUEST_NO_ITERATION )

inline

enter the normal execution mode

call will block until all federates have entered this mode

Parameters

iterate an optional flag indicating the desired iteration mode

References fed, HELICS_ITERATION_REQUEST_NO_ITERATION, and HELICS_ITERATION_RESULT_NEXT_STEP.

◆ enterExecutingModeAsync()

void helicscpp::Federate::enterExecutingModeAsync ( HelicsIterationRequest iterate = HELICS_ITERATION_REQUEST_NO_ITERATION )

inline

enter the normal execution mode

call will return immediately but enterExecutingModeComplete should be called to complete the operation

Parameters

iterate an optional flag indicating the desired iteration mode

References exec_async_iterate, fed, and HELICS_ITERATION_REQUEST_NO_ITERATION.

◆ enterExecutingModeComplete()

HelicsIterationResult helicscpp::Federate::enterExecutingModeComplete ( )

inline

complete the async call for entering Execution state

call will not block but will return quickly. The enterInitializingModeComplete must be called before doing other operations

References exec_async_iterate, fed, and HELICS_ITERATION_RESULT_NEXT_STEP.

◆ enterInitializingMode()

void helicscpp::Federate::enterInitializingMode ( )

inline

enter the initialization mode after all interfaces have been defined

the call will block until all federates have entered initialization mode

References fed.

◆ enterInitializingModeAsync()

void helicscpp::Federate::enterInitializingModeAsync ( )

inline

enter the initialization mode after all interfaces have been defined

the call will not block but a call to enterInitializingModeComplete should be made to complete the call sequence

References fed.

◆ enterInitializingModeComplete()

void helicscpp::Federate::enterInitializingModeComplete ( )

inline

second part of the async process for entering initializationState call after a call to enterInitializingModeAsync if call any other time it will throw an InvalidFunctionCall exception

References fed.

◆ enterInitializingModeIterative()

void helicscpp::Federate::enterInitializingModeIterative ( )

inline

iterate in the created mode.

the call will block until all federates have flagged they are ready for the next stage of initialization all federates requesting iterations on the created mode will be notified they can continue with setup.

References fed.

◆ enterInitializingModeIterativeAsync()

void helicscpp::Federate::enterInitializingModeIterativeAsync ( )

inline

iterate in the created mode.

the call will not block but a call to enterInitializingModeIterativeComplete should be made to complete the call sequence

References fed.

◆ enterInitializingModeIterativeComplete()

void helicscpp::Federate::enterInitializingModeIterativeComplete ( )

inline

second part of the async process for entering initializationModeIterative call after a call to enterInitializingModeIterativeAsync; if called any other time it will throw an InvalidFunctionCall exception

References fed.

◆ finalize()

void helicscpp::Federate::finalize ( )

inline

terminate the simulation

call is will block until the finalize has been acknowledged, no commands that interact with the core may be called after this function function

References fed.

◆ finalizeAsync()

void helicscpp::Federate::finalizeAsync ( )

inline

terminate the simulation in a non-blocking call

finalizeComplete must be called after this call to complete the finalize procedure

References fed.

◆ finalizeComplete()

void helicscpp::Federate::finalizeComplete ( )

inline

complete the asynchronous terminate pair

References fed.

◆ getCommand()

HELICS_NODISCARD const char * helicscpp::Federate::getCommand ( )

inline

Get a command sent to the federate.

Returns: A string with the command for the federate, if the string is empty no command is available.

References fed.

◆ getCommandSource()

HELICS_NODISCARD const char * helicscpp::Federate::getCommandSource ( )

inline

Get the source of the most recently retrieved command sent to the federate.

Returns: A string with the command for the federate, if the string is empty no command is available.

References fed.

◆ getCore()

HELICS_NODISCARD HelicsCore helicscpp::Federate::getCore ( )

inline

get a Core Object

References fed.

◆ getCurrentMode()

HELICS_NODISCARD HelicsFederateState helicscpp::Federate::getCurrentMode ( ) const

inline

get the current state of the federate

References fed.

◆ getCurrentTime()

HELICS_NODISCARD HelicsTime helicscpp::Federate::getCurrentTime ( )

inline

get the current time from a federate

References fed.

◆ getFilter() [1/2]

HELICS_NODISCARD Filter helicscpp::Federate::getFilter ( const std::string & filterName )

inline

get the id of a source filter from the name of the endpoint

Parameters

filterName the name of the filter

Returns: a reference to a filter object which could be invalid if filterName is not valid

References fed, and helicsFederateGetFilter().

◆ getFilter() [2/2]

HELICS_NODISCARD Filter helicscpp::Federate::getFilter ( int index )

inline

get a filter from its index

Parameters

index the index of a filter

Returns: a reference to a filter object which could be invalid if filterName is not valid

References fed, and helicsFederateGetFilterByIndex().

◆ getFilterCount()

HELICS_NODISCARD int helicscpp::Federate::getFilterCount ( ) const

inline

get a count of the number of filters registered in a federate

References fed, and helicsFederateGetFilterCount().

◆ getFlagOption()

HELICS_NODISCARD bool helicscpp::Federate::getFlagOption ( int flag ) const

inline

get the value of a flag option

Parameters

flag	an index into the flag /ref flag-definitions.h

References fed, and HELICS_FALSE.

◆ getIntegerProperty()

HELICS_NODISCARD int helicscpp::Federate::getIntegerProperty ( int intProperty ) const

inline

get an integer option for the federate

Parameters

intProperty the option to inquire

References fed.

◆ getName()

HELICS_NODISCARD const char * helicscpp::Federate::getName ( ) const

inline

get the federate name

References fed.

◆ getObject()

HELICS_NODISCARD HelicsFederate helicscpp::Federate::getObject ( ) const

inline

get the C object for use in the C library

References fed.

Referenced by helicscpp::Message::newMessageObject().

◆ getTag()

HELICS_NODISCARD const char * helicscpp::Federate::getTag ( const std::string & tag ) const

inline

get the value of a specific tag (key-value pair) for a federate

the tag is an arbitrary user defined string and value; the tags for a federate are queryable

Parameters

tag	the name of the tag to get the value for

Returns: a const char * containing the text value of the tag, if the tag is not defined the value is a length 0 string

References fed.

◆ getTimeProperty()

HELICS_NODISCARD HelicsTime helicscpp::Federate::getTimeProperty ( int tProperty ) const

inline

get the value of a time option for the federate

Parameters

tProperty the option to get

References fed.

◆ globalError()

void helicscpp::Federate::globalError	(	int	errorCode,
		const std::string &	errorString
	)

inline

generate a global error to terminate the federation

Parameters

errorCode	an error code to give to the error
errorString	a string message associated with the error

References fed.

◆ isAsyncOperationCompleted()

HELICS_NODISCARD bool helicscpp::Federate::isAsyncOperationCompleted ( ) const

inline

called after one of the async calls and will indicate true if an async operation has completed

this should only be called from the same thread as the one that called the initial async call and will return false if called when no async operation is in flight

References fed, and HELICS_FALSE.

◆ localError()

void helicscpp::Federate::localError	(	int	errorCode,
		const std::string &	errorString
	)

inline

generate a local federate error

Parameters

errorCode	an error code to give to the error
errorString	a string message associated with the error

References fed.

◆ logDebugMessage()

void helicscpp::Federate::logDebugMessage ( const std::string & message )

inline

log a debug message

References fed.

◆ logErrorMessage()

void helicscpp::Federate::logErrorMessage ( const std::string & message )

inline

log an error message

References fed.

◆ logInfoMessage()

void helicscpp::Federate::logInfoMessage ( const std::string & message )

inline

log an info message

References fed.

◆ logMessage()

void helicscpp::Federate::logMessage	(	int	level,
		const std::string &	message
	)

inline

log a message with a specified log level

References fed.

◆ logWarningMessage()

void helicscpp::Federate::logWarningMessage ( const std::string & message )

inline

log a warning message

References fed.

◆ operator HelicsFederate()

helicscpp::Federate::operator HelicsFederate ( ) const

inline

cast operator to get the underlying HelicsFederate object

References fed.

◆ protect()

void helicscpp::Federate::protect ( )

inline

protect the federate and make it retrievable even if not library objects exist

References fed.

◆ query() [1/2]

std::string helicscpp::Federate::query	(	const std::string &	queryStr,
		HelicsSequencingModes	mode = `HELICS_SEQUENCING_MODE_FAST`
	)		const

inline

make a query of the federate

this call is blocking until the value is returned which may take some time depending on the size of the federation and the specific string being queried, query without a target assumes the target is the federate

Parameters

queryStr	a string with the query, see other documentation for specific properties to query, can be defined by the federate
mode	the ordering mode to use for the query (fast for priority channels, ordered for normal channels ordered with all other messages)

Returns: a string with the value requested. this is either going to be a vector of strings value or a JSON string stored in the first element of the vector. The string "#invalid" is returned if the query was not valid

References fed, HELICS_SEQUENCING_MODE_FAST, helicsCreateQuery(), helicsQueryExecute(), helicsQueryFree(), and helicsQuerySetOrdering().

◆ query() [2/2]

std::string helicscpp::Federate::query	(	const std::string &	target,
		const std::string &	queryStr,
		HelicsSequencingModes	mode = `HELICS_SEQUENCING_MODE_FAST`
	)		const

inline

make a query of the federate

this call is blocking until the value is returned which make take some time depending on the size of the federation and the specific string being queried

Parameters

target	the target of the query can be "federation", "federate", "broker", "core", or a specific name of a federate, core, or broker
queryStr	a string with the query see other documentation for specific properties to query, can be defined by the federate
mode	the ordering mode to use for the query (fast for priority channels, ordered for normal channels ordered with all other messages)

Returns: a string with the value requested. this is either going to be a vector of strings value or a JSON string stored in the first element of the vector. The string "#invalid" is returned if the query was not valid

References fed, HELICS_SEQUENCING_MODE_FAST, helicsCreateQuery(), helicsQueryExecute(), helicsQueryFree(), and helicsQuerySetOrdering().

◆ registerCloningFilter()

CloningFilter helicscpp::Federate::registerCloningFilter ( const std::string & deliveryEndpoint )

inline

create a cloning Filter on the specified federate

cloning filters copy a message and send it to multiple locations source and destination can be added through other functions

Parameters

deliveryEndpoint the specified endpoint to deliver the message

Returns: a HelicsFilter object

References fed, and helicsFederateRegisterCloningFilter().

◆ registerFilter()

Filter helicscpp::Federate::registerFilter	(	HelicsFilterTypes	type,
		const std::string &	filterName = `std::string()`
	)

inline

define a filter interface

a filter will modify messages coming from or going to target endpoints

Parameters

type	the type of the filter to register
filterName	the name of the filter

References fed, and helicsFederateRegisterFilter().

◆ registerGlobalCloningFilter()

CloningFilter helicscpp::Federate::registerGlobalCloningFilter ( const std::string & deliveryEndpoint )

inline

create a cloning Filter on the specified federate

cloning filters copy a message and send it to multiple locations source and destination can be added through other functions

Parameters

deliveryEndpoint the specified endpoint to deliver the message

Returns: a CloningFilter object

References fed, and helicsFederateRegisterGlobalCloningFilter().

◆ registerGlobalFilter()

Filter helicscpp::Federate::registerGlobalFilter	(	HelicsFilterTypes	type,
		const std::string &	filterName = `std::string()`
	)

inline

define a filter interface

a filter will modify messages coming from or going to target endpoints

Parameters

type	the type of the filter to register
filterName	the name of the filter

References fed, and helicsFederateRegisterGlobalFilter().

◆ registerInterfaces()

void helicscpp::Federate::registerInterfaces ( const std::string & configString )

inline

register a set of interfaces defined in a file

call is only valid in startup mode

Parameters

configString the location of the file or config String to load to generate the interfaces

References fed.

◆ requestNextStep()

HelicsTime helicscpp::Federate::requestNextStep ( )

inline

request a time advancement to the next allowed time

Returns: the granted time step

References fed.

◆ requestTime()

HelicsTime helicscpp::Federate::requestTime ( HelicsTime time )

inline

request a time advancement

Parameters

time	the next requested time step

Returns: the granted time step

References fed.

◆ requestTimeAdvance()

HelicsTime helicscpp::Federate::requestTimeAdvance ( HelicsTime timeDelta )

inline

request a time advancement to the next allowed time

Parameters

timeDelta the amount of time requested to advance

Returns: the granted time step

References fed.

◆ requestTimeAsync()

void helicscpp::Federate::requestTimeAsync ( HelicsTime time )

inline

request a time advancement and return immediately for asynchronous function.

/ref requestTimeComplete should be called to finish the operation and get the result

Parameters

time	the next requested time step

References fed.

◆ requestTimeComplete()

HelicsTime helicscpp::Federate::requestTimeComplete ( )

inline

request a time advancement

Returns: the granted time step

References fed.

◆ requestTimeIterative()

HelicsIterationTime helicscpp::Federate::requestTimeIterative	(	HelicsTime	time,
		HelicsIterationRequest	iterate
	)

inline

request a time advancement

Parameters

time	the next requested time step
iterate	a requested iteration mode

Returns: the granted time step in a structure containing a return time and an IterationResult

References fed, helicscpp::HelicsIterationTime::grantedTime, and helicscpp::HelicsIterationTime::status.

◆ requestTimeIterativeAsync()

void helicscpp::Federate::requestTimeIterativeAsync	(	HelicsTime	time,
		HelicsIterationRequest	iterate
	)

inline

request a time advancement with iterative call and return for asynchronous function.

/ref requestTimeIterativeComplete should be called to finish the operation and get the result

Parameters

time	the next requested time step
iterate	a requested iteration level (none, require, optional)

References fed.

◆ requestTimeIterativeComplete()

HelicsIterationTime helicscpp::Federate::requestTimeIterativeComplete ( )

inline

finalize the time advancement request

Returns: the granted time step in an iteration_time structure which contains a time and iteration result

References fed, helicscpp::HelicsIterationTime::grantedTime, and helicscpp::HelicsIterationTime::status.

◆ sendCommand()

void helicscpp::Federate::sendCommand	(	const std::string &	target,
		const std::string &	cmd
	)

inline

Send a command to another HELICS object through a federate.

Parameters

target	The name of the object to send the command to.
cmd	The command to send.

References fed.

◆ setFlagOption()

void helicscpp::Federate::setFlagOption	(	int	flag,
		bool	flagValue = `true`
	)

inline

set a flag for the federate

Parameters

flag	an index into the flag /ref flag-definitions.h
flagValue	the value of the flag defaults to true

References fed, HELICS_FALSE, and HELICS_TRUE.

◆ setGlobal()

void helicscpp::Federate::setGlobal	(	const std::string &	valueName,
		const std::string &	value
	)

inline

set a federation global value

this overwrites any previous value for this name

Parameters

valueName	the name of the global to set
value	the value of the global

References fed.

◆ setProperty() [1/2]

void helicscpp::Federate::setProperty	(	int	intProperty,
		int	value
	)

inline

set an integer option for the federate

Parameters

intProperty	an index of the option to set
value	an integer option value for an integer based property

References fed.

◆ setProperty() [2/2]

void helicscpp::Federate::setProperty	(	int	tProperty,
		HelicsTime	timeValue
	)

inline

set a time property option for the federate

Parameters

tProperty	an index of the option to set
timeValue	and integer option value for an integer based property

References fed.

◆ setSeparator()

void helicscpp::Federate::setSeparator ( char sep )

inline

specify a separator to use for naming separation between the federate name and the interface name setSeparator('.') will result in future registrations of local endpoints such as fedName.endpoint setSeparator('/') will result in fedName/endpoint the default is '/' any character can be used though many will not make that much sense. This call is not thread safe and should be called before any local interfaces are created otherwise it may not be possible to retrieve them without using the full name. recommended possibilities are ('.','/', ':','-','_')

References fed.

◆ setTag()

void helicscpp::Federate::setTag	(	const std::string &	tag,
		const std::string &	value
	)

inline

set a tag (key-value pair) for a federate

the tag is an arbitrary user defined string and value; the tags for a federate are queryable through a "tags" query or "tag/<tagname>"

Parameters

tag	the name of the tag to set the value for
value	the value for the given tag

References fed.

◆ unProtect()

void helicscpp::Federate::unProtect ( )

inline

unprotect the federate and make it retrievable even if not library objects exist

References fed.

◆ waitCommand()

HELICS_NODISCARD const char * helicscpp::Federate::waitCommand ( )

inline

Get a command sent to the federate. Blocks until a command is received.

Returns: A string with the command for the federate, if the string is empty no command is available.

References fed.

The documentation for this class was generated from the following file:

cpp98/Federate.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Federate()

Member Function Documentation

◆ addAlias()

◆ addDependency()

◆ baseObject()

◆ enterExecutingMode()

◆ enterExecutingModeAsync()

◆ enterExecutingModeComplete()

◆ enterInitializingMode()

◆ enterInitializingModeAsync()

◆ enterInitializingModeComplete()

◆ enterInitializingModeIterative()

◆ enterInitializingModeIterativeAsync()

◆ enterInitializingModeIterativeComplete()

◆ finalize()

◆ finalizeAsync()

◆ finalizeComplete()

◆ getCommand()

◆ getCommandSource()

◆ getCore()

◆ getCurrentMode()

◆ getCurrentTime()

◆ getFilter() [1/2]

◆ getFilter() [2/2]

◆ getFilterCount()

◆ getFlagOption()

◆ getIntegerProperty()

◆ getName()

◆ getObject()

◆ getTag()

◆ getTimeProperty()

◆ globalError()

◆ isAsyncOperationCompleted()

◆ localError()

◆ logDebugMessage()

◆ logErrorMessage()

◆ logInfoMessage()

◆ logMessage()

◆ logWarningMessage()

◆ operator HelicsFederate()

◆ protect()

◆ query() [1/2]

◆ query() [2/2]

◆ registerCloningFilter()

◆ registerFilter()

◆ registerGlobalCloningFilter()

◆ registerGlobalFilter()

◆ registerInterfaces()

◆ requestNextStep()

◆ requestTime()

◆ requestTimeAdvance()

◆ requestTimeAsync()

◆ requestTimeComplete()

◆ requestTimeIterative()

◆ requestTimeIterativeAsync()

◆ requestTimeIterativeComplete()

◆ sendCommand()

◆ setFlagOption()

◆ setGlobal()

◆ setProperty() [1/2]

◆ setProperty() [2/2]

◆ setSeparator()

◆ setTag()

◆ unProtect()

◆ waitCommand()