ptolemy.domains.sequence.kernel

Class RegisterReceiver

java.lang.Object

ptolemy.actor.AbstractReceiver

ptolemy.actor.Mailbox

ptolemy.domains.sequence.kernel.RegisterReceiver

All Implemented Interfaces:

Receiver

public class RegisterReceiver
extends Mailbox

A receiver which extends Mailbox and holds a single token.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Elizabeth Latronico (Bosch)

Pt.AcceptedRating:

Red (beth)

Pt.ProposedRating:

Red (beth)

Field Summary

Fields inherited from class ptolemy.actor.Mailbox

_token

Constructor Summary

Constructors

Constructor and Description
RegisterReceiver() Construct an empty RegisterReceiver with no container.
RegisterReceiver(IOPort container) Construct an empty RegisterReceiver with the specified container.

Method Summary

Modifier and Type	Method and Description
Token	get() Get the contained Token.
void	put(Token token) Put a token into the registerReceiver.

Methods inherited from class ptolemy.actor.Mailbox

clear, elementList, hasRoom, hasRoom, hasToken, hasToken

Methods inherited from class ptolemy.actor.AbstractReceiver

getArray, getContainer, getCurrentTime, getModelTime, isKnown, putArray, putArrayToAll, putToAll, reset, setContainer, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RegisterReceiver

public RegisterReceiver()

Construct an empty RegisterReceiver with no container.

RegisterReceiver

public RegisterReceiver(IOPort container)
                 throws IllegalActionException

Construct an empty RegisterReceiver with the specified container.

Parameters:

container - The container.

Throws:

IllegalActionException - If the container does not accept this receiver.

Method Detail

get

public Token get()
          throws NoTokenException

Get the contained Token. If there is none, throw an exception.

Specified by:

get in interface Receiver

Overrides:

get in class Mailbox

Returns:

The token contained by this receiver.

Throws:

NoTokenException - If this receiver is empty.

put

public void put(Token token)
         throws NoRoomException

Put a token into the registerReceiver.

Specified by:

put in interface Receiver

Overrides:

put in class Mailbox

Parameters:

token - The token to be put into the mailbox, or null to set the mailbox to empty.

Throws:

NoRoomException - Not thrown in this base class.