uk.ac.sheffield.vtts.model

Class Scope

java.lang.Object

uk.ac.sheffield.vtts.model.Element

uk.ac.sheffield.vtts.model.Named

uk.ac.sheffield.vtts.model.Annotated

uk.ac.sheffield.vtts.model.Scope

Direct Known Subclasses:

Memory, Operation

public class Scope
extends Annotated

Scope represents a scope within which parameters may be declared. There are two specific kinds of Scope: Memory introduces Parameters declared in global scope; whereas Operation introduces Parameters declared in a local scope. Scope defines the table of Parameters used by both of these descendants, and also provides a means of merging global and local Scopes. Scope is a kind of Annotated element, since both Memory and Operation nodes may receive Warning notices during checking.

Version:

Broker@Cloud 1.0

Author:

Anthony J H Simons

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,Parameter>	parameters The set of Parameters in Scope.

Fields inherited from class uk.ac.sheffield.vtts.model.Annotated

notice

Fields inherited from class uk.ac.sheffield.vtts.model.Named

name

Constructor Summary

Constructors

Modifier	Constructor and Description
	Scope() Creates an unnamed Scope.
protected	Scope(java.lang.String name) Creates a named Scope.

Method Summary

Methods

Modifier and Type	Method and Description
Scope	addParameter(Parameter parameter) Adds a Parameter to this Scope.
Scope	addScope(Scope scope) Adds the contents of another Scope to this Scope.
Parameter	getParameter(java.lang.String name) Returns the named Parameter stored in this Scope.
java.util.Set<Parameter>	getParameters() Returns the set of all Parameters, both Constants and Variables.
Scope	unbind() Unbinds the variable Parameters in this Scope.

Methods inherited from class uk.ac.sheffield.vtts.model.Annotated

addNotice, getNotice

Methods inherited from class uk.ac.sheffield.vtts.model.Named

equals, getName, hashCode, setName, setName, toString

Methods inherited from class uk.ac.sheffield.vtts.model.Element

safeEquals, safeHashCode, semanticError

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected java.util.Map<java.lang.String,Parameter> parameters

The set of Parameters in Scope. A Parameter may be a Constant, a Variable, an Input or an Output.

Constructor Detail

Scope

public Scope()

Creates an unnamed Scope.

Scope

protected Scope(java.lang.String name)

Creates a named Scope.

Parameters:

name - the name of this Scope.

Method Detail

getParameter

public Parameter getParameter(java.lang.String name)

Returns the named Parameter stored in this Scope.

Parameters:

name - the name of the Parameter.

Returns:

the Parameter, or null.

getParameters

public java.util.Set<Parameter> getParameters()

Returns the set of all Parameters, both Constants and Variables.

Returns:

the set of all Parameters in this Scope.

addParameter

public Scope addParameter(Parameter parameter)

Adds a Parameter to this Scope.

Parameters:

parameter - the Parameter to add.

Returns:

this Scope.

addScope

public Scope addScope(Scope scope)

Adds the contents of another Scope to this Scope. This is used when building a Scope table of all the global Memory Parameters and local Operation Parameters to pass to a Scenario, when resolving the scopes of references to these Parameters.

Parameters:

scope - another Scope.

Returns:

this Scope.

unbind

public Scope unbind()

Unbinds the variable Parameters in this Scope. For every Parameter that is not a Constant, releases the current binding. The bound value of Variable, Input and Output parameters will be set to null.

Returns:

this Scope.