fr.cnes.sirius.patrius.math.util

Class IterationEvent

java.lang.Object

java.util.EventObject

fr.cnes.sirius.patrius.math.util.IterationEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

IterativeLinearSolverEvent

public class IterationEvent
extends EventObject

The root class from which all events occurring while running an IterationManager should be derived.

Version:

$Id: IterationEvent.java 18108 2017-10-04 06:45:27Z bignon $

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
IterationEvent(Object source, int iterationsIn) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
int	getIterations() Returns the number of iterations performed at the time this event is created.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IterationEvent

public IterationEvent(Object source,
                      int iterationsIn)

Creates a new instance of this class.

Parameters:

source - the iterative algorithm on which the event initially occurred

iterationsIn - the number of iterations performed at the time this event is created

Method Detail

getIterations

public int getIterations()

Returns the number of iterations performed at the time this event is created.

Returns:

the number of iterations performed