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.

Field Summary

Fields

Modifier and Type	Field and Description
static ptolemy.actor.lib.hoc.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 ptolemy.actor.lib.hoc.ThreadedComposite.TokenFrame.FrameType	POSTFIRE POSTFIRE is a frame indicating that the inside actor can be postfired.
static ptolemy.actor.lib.hoc.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<ptolemy.actor.lib.hoc.ThreadedComposite.QueuedToken>	tokens A list of tokens.
ptolemy.actor.lib.hoc.ThreadedComposite.TokenFrame.FrameType	type The type of the frame.

Constructor Summary

Constructors

Constructor and Description
TokenFrame(Time theTime, java.util.List<ptolemy.actor.lib.hoc.ThreadedComposite.QueuedToken> theTokens, ptolemy.actor.lib.hoc.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<ptolemy.actor.lib.hoc.ThreadedComposite.QueuedToken> tokens

A list of tokens.

type

public final ptolemy.actor.lib.hoc.ThreadedComposite.TokenFrame.FrameType type

The type of the frame.

EVENT

public static final ptolemy.actor.lib.hoc.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 ptolemy.actor.lib.hoc.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 ptolemy.actor.lib.hoc.ThreadedComposite.TokenFrame.FrameType STOP

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

Constructor Detail

TokenFrame

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

Construct a TokenFrame.

Parameters:

theTime - The time of this token frame.

theTokens - a list of QueueTokens.

theType - The FrameType.