ptolemy.data.ontologies

Class ActorModelScope

java.lang.Object

ptolemy.data.expr.ModelScope

ptolemy.data.ontologies.ActorModelScope

All Implemented Interfaces:

ParserScope

public class ActorModelScope
extends ModelScope

A Ptolemy expression language parser scope that refers to a specific actor and its contained elements.

Since:

Ptolemy II 10.0

Version:

$Id: ActorModelScope.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Charles Shelton

Accepted Rating:

Red (cshelton)

Proposed Rating:

Red (cshelton)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) NamedObj	_modelObject The Ptolemy NamedObj that defined the expression parser model element scope.

Constructor Summary

Constructors

Constructor and Description
ActorModelScope(NamedObj modelObject) Create a new ActorModelScope for the given Ptolemy NamedObj element.

Method Summary

Modifier and Type	Method and Description
Token	get(java.lang.String name) Look up and return the value with the specified name in the scope.
Type	getType(java.lang.String name) Look up and return the type of the value 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<java.lang.String>	identifierSet() Return a list of names corresponding to the identifiers defined by this 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

Field Detail

_modelObject

NamedObj _modelObject

The Ptolemy NamedObj that defined the expression parser model element scope.

Constructor Detail

ActorModelScope

public ActorModelScope(NamedObj modelObject)

Create a new ActorModelScope for the given Ptolemy NamedObj element.

Parameters:

modelObject - The Ptolemy NamedObj which defines the expression parser model scope.

Method Detail

get

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

Look up and return the value with the specified name in the scope. Return null if the name is not defined in this scope.

Parameters:

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

Returns:

The token 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.

getType

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

Look up and return the type of the value with the specified name in the scope. Return null if the name is not defined in this scope.

Parameters:

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

Returns:

The token 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.

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<java.lang.String> identifierSet()
                                              throws IllegalActionException

Return a list of names corresponding to the identifiers defined by this scope. If an identifier is returned in this list, then get() and getType() will return a value for the identifier. Note that generally speaking, this list is extremely expensive to compute, and users should avoid calling it. It is primarily used for debugging purposes.

Returns:

A list of names corresponding to the identifiers defined by this scope.

Throws:

IllegalActionException - If constructing the list causes it.