ptolemy.actor.lib.hoc
Class ThreadedComposite.TokenFrame

java.lang.Object
  ptolemy.actor.lib.hoc.ThreadedComposite.TokenFrame

Enclosing class:

ThreadedComposite

protected static class ThreadedComposite.TokenFrame
extends java.lang.Object

Bundle data associated with ports and a time stamp. There are three types of frames: EVENT is a (possibly empty) bundle of data and a time stamp that is either provided to the inside thread from the inputs of a ThreadedComposite or provided by the inside thread to form the outputs of a ThreadedComposite. POSTFIRE is a frame indicating that the inside actor can be postfired. No tokens are provided (they are assumed to have been consumed in the firing). STOP is a frame provided to the inside thread to indicate that it should stop executing.

Nested Class Summary

private static class

ThreadedComposite.TokenFrame.FrameType

Field Summary

static ThreadedComposite.TokenFrame.FrameType	EVENT A (possibly empty) bundle of data and a time stamp that is either provided to the inside thread from the inputs of a ThreadedComposite or provided by the inside thread to form the outputs of a ThreadedComposite.
static ThreadedComposite.TokenFrame.FrameType	POSTFIRE POSTFIRE is a frame indicating that the inside actor can be postfired.
static ThreadedComposite.TokenFrame.FrameType	STOP STOP is a frame provided to the inside thread to indicate that it should stop executing.
Time	time The time.
java.util.List<ThreadedComposite.QueuedToken>	tokens A list of tokens.
ThreadedComposite.TokenFrame.FrameType	type The type of the frame.

Constructor Summary

ThreadedComposite.TokenFrame(Time theTime, java.util.List<ThreadedComposite.QueuedToken> theTokens, ThreadedComposite.TokenFrame.FrameType theType)
Construct a TokenFrame.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

time

public final Time time

The time.

tokens

public final java.util.List<ThreadedComposite.QueuedToken> tokens

A list of tokens.

type

public final ThreadedComposite.TokenFrame.FrameType type

The type of the frame.

EVENT

public static final ThreadedComposite.TokenFrame.FrameType EVENT

A (possibly empty) bundle of data and a time stamp that is either provided to the inside thread from the inputs of a ThreadedComposite or provided by the inside thread to form the outputs of a ThreadedComposite.

POSTFIRE

public static final ThreadedComposite.TokenFrame.FrameType POSTFIRE

POSTFIRE is a frame indicating that the inside actor can be postfired. No tokens are provided (they are assumed to have been consumed in the firing).

STOP

public static final ThreadedComposite.TokenFrame.FrameType STOP

STOP is a frame provided to the inside thread to indicate that it should stop executing.

Constructor Detail

ThreadedComposite.TokenFrame

public ThreadedComposite.TokenFrame(Time theTime,
                                    java.util.List<ThreadedComposite.QueuedToken> theTokens,
                                    ThreadedComposite.TokenFrame.FrameType theType)

Construct a TokenFrame.

Parameters:

theTime - The time of this token frame.

theTokens - a list of QueueTokens.

theType - The FrameType.