ilog.views.prototypes

Class IlvValueSource

java.lang.Object

ilog.views.prototypes.IlvGroupElement

ilog.views.prototypes.IlvValueSource

All Implemented Interfaces:

IlvPersistentObject, Serializable

Direct Known Subclasses:

IlvClockValueSource

public class IlvValueSource
extends IlvGroupElement

The class IlvValueSource is the base class of all objects that generate values. Value sources can be connected to prototype instances in a panel with the subscribe method. They can also be included in prototypes to enable them to generate values.

To generate a value (or a set of values), a value source calls the pushValue or pushValues method of its superclass IlvGroupElement.

There are several predefined value source subclasses that generate time and random values at specified time intervals.

You can define specific value sources that send the values produced or acquired by your application to your graphic objects.

See Also:

IlvClockValueSource, IlvRandomValueSource, IlvGroupElement.pushValue(java.lang.String, java.lang.Object), IlvGroupElement.pushValues(java.lang.String[], java.lang.Object[]), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	RUNNING Specifies that a value source must start generating values.
static int	STOPPED Specifies that a value source must stop generating values and reset its internal state, if any.
static int	SUSPENDED Specifies that a value source must stop generating values without resetting its internal state.

Constructor Summary

Constructors

Constructor and Description
IlvValueSource(IlvInputStream in) Reads the value source from an IlvInputStream stream.
IlvValueSource(IlvValueSource source) Creates a new value source object by copying an existing one.
IlvValueSource(String name) Creates a new value source.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to this value source.
IlvGroupElement	copy() Returns a copy of the value source.
int	getState() Returns the current state of this value source.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from this value source.
protected void	resume() Called when the state of the value source changes from SUSPENDED to RUNNING.
protected void	set(String[] names, Object[] values, boolean[] done) Changes a set of properties for this value source.
void	setState(int state) Sets the state of this value source.
protected void	start() Called when the state of the value source changes from STOPPED to RUNNING.
protected void	stop() Called when the state of the value source changes from the initial state to STOPPED.
protected void	suspend() Called when the state of the value source changes from the initial state to SUSPENDED.
void	write(IlvOutputStream out) Writes the value source to an IlvOutputStream.

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, getValueNames, isOutput, 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

Field Detail

STOPPED

public static final int STOPPED

Specifies that a value source must stop generating values and reset its internal state, if any.

See Also:

Constant Field Values

RUNNING

public static final int RUNNING

Specifies that a value source must start generating values.

See Also:

Constant Field Values

SUSPENDED

public static final int SUSPENDED

Specifies that a value source must stop generating values without resetting its internal state.

See Also:

Constant Field Values

Constructor Detail

IlvValueSource

public IlvValueSource(String name)

Creates a new value source.

Parameters:

name - the name of the property source.

IlvValueSource

public IlvValueSource(IlvValueSource source)

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

Parameters:

source - The object to be copied.

IlvValueSource

public IlvValueSource(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

Specified by:

write in class IlvGroupElement

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.

Specified by:

copy in class IlvGroupElement

Returns:

a copy of the group element.

See Also:

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

setState

public final void setState(int state)

Sets the state of this value source.

• If the new state is equal to the current state, the method does nothing.
• If the new state is RUNNING, the start method is called if the current state is STOPPED or the resume method is called if it is SUSPENDED.
• If the new state is STOPPED, the stop method is called.
• If the new state is SUSPENDED, the suspend method is called.

Parameters:

state - the new state, which must be one of the fields RUNNING, STOPPED or SUSPENDED.

Throws:

IllegalArgumentException - if state is not a valid state for the value source.

getState

public final int getState()

Returns the current state of this value source.

Returns:

one of the possible states: RUNNING, STOPPED or SUSPENDED.

start

protected void start()

Called when the state of the value source changes from STOPPED to RUNNING.

stop

protected void stop()

Called when the state of the value source changes from the initial state to STOPPED.

suspend

protected void suspend()

Called when the state of the value source changes from the initial state to SUSPENDED.

resume

protected void resume()

Called when the state of the value source changes from SUSPENDED to RUNNING.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a PropertyChangeListener to this value source. The listeners are called when a property is changed for this value, either by a call to one of the set methods or when an object connected to the source outputs a value.

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a PropertyChangeListener from this value source.

set

protected void set(String[] names,
                   Object[] values,
                   boolean[] done)
            throws IlvValueException

Changes a set of properties for this value source.

This method is overridden from the superclass to call the property change listeners added to this value source.

Parameters:

names - the names of the properties to set.

values - the new values.

done - an array of booleans indicating which values have been handled.

Throws:

IlvValueException - if a value error occurred.

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener), removePropertyChangeListener(java.beans.PropertyChangeListener)