ptolemy.backtrack.automatic.ptolemy.actor.lib
Class DoubleReader

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.InstantiableNamedObj
          ptolemy.kernel.Entity
              ptolemy.kernel.ComponentEntity
                  ptolemy.actor.AtomicActor
                      ptolemy.actor.TypedAtomicActor
                          ptolemy.actor.lib.Source
                              ptolemy.actor.lib.URLReader
                                  ptolemy.backtrack.automatic.ptolemy.actor.lib.DoubleReader

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Rollbackable, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Deprecated. Use ExpressionReader instead.

public class DoubleReader
extends URLReader
implements Rollbackable

This actor reads tokens from an URL, and output them. Each entry in the file corresponds to one iteration. If there are multiple fires in the iteration, the same token will be repeated. This actor has a multiport, where each port corresponds to one column in the data file.

The file format at the URL is assumed as the following. A newline character separates the rows, and a tab or a space character separates the columns.

The sourceURL parameter should be set to the name of the file, specified as a fully qualified URL. If the sourceURL parameter is an empty string, then the System.in is used for input. It is possible to load a file from the local file system by using the prefix "file://" instead of "http://". Relative file paths are allowed. To specify a file relative to the current directory, use "../" or "./". For example, if the current directory contains a file called "test.txt", then sourceURL should be set to "file:./test.txt". If the parent directory contains a file called "test.txt", then sourceURL should be set to "file:../test.txt". To reference the file test.txt, located at "/tmp/test.txt", sourceURL should be set to "file:///tmp/test.txt" The default value is "file:///tmp/test.txt".

FIXME: The type of the output ports is set to Double for now. It should read a line in the prefire() and refer the type from there.

FIXME: Reader should read in expressions and serialized tokens

Since:

Ptolemy II 2.0

Version:

$Id: DoubleReader.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Jie Liu, Christopher Hylands

See Also:

Serialized Form

Accepted Rating:

Red (liuj)

Proposed Rating:

Red (liuj)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

private double[]	_data Deprecated.
private int	_dataSize Deprecated.
protected Checkpoint	$CHECKPOINT Deprecated.
private FieldRecord	$RECORD$_data Deprecated.
private FieldRecord	$RECORD$_dataSize Deprecated.
protected CheckpointRecord	$RECORD$$CHECKPOINT Deprecated.
private FieldRecord[]	$RECORDS Deprecated.

Fields inherited from class ptolemy.actor.lib.URLReader

_reader, _refreshFlag, _source, _stdIn, refresh, sourceURL

Fields inherited from class ptolemy.actor.lib.Source

output, trigger

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

DoubleReader(CompositeEntity container, java.lang.String name)
Deprecated. Construct an actor with the given container and name.

Method Summary

private double[]	$ASSIGN$_data(double[] newValue) Deprecated.
private double	$ASSIGN$_data(int index0, double newValue) Deprecated.
private int	$ASSIGN$_dataSize(int newValue) Deprecated.
void	$COMMIT(long timestamp) Deprecated. Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.
Checkpoint	$GET$CHECKPOINT() Deprecated. Get the checkpoint object that monitors this rollbackable object.
void	$RESTORE(long timestamp, boolean trim) Deprecated. Restore a previous state to all the private fields of this rollbackable object.
java.lang.Object	$SET$CHECKPOINT(Checkpoint checkpoint) Deprecated. Set the checkpoint object of this rollbackable object.
void	fire() Deprecated. Output the data read in the prefire.
void	initialize() Deprecated. Open the file at the URL, and set the width of the output.
boolean	prefire() Deprecated. Read one row from the input and prepare for output them.

Methods inherited from class ptolemy.actor.lib.URLReader

_setURLReader, attributeChanged, wrapup

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

$CHECKPOINT

protected transient Checkpoint $CHECKPOINT

Deprecated.

_data

private double[] _data

Deprecated.

_dataSize

private int _dataSize

Deprecated.

$RECORD$$CHECKPOINT

protected transient CheckpointRecord $RECORD$$CHECKPOINT

Deprecated.

$RECORD$_data

private transient FieldRecord $RECORD$_data

Deprecated.

$RECORD$_dataSize

private transient FieldRecord $RECORD$_dataSize

Deprecated.

$RECORDS

private transient FieldRecord[] $RECORDS

Deprecated.

Constructor Detail

DoubleReader

public DoubleReader(CompositeEntity container,
                    java.lang.String name)
             throws IllegalActionException,
                    NameDuplicationException

Deprecated.

Construct an actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

fire

public void fire()
          throws IllegalActionException

Deprecated.

Output the data read in the prefire.

Specified by:

fire in interface Executable

Overrides:

fire in class Source

Throws:

IllegalActionException - If there's no director.

initialize

public void initialize()
                throws IllegalActionException

Deprecated.

Open the file at the URL, and set the width of the output.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class URLReader

Throws:

IllegalActionException - Not thrown in this base class

prefire

public boolean prefire()
                throws IllegalActionException

Deprecated.

Read one row from the input and prepare for output them.

Specified by:

prefire in interface Executable

Overrides:

prefire in class Source

Returns:

True, unless the trigger input is connected and has no input.

Throws:

IllegalActionException - If an IO error occurs.

$ASSIGN$_data

private final double[] $ASSIGN$_data(double[] newValue)

Deprecated.

$ASSIGN$_data

private final double $ASSIGN$_data(int index0,
                                   double newValue)

Deprecated.

$ASSIGN$_dataSize

private final int $ASSIGN$_dataSize(int newValue)

Deprecated.

$COMMIT

public void $COMMIT(long timestamp)

Deprecated.

Description copied from interface: Rollbackable

Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.

Specified by:

$COMMIT in interface Rollbackable

Parameters:

timestamp - The timestamp.

$RESTORE

public void $RESTORE(long timestamp,
                     boolean trim)

Deprecated.

Description copied from interface: Rollbackable

Restore a previous state to all the private fields of this rollbackable object.

Specified by:

$RESTORE in interface Rollbackable

Parameters:

timestamp - The timestamp taken at the time when the previous state was recorded.

trim - Whether to delete the records used for the rollback.

See Also:

Checkpoint.rollback(long, boolean)

$GET$CHECKPOINT

public final Checkpoint $GET$CHECKPOINT()

Deprecated.

Description copied from interface: Rollbackable

Get the checkpoint object that monitors this rollbackable object.

Specified by:

$GET$CHECKPOINT in interface Rollbackable

Returns:

The checkpoint object.

$SET$CHECKPOINT

public final java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)

Deprecated.

Description copied from interface: Rollbackable

Set the checkpoint object of this rollbackable object. A merge operation is performed on the current checkpoint object and the new checkpoint object, so that the two checkpoint objects monitor the same set of objects when this function returns.

Specified by:

$SET$CHECKPOINT in interface Rollbackable

Parameters:

checkpoint - The new checkpoint object.

Returns:

This rollbackable object itself.

See Also:

Checkpoint.setCheckpoint(Checkpoint)