Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

ptolemy.backtrack.automatic.ptolemy.actor.lib
Class Sequencer

java.lang.Object
  extended by ptolemy.kernel.util.NamedObj
      extended by ptolemy.kernel.InstantiableNamedObj
          extended by ptolemy.kernel.Entity
              extended by ptolemy.kernel.ComponentEntity
                  extended by ptolemy.actor.AtomicActor
                      extended by ptolemy.actor.TypedAtomicActor
                          extended by ptolemy.actor.lib.Transformer
                              extended by ptolemy.backtrack.automatic.ptolemy.actor.lib.Sequencer
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, SequenceActor, TypedActor, Rollbackable, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
public class Sequencer
extends Transformer
implements SequenceActor, Rollbackable

This actor takes a sequence of inputs tagged with a sequence number and produces them on the output port in the order given by the sequence number. The sequence numbers are integers starting with zero. On each firing, this actor consumes one token from the input port and one token from the sequenceNumber port. If the sequence number is the next one in the sequence, then the token read from the input port is produced on the output port. Otherwise, it is saved until its sequence number is the next one in the sequence. If an output is produced, then it may be immediately followed by tokens that were previously saved, if their sequence numbers are next.

Since:
Ptolemy II 1.0
Version:
$Id: Sequencer.java 57040 2010-01-27 20:52:32Z cxh $
Author:
Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Yellow (ctsay)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes/interfaces inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
private  boolean _fireProducedOutput
           
private  int _nextSequenceNumber
           
private  Token _nextToken
           
private  ptolemy.backtrack.util.java.util.TreeMap _pending
           
private  int _sequenceNumberOfInput
           
protected  Checkpoint $CHECKPOINT
           
private  FieldRecord $RECORD$_fireProducedOutput
           
private  FieldRecord $RECORD$_nextSequenceNumber
           
private  FieldRecord $RECORD$_nextToken
           
private  FieldRecord $RECORD$_pending
           
private  FieldRecord $RECORD$_sequenceNumberOfInput
           
protected  CheckpointRecord $RECORD$$CHECKPOINT
           
private  FieldRecord[] $RECORDS
           
 TypedIOPort sequenceNumber
          Input for the sequence number.
 Parameter startingSequenceNumber
          The first number of the sequence.
 
Fields inherited from class ptolemy.actor.lib.Transformer
input, output
 
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
Sequencer(CompositeEntity container, java.lang.String name)
          Construct an actor in the specified container with the specified name.
 
Method Summary
private  boolean $ASSIGN$_fireProducedOutput(boolean newValue)
           
private  int $ASSIGN$_nextSequenceNumber(int newValue)
           
private  Token $ASSIGN$_nextToken(Token newValue)
           
private  ptolemy.backtrack.util.java.util.TreeMap $ASSIGN$_pending(ptolemy.backtrack.util.java.util.TreeMap newValue)
           
private  int $ASSIGN$_sequenceNumberOfInput(int newValue)
           
private  int $ASSIGN$SPECIAL$_nextSequenceNumber(int operator, long newValue)
           
 void $COMMIT(long timestamp)
          Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.
 Checkpoint $GET$CHECKPOINT()
          Get the checkpoint object that monitors this rollbackable object.
 void $RESTORE(long timestamp, boolean trim)
          Restore a previous state to all the private fields of this rollbackable object.
 java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)
          Set the checkpoint object of this rollbackable object.
 java.lang.Object clone(Workspace workspace)
          Clone the actor into the specified workspace.
 void fire()
          Read a token from the sequenceNumber port and from the input port, and output the next token(s) in the sequence, or none if the next token in the sequence has not yet been seen.
 void initialize()
          Reset current sequence number to the value given by the startingSequenceNumber parameter.
 boolean postfire()
          If the fire() method produced the input token then check to whether any pending tokens have subsequent sequence numbers.
 boolean prefire()
          Return false if either the input port or the sequenceNumber port lacks an input token.
 
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, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup
 
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, attributeChanged, 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, stop, stopFire, terminate
 
Methods inherited from interface ptolemy.actor.Initializable
addInitializable, preinitialize, removeInitializable, wrapup
 
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

sequenceNumber

public TypedIOPort sequenceNumber
Input for the sequence number. The type is int.

startingSequenceNumber

public Parameter startingSequenceNumber
The first number of the sequence. This is an int that defaults to 0.

_fireProducedOutput

private boolean _fireProducedOutput

_nextSequenceNumber

private int _nextSequenceNumber

_nextToken

private Token _nextToken

_pending

private ptolemy.backtrack.util.java.util.TreeMap _pending

_sequenceNumberOfInput

private int _sequenceNumberOfInput

$RECORD$$CHECKPOINT

protected transient CheckpointRecord $RECORD$$CHECKPOINT

$RECORD$_fireProducedOutput

private transient FieldRecord $RECORD$_fireProducedOutput

$RECORD$_nextSequenceNumber

private transient FieldRecord $RECORD$_nextSequenceNumber

$RECORD$_nextToken

private transient FieldRecord $RECORD$_nextToken

$RECORD$_pending

private transient FieldRecord $RECORD$_pending

$RECORD$_sequenceNumberOfInput

private transient FieldRecord $RECORD$_sequenceNumberOfInput

$RECORDS

private transient FieldRecord[] $RECORDS
Constructor Detail

Sequencer

public Sequencer(CompositeEntity container,
                 java.lang.String name)
          throws IllegalActionException,
                 NameDuplicationException
Construct an actor in the specified container with the specified name.

Parameters:
container - The container.
name - The name of this actor within the container.
Throws:
IllegalActionException - If the actor cannot be contained by the proposed container.
NameDuplicationException - If the name coincides with an actor already in the container.
Method Detail

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
Clone the actor into the specified workspace.

Overrides:
clone in class AtomicActor
Parameters:
workspace - The workspace for the new object.
Returns:
A new actor.
Throws:
java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.
See Also:
NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

fire

public void fire()
          throws IllegalActionException
Read a token from the sequenceNumber port and from the input port, and output the next token(s) in the sequence, or none if the next token in the sequence has not yet been seen. This method will throw a NoTokenException if sequenceNumber or input does not have a token.

Specified by:
fire in interface Executable
Overrides:
fire in class AtomicActor
Throws:
IllegalActionException - If there is no director.

initialize

public void initialize()
                throws IllegalActionException
Reset current sequence number to the value given by the startingSequenceNumber parameter.

Specified by:
initialize in interface Initializable
Overrides:
initialize in class AtomicActor
Throws:
IllegalActionException - If accessing the startingSequenceNumber parameter causes an exception.

postfire

public boolean postfire()
                 throws IllegalActionException
If the fire() method produced the input token then check to whether any pending tokens have subsequent sequence numbers.

Specified by:
postfire in interface Executable
Overrides:
postfire in class AtomicActor
Returns:
True if execution can continue into the next iteration.
Throws:
IllegalActionException - If there is no director.

prefire

public boolean prefire()
                throws IllegalActionException
Return false if either the input port or the sequenceNumber port lacks an input token. Otherwise, return whatever the superclass returns.

Specified by:
prefire in interface Executable
Overrides:
prefire in class AtomicActor
Returns:
False if there are not enough tokens to fire.
Throws:
IllegalActionException - If there is no director.

$ASSIGN$_fireProducedOutput

private final boolean $ASSIGN$_fireProducedOutput(boolean newValue)

$ASSIGN$_nextSequenceNumber

private final int $ASSIGN$_nextSequenceNumber(int newValue)

$ASSIGN$SPECIAL$_nextSequenceNumber

private final int $ASSIGN$SPECIAL$_nextSequenceNumber(int operator,
                                                      long newValue)

$ASSIGN$_nextToken

private final Token $ASSIGN$_nextToken(Token newValue)

$ASSIGN$_pending

private final ptolemy.backtrack.util.java.util.TreeMap $ASSIGN$_pending(ptolemy.backtrack.util.java.util.TreeMap newValue)

$ASSIGN$_sequenceNumberOfInput

private final int $ASSIGN$_sequenceNumberOfInput(int newValue)

$COMMIT

public void $COMMIT(long timestamp)
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)
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()
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)
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)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD