Nextsim::Iterator::Iterant Class Reference

A base class for classes that specify what happens during one timestep. More...

#include <Iterator.hpp>

Inheritance diagram for Nextsim::Iterator::Iterant:

Collaboration diagram for Nextsim::Iterator::Iterant:

Public Member Functions
	Iterant (const Iterant &copyFrom)=default
Iterant &	operator= (const Iterant &copyFrom)=default
	Iterant (Iterant &&)=default
Iterant &	operator= (Iterant &&)=default
virtual void	init ()=0
	Initializes the model, based on some environment stored in the implementing class.
virtual void	start (const TimePoint &startTime)=0
virtual void	iterate (const TimestepTime &dt)=0
virtual void	stop (const TimePoint &stopTime)=0

Detailed Description

A base class for classes that specify what happens during one timestep.

Definition at line 76 of file Iterator.hpp.

Member Function Documentation

init()

virtual void Nextsim::Iterator::Iterant::init ( )

pure virtual

Initializes the model, based on some environment stored in the implementing class.

Implemented in Nextsim::Counterant, Nextsim::DevStep, and Nextsim::IModelStep.

iterate()

virtual void Nextsim::Iterator::Iterant::iterate ( const TimestepTime & dt )

pure virtual

Performs one iteration a specified length

Parameters

dt	The length of the timestep.

Implemented in Nextsim::Counterant, Nextsim::DevStep, and Nextsim::IModelStep.

Here is the caller graph for this function:

start()

virtual void Nextsim::Iterator::Iterant::start ( const TimePoint & startTime )

pure virtual

Initializes the iterant based on the start time.

Parameters

startTime

the time at the initialization of the iterant.

Implemented in Nextsim::Counterant, Nextsim::DevStep, and Nextsim::IModelStep.

Here is the caller graph for this function:

stop()

virtual void Nextsim::Iterator::Iterant::stop ( const TimePoint & stopTime )

pure virtual

Finalizes the iterant based on the stop time.

Parameters

stopTime

the time at the finalization of the iterant.

Implemented in Nextsim::Counterant, Nextsim::DevStep, and Nextsim::IModelStep.

Here is the caller graph for this function:

---

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

• /github/workspace/core/src/include/Iterator.hpp