ptserver.data

Class CommunicationToken

java.lang.Object

ptolemy.data.Token

ptserver.data.CommunicationToken

public class CommunicationToken
extends Token

Encapsulate tokens that were received within one iteration.

Note: Kahn process networks are not being handled right now.

Since:

Ptolemy II 10.0

Version:

$Id: CommunicationToken.java 67784 2013-10-26 16:53:27Z cxh $

Author:

Anar Huseynov

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Field Summary

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor and Description
CommunicationToken() Create a new instance with targetActor set to null.
CommunicationToken(java.lang.String targetActor) Create a new instance and set the name of the targetActor.

Method Summary

Modifier and Type	Method and Description
void	addPort(java.lang.String port, int width) Add the port with the specified number of channels.
boolean	equals(java.lang.Object object) Return true if the object is equal to the instance, false otherwise.
java.util.HashMap<java.lang.String,java.util.ArrayList<Token[]>>	getPortChannelTokenMap() Return the mapping from ports to their channels with tokens have been received within one iteration.
int	getSize() Return number of original tokens contained within the Communication Token.
java.lang.String	getTargetActorName() Return the full name of the target actor that received the tokens encapsulated by the CommunicationToken.
Token[]	getTokens(java.lang.String port, int channel) Return the tokens of a specific port and channel.
int	hashCode() Compute hash code of the instance based on the targetActorname and portChannelTokenMap.
void	putTokens(java.lang.String port, int channel, Token[] tokens) Put tokens received from the port and channel into the CommunicationToken.
void	setTargetActorName(java.lang.String targetActorName) Set the full name of the targetActor that received the tokens that the CommunicationToken encapsulates.

Methods inherited from class ptolemy.data.Token

add, addReverse, divide, divideReverse, getType, isCloseTo, isCloseTo, isEqualTo, isNil, modulo, moduloReverse, multiply, multiplyReverse, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, notSupportedNullNilStringMessage, one, pow, subtract, subtractReverse, toString, zero, zeroReturnType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommunicationToken

public CommunicationToken()

Create a new instance with targetActor set to null.

CommunicationToken

public CommunicationToken(java.lang.String targetActor)

Create a new instance and set the name of the targetActor.

Parameters:

targetActor - the target actor whose tokens this instance encapsulates.

Method Detail

addPort

public void addPort(java.lang.String port,
                    int width)

Add the port with the specified number of channels.

Parameters:

port - The port name as it's returned by NamedObj.getName() method.

width - The number of channel that the port has.

equals

public boolean equals(java.lang.Object object)

Return true if the object is equal to the instance, false otherwise. The method checks if the object has the same target name and the portChannelMap contains the same ports each having the same number of channels with the same tokens.

Overrides:

equals in class java.lang.Object

Parameters:

object - The reference object with which to compare.

Returns:

true if the objects are equal, false otherwise.

See Also:

Object.equals(java.lang.Object)

getPortChannelTokenMap

public java.util.HashMap<java.lang.String,java.util.ArrayList<Token[]>> getPortChannelTokenMap()

Return the mapping from ports to their channels with tokens have been received within one iteration.

Returns:

the mapping from ports to their channels with tokens have been received within one iteration.

getSize

public int getSize()

Return number of original tokens contained within the Communication Token.

Returns:

number of original tokens

getTargetActorName

public java.lang.String getTargetActorName()

Return the full name of the target actor that received the tokens encapsulated by the CommunicationToken.

Returns:

the full name of the target actor that received the tokens encapsulated by the CommunicationToken.

See Also:

setTargetActorName(String)

getTokens

public Token[] getTokens(java.lang.String port,
                         int channel)

Return the tokens of a specific port and channel.

Parameters:

port - Port of the targetActor

channel - Port's channel of the targetActor

Returns:

tokens of a specific port and channel

hashCode

public int hashCode()

Compute hash code of the instance based on the targetActorname and portChannelTokenMap.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code based on targetActorName and tokens in the portChannelTokanMap.

See Also:

Object.hashCode()

putTokens

public void putTokens(java.lang.String port,
                      int channel,
                      Token[] tokens)

Put tokens received from the port and channel into the CommunicationToken.

Parameters:

port - port of the targetActor

channel - channel of the port

tokens - Array of tokens received from the channel within one iteration

setTargetActorName

public void setTargetActorName(java.lang.String targetActorName)

Set the full name of the targetActor that received the tokens that the CommunicationToken encapsulates.

Parameters:

targetActorName - the name of the target actor

See Also:

getTargetActorName()