ptserver.data

Class RemoteEventToken

java.lang.Object

ptolemy.data.Token

ptserver.data.RemoteEventToken

public class RemoteEventToken
extends Token

Encapsulates an informational token raised by the proxy model infrastructure.

Since:

Ptolemy II 10.0

Version:

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

Author:

Justin Killian

Accepted Rating:

Red (jkillian)

Proposed Rating:

Red (jkillian)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoteEventToken.EventType Type of notification message being sent to the user.

Field Summary

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor and Description
RemoteEventToken() Initialize the token using its superclass.
RemoteEventToken(RemoteEventToken.EventType eventType, java.lang.String message) Initialize the token with a name and event type.
RemoteEventToken(java.lang.String message, java.lang.Throwable exception) Initialize the token when an exception has occurred.

Method Summary

Modifier and Type	Method and Description
RemoteEventToken.EventType	getEventType() Get the type of notification sent to the user.
java.lang.String	getMessage() Get the informational message associated with the token.
java.lang.String	toString() Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value.

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, zero, zeroReturnType

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteEventToken

public RemoteEventToken()

Initialize the token using its superclass.

RemoteEventToken

public RemoteEventToken(RemoteEventToken.EventType eventType,
                        java.lang.String message)

Initialize the token with a name and event type.

Parameters:

eventType - The type of event to alert the user of.

message - The accompanying message to explain the event.

RemoteEventToken

public RemoteEventToken(java.lang.String message,
                        java.lang.Throwable exception)

Initialize the token when an exception has occurred.

Parameters:

message - The accompanying message to explain the event.

exception - Exception thrown by the active simulation.

Method Detail

getEventType

public RemoteEventToken.EventType getEventType()

Get the type of notification sent to the user.

Returns:

The type of the notification.

getMessage

public java.lang.String getMessage()

Get the informational message associated with the token.

Returns:

The informational message provided to the user.

toString

public java.lang.String toString()

Description copied from class: Token

Return the value of this token as a string that can be parsed by the expression language to recover a token with the same value. This method should be overridden by derived classes. In this base class, return the String "present" to indicate that an event is present. If this token is Token.NIL then return "nil"

Overrides:

toString in class Token

Returns:

The String "present", unless this token is Token.NIL, in which case return the String "nil".