org.uma.jmetal.parameter.impl

Class MeasurableParameter<Value>

java.lang.Object

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

org.uma.jmetal.parameter.impl.MeasurableParameter<Value>

All Implemented Interfaces:

Measure<Value>, PullMeasure<Value>, PushMeasure<Value>, Parameter<Value>, DescribedEntity

public class MeasurableParameter<Value>
extends SimpleDescribedEntity
implements Parameter<Value>, PullMeasure<Value>, PushMeasure<Value>

A MeasurableParameter aims at being usable both as a Parameter and a Measure. This way, one can store it both in a ParameterManager and a MeasureManager. You can directly instantiate a fully featured MeasurableParameter with MeasurableParameter() or wrap an existing Parameter with MeasurableParameter(Parameter).

Author:

Matthieu Vergne

Constructor Summary

Constructors

Constructor and Description
MeasurableParameter() Create an autonomous MeasurableParameter.
MeasurableParameter(Parameter<Value> parameter) Create a MeasurableParameter based on an existing Parameter.

Method Summary

Modifier and Type	Method and Description
Value	get()
void	register(MeasureListener<Value> listener) Register a MeasureListener to use the Values of the PushMeasure when they are generated.
void	set(Value value)
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

MeasurableParameter

public MeasurableParameter()

Create an autonomous MeasurableParameter.

MeasurableParameter

public MeasurableParameter(Parameter<Value> parameter)

Create a MeasurableParameter based on an existing Parameter. The Parameter provided is wrapped by this MeasurableParameter, so any modification made to the Parameter is applied to this MeasurableParameter too, and vice-versa.

ATTENTION: Although setting the Value of the original Parameter changes the Value of the MeasurableParameter wrapping it, no notification is sent by the MeasurableParameter to the MeasureListeners registered through register(MeasureListener). These notifications only occur when the MeasurableParameter itself is used to change the Parameter's Value.

Parameters:

parameter - the Parameter to wrap in this MeasurableParameter

Method Detail

set

public void set(Value value)

Specified by:

set in interface Parameter<Value>

Parameters:

value - the Value to give to this Parameter

get

public Value get()

Specified by:

get in interface PullMeasure<Value>

Specified by:

get in interface Parameter<Value>

Returns:

the current Value of the Parameter

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