ptolemy.domains.dt.kernel
Class DTReceiver

java.lang.Object
  extended byptolemy.actor.AbstractReceiver
      extended byptolemy.domains.sdf.kernel.SDFReceiver
          extended byptolemy.domains.dt.kernel.DTReceiver
All Implemented Interfaces:
ptolemy.actor.Receiver

public class DTReceiver
extends SDFReceiver

A first-in, first-out (FIFO) queue receiver with variable capacity. Tokens are put into the receiver with the put() method, and removed from the receiver with the get() method. The token removed is the oldest one in the receiver. Time is incremented by a fixed amount delta time every time the get() method is called. Each receiver has its own value of delta time. We calculate delta time as "period / (rate * repetitions)" where:

Since:
Ptolemy II 1.0
Version:
$Id: DTReceiver.java,v 1.45 2004/04/13 05:13:16 cxh Exp $
Author:
C. Fong
Accepted Rating:
Yellow (vogel)
Proposed Rating:
Yellow (chf)

Field Summary
 
Fields inherited from class ptolemy.domains.sdf.kernel.SDFReceiver
INFINITE_CAPACITY
 
Constructor Summary
DTReceiver()
          Construct an empty receiver with no container.
DTReceiver(int size)
          Construct an empty receiver with no container and given size.
DTReceiver(ptolemy.actor.IOPort container)
          Construct an empty receiver with the specified container.
DTReceiver(ptolemy.actor.IOPort container, int size)
          Construct an empty receiver with the specified container and size.
 
Method Summary
 void calculateDeltaTime()
          Calculate the constant time increment for this receiver.
 void determineEnds()
          Determine the source and destination ports that use this receiver in their communications.
 ptolemy.data.Token get()
          Remove the first token (the oldest one) from the receiver and return it.
 double getCurrentTime()
          Return the local time associated with this receiver.
 double getDeltaTime()
          Return the time interval between tokens for this receiver.
 ptolemy.actor.TypedIOPort getSourcePort()
          Return the port that feeds this Receiver The port returned by this method is precalculated during the determineEnds() method call.
 int getTokenFlowRate()
          Return the token flow rate for this receiver In DT, the token flow rate has the value "rate * repetitions"; where 'rate' is the port rate and 'repetitions' is the firing count of the actor that contains this receiver.
 boolean hasToken()
          Return true if get() will succeed in returning a token.
 void put(ptolemy.data.Token token)
          Put a token to the receiver.
 
Methods inherited from class ptolemy.domains.sdf.kernel.SDFReceiver
clear, get, getArray, getCapacity, getHistoryCapacity, hasRoom, hasRoom, hasToken, historyElements, historySize, putArray, setCapacity, setHistoryCapacity, size
 
Methods inherited from class ptolemy.actor.AbstractReceiver
getContainer, isKnown, setContainer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DTReceiver

public DTReceiver()
Construct an empty receiver with no container.


DTReceiver

public DTReceiver(int size)
Construct an empty receiver with no container and given size.

Parameters:
size - The size of the buffer for the receiver.

DTReceiver

public DTReceiver(ptolemy.actor.IOPort container)
           throws ptolemy.kernel.util.IllegalActionException
Construct an empty receiver with the specified container.

Parameters:
container - The container of the receiver.
Throws:
ptolemy.kernel.util.IllegalActionException - If the container does not accept this receiver.

DTReceiver

public DTReceiver(ptolemy.actor.IOPort container,
                  int size)
           throws ptolemy.kernel.util.IllegalActionException
Construct an empty receiver with the specified container and size.

Parameters:
container - The container of the receiver.
size - The size of the buffer for the receiver.
Throws:
ptolemy.kernel.util.IllegalActionException - If the container does not accept this receiver.
Method Detail

calculateDeltaTime

public void calculateDeltaTime()
                        throws ptolemy.kernel.util.IllegalActionException
Calculate the constant time increment for this receiver. This method should only be invoked by the DT Director.

Throws:
ptolemy.kernel.util.IllegalActionException - If there is an error in getting attribute information from the ports.

determineEnds

public void determineEnds()
Determine the source and destination ports that use this receiver in their communications. In DT, the source and destination ports are distinct for each receiver because "non-deterministic merge" type relations are not allowed.


get

public ptolemy.data.Token get()
Remove the first token (the oldest one) from the receiver and return it. If there is no token in the receiver, throw an exception. Increment the local time by deltaTime.

Specified by:
get in interface ptolemy.actor.Receiver
Overrides:
get in class SDFReceiver
Returns:
The oldest token in the receiver.

getCurrentTime

public double getCurrentTime()
Return the local time associated with this receiver.

Returns:
The local time associated with this receiver.

getDeltaTime

public double getDeltaTime()
Return the time interval between tokens for this receiver. Delta time is defined as "period / (token flow rate)"; where period is the director's period parameter and token flow rate is the number of tokens flowing through this receiver per iteration

Returns:
The time interval between tokens

getSourcePort

public ptolemy.actor.TypedIOPort getSourcePort()
Return the port that feeds this Receiver The port returned by this method is precalculated during the determineEnds() method call.

Returns:
The port that feeds this receiver.

getTokenFlowRate

public int getTokenFlowRate()
Return the token flow rate for this receiver In DT, the token flow rate has the value "rate * repetitions"; where 'rate' is the port rate and 'repetitions' is the firing count of the actor that contains this receiver.

Returns:
The token flow rate of this receiver

put

public void put(ptolemy.data.Token token)
Put a token to the receiver. If the port feeding this receiver is null, report an internal error.

Specified by:
put in interface ptolemy.actor.Receiver
Overrides:
put in class SDFReceiver
Parameters:
token - The token to be put to the receiver.
Throws:
ptolemy.kernel.util.InternalErrorException - If the source port is null.

hasToken

public boolean hasToken()
Return true if get() will succeed in returning a token.

Specified by:
hasToken in interface ptolemy.actor.Receiver
Overrides:
hasToken in class SDFReceiver
Returns:
A boolean indicating whether there is a token in this receiver.