ptolemy.vergil.scr

Class VariableScope

java.lang.Object

ptolemy.data.expr.ModelScope

ptolemy.vergil.scr.VariableScope

All Implemented Interfaces:

ParserScope

public class VariableScope
extends ModelScope

VariableScope class.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

pd

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Constructor Summary

Constructors

Constructor and Description
VariableScope(FSMActor model) Construct a VariableScope for a model.

Method Summary

Modifier and Type	Method and Description
Token	get(java.lang.String name) Look up and return the attribute with the specified name in the scope.
Type	getType(java.lang.String name) Look up and return the type of the attribute with the specified name in the scope.
InequalityTerm	getTypeTerm(java.lang.String name) Look up and return the type term for the specified name in the scope.
java.util.Set	identifierSet() Return the list of identifiers within the scope.

Methods inherited from class ptolemy.data.expr.ModelScope

getAllScopedObjectNames, getAllScopedVariableNames, getScopedAttribute, getScopedObject, getScopedVariable, preferenceValue

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableScope

public VariableScope(FSMActor model)

Construct a VariableScope for a model.

Parameters:

model - The model.

Method Detail

get

public Token get(java.lang.String name)
          throws IllegalActionException

Look up and return the attribute with the specified name in the scope. Return null if such an attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

The attribute with the specified name in the scope.

Throws:

IllegalActionException - If a value in the scope exists with the given name, but cannot be evaluated.

getType

public Type getType(java.lang.String name)
             throws IllegalActionException

Look up and return the type of the attribute with the specified name in the scope. Return null if such an attribute does not exist.

Parameters:

name - The name of the attribute.

Returns:

The attribute with the specified name in the scope.

Throws:

IllegalActionException - If a value in the scope exists with the given name, but cannot be evaluated.

getTypeTerm

public InequalityTerm getTypeTerm(java.lang.String name)
                           throws IllegalActionException

Look up and return the type term for the specified name in the scope. Return null if the name is not defined in this scope, or is a constant type.

Parameters:

name - The name of the variable to be looked up.

Returns:

The InequalityTerm associated with the given name in the scope.

Throws:

IllegalActionException - If a value in the scope exists with the given name, but cannot be evaluated.

identifierSet

public java.util.Set identifierSet()

Return the list of identifiers within the scope.

Returns:

The list of identifiers within the scope.