helics::NullFederateOperator Class Reference

#include <core-data.hpp>

Inheritance diagram for helics::NullFederateOperator:

Public Member Functions
virtual IterationRequest	initializeOperations () override
virtual std::pair< Time, IterationRequest >	operate (iteration_time newTime) override
Public Member Functions inherited from helics::FederateOperator
virtual	~FederateOperator ()=default
virtual void	finalize ()
virtual void	error_handler (int error_code, std::string_view errorString)

Detailed Description

class defining a federate that does nothing

Member Function Documentation

initializeOperations()

virtual IterationRequest helics::NullFederateOperator::initializeOperations ( )

inlineoverridevirtual

perform any initialization operations

Returns

an iteration request if the federate desires to iterate on the enterExecutingMode operation

Implements helics::FederateOperator.

References helics::NO_ITERATIONS.

operate()

virtual std::pair< Time, IterationRequest > helics::NullFederateOperator::operate ( iteration_time  newTime )

inlineoverridevirtual

operate a federate timestep

Parameters

newTime

the current time grant of the federate

Returns

a pair of values with a new request time and the iteration results

Implements helics::FederateOperator.

References helics::NO_ITERATIONS.

---

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

• core-data.hpp