inra.ijpb.algo

Class AlgoEvent

java.lang.Object

inra.ijpb.algo.AlgoEvent

public class AlgoEvent
extends Object

An event class for storing information about the status and progression of an algorithm.

Author:

David Legland

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	source The algorithm object that threw this event
protected String	status
protected double	step
protected double	total

Constructor Summary

Constructors

Constructor and Description
AlgoEvent(Object source, double step, double total) Creates a new AlgoEvent.
AlgoEvent(Object source, String status) Creates a new AlgoEvent.
AlgoEvent(Object source, String status, double step, double total) Creates a new AlgoEvent.

Method Summary

Modifier and Type	Method and Description
double	getCurrentProgress()
double	getProgressRatio()
Object	getSource()
String	getStatus()
double	getTotalProgress()

Methods inherited from class java.lang.Object

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

Field Detail

source

protected Object source

The algorithm object that threw this event

status

protected String status

step

protected double step

total

protected double total

Constructor Detail

AlgoEvent

public AlgoEvent(Object source,
                 String status,
                 double step,
                 double total)

Creates a new AlgoEvent.

Parameters:

source - the object generating the event

status - the status message

step - the progression step

total - the total amount of progression step

AlgoEvent

public AlgoEvent(Object source,
                 String status)

Creates a new AlgoEvent.

Parameters:

source - the object generating the event

status - the status message

AlgoEvent

public AlgoEvent(Object source,
                 double step,
                 double total)

Creates a new AlgoEvent.

Parameters:

source - the object generating the event

step - the progression step

total - the total amount of progression step

Method Detail

getSource

public Object getSource()

Returns:

the source object

getStatus

public String getStatus()

Returns:

the current status of the algorithm

getCurrentProgress

public double getCurrentProgress()

Returns:

the current progression of the algorithm

getTotalProgress

public double getTotalProgress()

Returns:

the total progression of the algorithm

getProgressRatio

public double getProgressRatio()

Returns:

the progress ratio, as the ratio of current progression over total progression.