Nextsim::Counterant Class Reference

Inheritance diagram for Nextsim::Counterant:

Collaboration diagram for Nextsim::Counterant:

Public Member Functions
void	init ()
	Initializes the model, based on some environment stored in the implementing class.
void	start (const TimePoint &startTime)
void	iterate (const TimestepTime &tst)
void	stop (const TimePoint &stopTime)
int	getCount ()
Public Member Functions inherited from Nextsim::Iterator::Iterant
	Iterant (const Iterant &copyFrom)=default
Iterant &	operator= (const Iterant &copyFrom)=default
	Iterant (Iterant &&)=default
Iterant &	operator= (Iterant &&)=default

Public Attributes
int	count
int	startCount
int	stopCount

Detailed Description

Definition at line 16 of file Iterator_test.cpp.

Member Function Documentation

getCount()

int Nextsim::Counterant::getCount ( )

inline

Definition at line 28 of file Iterator_test.cpp.

init()

void Nextsim::Counterant::init ( )

inlinevirtual

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

Implements Nextsim::Iterator::Iterant.

Definition at line 18 of file Iterator_test.cpp.

iterate()

void Nextsim::Counterant::iterate ( const TimestepTime & dt )

inlinevirtual

Performs one iteration a specified length

Parameters

dt	The length of the timestep.

Implements Nextsim::Iterator::Iterant.

Definition at line 25 of file Iterator_test.cpp.

start()

void Nextsim::Counterant::start ( const TimePoint & startTime )

inlinevirtual

Initializes the iterant based on the start time.

Parameters

startTime

the time at the initialization of the iterant.

Implements Nextsim::Iterator::Iterant.

Definition at line 24 of file Iterator_test.cpp.

stop()

void Nextsim::Counterant::stop ( const TimePoint & stopTime )

inlinevirtual

Finalizes the iterant based on the stop time.

Parameters

stopTime

the time at the finalization of the iterant.

Implements Nextsim::Iterator::Iterant.

Definition at line 26 of file Iterator_test.cpp.

Member Data Documentation

count

int Nextsim::Counterant::count

Definition at line 30 of file Iterator_test.cpp.

startCount

int Nextsim::Counterant::startCount

Definition at line 31 of file Iterator_test.cpp.

stopCount

int Nextsim::Counterant::stopCount

Definition at line 32 of file Iterator_test.cpp.

---

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

• /github/workspace/core/test/Iterator_test.cpp