ptolemy.actor
Class TokenGotEvent

java.lang.Object
  ptolemy.actor.TokenGotEvent

public class TokenGotEvent
extends java.lang.Object

An event that is published by IOPorts whenever get or getInside is called. The appropriate event should be published whenever a token is taken out from the port's queue by the actor code. In Kepler the provenance recorder uses these events to save intermediate results of the workflow. In the future these events could be used for "smart" reruns or a fault tolerance mechanism.

Since:

Ptolemy II 6.1

Version:

$Id: TokenGotEvent.java,v 1.7 2007/12/07 06:24:49 cxh Exp $

Author:

Norbert Podhorszki

Accepted Rating:

Red (pnorbert)

Proposed Rating:

Red (pnorbert)

Constructor Summary

TokenGotEvent(IOPort sink, int channel, Token[] tokens, int vectorLength, boolean outside)
Create a new token got event with the given parameters.

TokenGotEvent(IOPort sink, int channel, Token token, boolean outside)
Create a new token got event with the given parameters.

Method Summary

int	getChannel() Return the channel the token was received on.
boolean	getOutsideFlag() Return the direction flag (outside or inside).
IOPort	getPort() Return the port that the token was received at.
Token	getToken() Return the token that was received by the IOPort.
Token[]	getTokenArray() Return the array of tokens that was received by the IOPort.
int	getVectorLength() Return the number of tokens in the array taken at the IOPort.
java.lang.String	toString() Return a string representation of this event.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenGotEvent

public TokenGotEvent(IOPort sink,
                     int channel,
                     Token[] tokens,
                     int vectorLength,
                     boolean outside)

Create a new token got event with the given parameters. This constructor is used when an array of tokens is taken.

Parameters:

sink - The IOPort the token is stored at.

channel - Channel the token was received on.

tokens - The token array used for the get.

vectorLength - The number of tokens taken.

outside - True if the token was taken on outside channel, false otherwise.

TokenGotEvent

public TokenGotEvent(IOPort sink,
                     int channel,
                     Token token,
                     boolean outside)

Create a new token got event with the given parameters. This constructor is used when a token is taken using get or getInside.

Parameters:

sink - The IOPort the token is stored at.

channel - Channel the token was received on.

token - The token that was received.

outside - True if the token was taken on outside channel, false otherwise.

Method Detail

getChannel

public int getChannel()

Return the channel the token was received on.

Returns:

The channel number.

getPort

public IOPort getPort()

Return the port that the token was received at.

Returns:

An instance of IOPort.

getToken

public Token getToken()

Return the token that was received by the IOPort. The variable _token will be null if the event was for a get array. To get the tokens that were received use getTokenArray() instead.

Returns:

The token received at the IOPort.

getTokenArray

public Token[] getTokenArray()

Return the array of tokens that was received by the IOPort. The variable _tokenArray will be null if an individual token was got instead of an array.

Returns:

The array of tokens which were taken.

getVectorLength

public int getVectorLength()

Return the number of tokens in the array taken at the IOPort. The variable _vectorLength will be -1 if an individual token was taken instead of an array of tokens.

Returns:

The number of tokens taken at the port.

getOutsideFlag

public boolean getOutsideFlag()

Return the direction flag (outside or inside). The flag is true, if the token was taken from outside, false if from inside

Returns:

The direction flag.

toString

public java.lang.String toString()

Return a string representation of this event.

Overrides:

toString in class java.lang.Object

Returns:

A user-readable string describing the event.