Package ptolemy.domains.gr.kernel

Class SceneGraphToken

java.lang.Object

ptolemy.data.Token

ptolemy.domains.gr.kernel.SceneGraphToken

public class SceneGraphToken
extends Token

A token that contains a SceneGraph. This is used by the GR domain to get proper type checking across GR actors.

Since:

Ptolemy II 2.0

Version:

$Id$

Author:

Steve Neuendorffer

Pt.AcceptedRating:

Red (neuendor)

Pt.ProposedRating:

Red (neuendor)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SceneGraphToken.SceneGraphType	The SceneGraphToken type.

Field Summary

Fields

Modifier and Type	Field	Description
static Type	TYPE	The type of a SceneGraphToken.

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor	Description
SceneGraphToken(javax.media.j3d.Node node)	Construct a SceneGraphToken.

Method Summary

Modifier and Type	Method	Description
javax.media.j3d.Node	getSceneGraphNode()	Return the object contained by this token.
Type	getType()	Return the type of this token.
BooleanToken	isEqualTo(Token token)	Test for equality of the values of this Token and the argument 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, isCloseTo, isCloseTo, 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

Field Detail

TYPE

public static final Type TYPE

The type of a SceneGraphToken.

Constructor Detail

SceneGraphToken

public SceneGraphToken(javax.media.j3d.Node node)

Construct a SceneGraphToken.

Parameters:

node - The node.

Method Detail

getSceneGraphNode

public javax.media.j3d.Node getSceneGraphNode()

Return the object contained by this token.

Returns:

The scene graph node.

getType

public Type getType()

Return the type of this token.

Overrides:

getType in class Token

Returns:

the type of this token.

isEqualTo

public BooleanToken isEqualTo(Token token)
                       throws IllegalActionException

Test for equality of the values of this Token and the argument Token. It should be overridden in derived classes to provide type specific actions for equality testing.

Overrides:

isEqualTo in class Token

Parameters:

token - The token with which to test equality.

Returns:

A BooleanToken which contains the result of the test.

Throws:

IllegalActionException - If this method is not supported by the derived class.

toString

public 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. This method should be overridden by derived classes. In this base class, return the String "present" to indicate that an event is present.

Overrides:

toString in class Token

Returns:

The String "present".