| helics 3.6.1

Public Member Functions | List of all members
helics::FederateOperator Class Referenceabstract
Inheritance diagram for helics::FederateOperator:

## Public Member Functions
virtual | ~FederateOperator ()=default
virtual IterationRequest | initializeOperations ()=0
virtual std::pair< Time, IterationRequest > | operate (iteration_time newTime)=0
virtual void | finalize ()
virtual void | error_handler ([[maybe_unused]] int error_code, [[maybe_unused]] std::string_view errorString)

## Constructor & Destructor Documentation

## ◆ ~FederateOperator()

virtual helics::FederateOperator::~FederateOperator | ( |  | ) |
| virtual default

virtual destructor

## Member Function Documentation

## ◆ error_handler()

virtual void helics::FederateOperator::error_handler | ( | [[maybe_unused] ] int | error_code,
|  | [[maybe_unused] ] std::string_view | errorString
| ) |  |
| inline virtual

run any operations for handling an error

## ◆ finalize()

virtual void helics::FederateOperator::finalize | ( |  | ) |
| inline virtual

operate any final operations on the federate

## ◆ initializeOperations()

virtual IterationRequest helics::FederateOperator::initializeOperations | ( |  | ) |
| pure virtual

perform any initialization operations

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

Implemented in helics::NullFederateOperator.

## ◆ operate()

virtual std::pair<Time, IterationRequest> helics::FederateOperator::operate | ( | iteration_time | newTime | ) |
| pure virtual

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

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

- core-data.hpp