net.sourceforge.cilib.simulator

Class MeasurementSuite

java.lang.Object

net.sourceforge.cilib.simulator.MeasurementSuite

public class MeasurementSuite
extends java.lang.Object

The MeasurementSuite is essentially a collection of measurements.

See Also:

net.sourceforge.Measurement.Measurement

Constructor Summary

Constructors

Constructor and Description
MeasurementSuite() Creates a new instance of MeasurementSuite.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(net.sourceforge.cilib.measurement.Measurement<?> measurement)
void	addMeasurement(net.sourceforge.cilib.measurement.Measurement<?> measurement) Adds a measurement to the suite.
void	close()
java.util.List<java.lang.String>	getDescriptions()
java.io.File	getFile()
int	getResolution() Accessor for the resolution of the results.
void	initialise() Initialise the require output buffers for the MeasurementSuite.
void	measure(net.sourceforge.cilib.algorithm.Algorithm algorithm) Measure the provided Algorithm.
void	setResolution(int resolution) Sets the resolution of the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

MeasurementSuite

public MeasurementSuite()

Creates a new instance of MeasurementSuite.

Method Detail

initialise

public void initialise()

Initialise the require output buffers for the MeasurementSuite.

getFile

public java.io.File getFile()

setResolution

public void setResolution(int resolution)

Sets the resolution of the results. The resolution determines how often results are logged to file. If the resolution is 10 then results are logged every 10 iterations.

Parameters:

resolution - The result resolution.

getResolution

public int getResolution()

Accessor for the resolution of the results.

Returns:

The result resolution.

addMeasurement

public void addMeasurement(net.sourceforge.cilib.measurement.Measurement<?> measurement)

Adds a measurement to the suite.

Parameters:

measurement - The measurement to be added.

measure

public void measure(net.sourceforge.cilib.algorithm.Algorithm algorithm)

Measure the provided Algorithm. All the current measurements that are defined for the MeasurementSuite are applied to the Algorithm. Any measurements that are state aware instances will automatically have their internal state saved and restored as measurements are taken on the current Algorithm.

Parameters:

algorithm - The Algorithm to measure.

add

public void add(net.sourceforge.cilib.measurement.Measurement<?> measurement)

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getDescriptions

public java.util.List<java.lang.String> getDescriptions()