ilog.views.prototypes

Class IlvRandomValueSource

java.lang.Object

ilog.views.prototypes.IlvGroupElement

ilog.views.prototypes.IlvValueSource

ilog.views.prototypes.IlvClockValueSource

ilog.views.prototypes.IlvRandomValueSource

All Implemented Interfaces:

IlvPersistentObject, Serializable

public class IlvRandomValueSource
extends IlvClockValueSource

The class IlvRandomValueSource is a subclass of IlvClockValueSource that generates a random value at a specified time interval.

See Also:

IlvClockValueSource, Serialized Form

Field Summary

Fields inherited from class ilog.views.prototypes.IlvValueSource

RUNNING, STOPPED, SUSPENDED

Constructor Summary

Constructors

Constructor and Description
IlvRandomValueSource(IlvInputStream in) Reads the value source from an IlvInputStream stream.
IlvRandomValueSource(IlvRandomValueSource source) Creates a new value source object by copying an existing one.
IlvRandomValueSource(String name, long period, String valueName, double min, double max) Creates a new value source that generates random values.

Method Summary

Modifier and Type	Method and Description
IlvGroupElement	copy() Returns a copy of the value source.
double	getMax() Returns the maximum value produced by this source.
double	getMin() Returns the minimum value produced by this source.
String	getValueName() Returns the name of the random value produced by this source.
String[]	getValueNames(boolean publicOnly) Returns the values handled or produced by this source.
boolean	isOutput(String name) Returns true if the specified name is equal to one of the time values produced by this source ("time", "hours", and so on).
void	setMax(double max) Sets the maximum value produced by this source.
void	setMin(double min) Sets the minimum value produced by this source.
void	setValueName(String valueName) Sets the name of the random value produced by this source.
protected void	tick(Vector names, Vector values) Adds the name specified by the valueName parameter passed to the constructor to the names parameter.
void	write(IlvOutputStream out) Writes the value source to an IlvOutputStream.

Methods inherited from class ilog.views.prototypes.IlvClockValueSource

getInitialTime, getPeriod, getRealTimeMode, getSynchronizationCount, getTimerPeriod, resume, setInitialTime, setPeriod, setRealTimeMode, start, stop, suspend, timerTicked

Methods inherited from class ilog.views.prototypes.IlvValueSource

addPropertyChangeListener, getState, removePropertyChangeListener, set, setState

Methods inherited from class ilog.views.prototypes.IlvGroupElement

applyTransform, applyTransform, boundingBox, boundingBox, get, get, get, getBoolean, getDouble, getFloat, getInt, getLong, getName, getParent, getRelativePath, getString, getSubscribers, getSubscriptionValues, move, pushValue, pushValues, set, set, set, set, set, set, set, setName, subscribe, traverse, unsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvRandomValueSource

public IlvRandomValueSource(String name,
                            long period,
                            String valueName,
                            double min,
                            double max)

Creates a new value source that generates random values.

Parameters:

name - the name of the property source.

period - the time interval (in milliseconds) between two value generations.

valueName - the name of the generated value, which will contain random numbers between min and max.

min - the minimum boundary of the generated random numbers.

max - the maximum boundary of the generated random numbers.

IlvRandomValueSource

public IlvRandomValueSource(IlvRandomValueSource source)

Creates a new value source object by copying an existing one.

Parameters:

source - The behavior object to be copied.

IlvRandomValueSource

public IlvRandomValueSource(IlvInputStream in)
                     throws IlvReadFileException

Reads the value source from an IlvInputStream stream. This constructor must be called by the input constructors of subclasses.

Parameters:

in - The input stream.

Throws:

IlvReadFileException - if the stream format is not correct.

Method Detail

write

public void write(IlvOutputStream out)
           throws IOException

Writes the value source to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvClockValueSource

Parameters:

out - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.

See Also:

IlvGroup.write(ilog.views.io.IlvOutputStream)

copy

public IlvGroupElement copy()

Returns a copy of the value source.

Overrides:

copy in class IlvClockValueSource

Returns:

a copy of the group element.

See Also:

IlvGroup.copy(ilog.views.prototypes.IlvGroup)

tick

protected void tick(Vector names,
                    Vector values)

Adds the name specified by the valueName parameter passed to the constructor to the names parameter. Also adds to the values vector a random value of type double contained between the min and max parameters passed to the constructor.

Overrides:

tick in class IlvClockValueSource

Parameters:

names - a vector containing the names of the properties that will be generated by a call to pushValues.

values - a vector containing the values that will be generated by a call to pushValues.

setValueName

public void setValueName(String valueName)

Sets the name of the random value produced by this source.

Parameters:

valueName - the name of new value.

getValueName

public String getValueName()

Returns the name of the random value produced by this source.

setMin

public void setMin(double min)

Sets the minimum value produced by this source.

Parameters:

min - the new minimum value.

getMin

public double getMin()

Returns the minimum value produced by this source.

setMax

public void setMax(double max)

Sets the maximum value produced by this source.

Parameters:

max - the new maximum value.

getMax

public double getMax()

Returns the maximum value produced by this source.

getValueNames

public String[] getValueNames(boolean publicOnly)
                       throws IlvValueException

Returns the values handled or produced by this source.

Overrides:

getValueNames in class IlvClockValueSource

Parameters:

publicOnly - ignored by this class.

Returns:

an array of value names.

Throws:

IlvValueException - if an error occurred while setting a property.

isOutput

public boolean isOutput(String name)

Returns true if the specified name is equal to one of the time values produced by this source ("time", "hours", and so on).

Overrides:

isOutput in class IlvClockValueSource