org.uma.jmetal.measure.impl

Class SimplePushMeasure<Value>

java.lang.Object

org.uma.jmetal.util.naming.impl.SimpleDescribedEntity

org.uma.jmetal.measure.impl.SimpleMeasure<Value>

org.uma.jmetal.measure.impl.SimplePushMeasure<Value>

Type Parameters:

Value -

All Implemented Interfaces:

Serializable, Measure<Value>, PushMeasure<Value>, DescribedEntity

Direct Known Subclasses:

BasicMeasure, CountingMeasure, LastEvaluationMeasure

public class SimplePushMeasure<Value>
extends SimpleMeasure<Value>
implements PushMeasure<Value>

SimplePushMeasure is a basic implementation of PushMeasure. As a PushMeasure, it is intended to be fed by the algorithm while external entities should use register(MeasureListener) to be notified in real time. For the algorithm to feed it, it should provide a solution and its value to #push(Object, Object), leading to the notification of the registered observers.

Author:

Matthieu Vergne

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SimplePushMeasure() Create a SimplePushMeasure with the class name as its name and a null description.
SimplePushMeasure(String name) Create a SimplePushMeasure with a given name and a null description.
SimplePushMeasure(String name, String description) Create a SimplePushMeasure with a given name and a given description.

Method Summary

Modifier and Type	Method and Description
void	push(Value value) Notify the observers which has registered a MeasureListener through register(MeasureListener) about a value.
void	register(MeasureListener<Value> listener) Register a MeasureListener to use the Values of the PushMeasure when they are generated.
void	unregister(MeasureListener<Value> listener) Unregister a MeasureListener registered with PushMeasure.register(MeasureListener) to stop receiving the notifications of the PushMeasure.

Methods inherited from class org.uma.jmetal.util.naming.impl.SimpleDescribedEntity

getDescription, getName, setDescription, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.uma.jmetal.util.naming.DescribedEntity

getDescription, getName

Constructor Detail

SimplePushMeasure

public SimplePushMeasure(String name,
                         String description)

Create a SimplePushMeasure with a given name and a given description.

Parameters:

name - the name of the Measure

description - the description of the Measure

SimplePushMeasure

public SimplePushMeasure(String name)

Create a SimplePushMeasure with a given name and a null description.

Parameters:

name - the name of the Measure

SimplePushMeasure

public SimplePushMeasure()

Create a SimplePushMeasure with the class name as its name and a null description.

Method Detail

register

public void register(MeasureListener<Value> listener)

Description copied from interface: PushMeasure

Register a MeasureListener to use the Values of the PushMeasure when they are generated.

Specified by:

register in interface PushMeasure<Value>

Parameters:

listener - the MeasureListener to register

unregister

public void unregister(MeasureListener<Value> listener)

Description copied from interface: PushMeasure

Unregister a MeasureListener registered with PushMeasure.register(MeasureListener) to stop receiving the notifications of the PushMeasure.

Specified by:

unregister in interface PushMeasure<Value>

Parameters:

listener - the MeasureListener to unregister

push

public void push(Value value)

Notify the observers which has registered a MeasureListener through register(MeasureListener) about a value.

Parameters:

value - the value to send to the observers