Examples of ptolemy.data.expr.Variable

ptolemy.data.expr.Variable
A Variable is an Attribute that contains a token, and can be set by an expression that can refer to other variables.
A variable can be given a token or an expression as its value. To create a variable with a token, either call the appropriate constructor, or create the variable with the appropriate container and name, and then call setToken(). To set the value from an expression, call setExpression(). The expression is not actually evaluated until you call getToken(), getType(). By default, it is also evaluated when you call validate(), unless you have called setLazyValidation(true), in which case it will only be evaluated if there are other variables that depend on it and those have not had setLazyValidation(true) called.
Consider for example the sequence:
```
 Variable v3 = new Variable(container,"v3"); Variable v2 = new Variable(container,"v2"); Variable v1 = new Variable(container,"v1"); v3.setExpression("v1 + v2"); v2.setExpression("1.0"); v1.setExpression("2.0"); v3.getToken(); 
```
Notice that the expression for v3 cannot be evaluated when it is set because v2 and v1 do not yet have values. But there is no problem because the expression is not evaluated until getToken() is called. Equivalently, we could have called, for example,
```
 v3.validate(); 
```
This will force v3 to be evaluated, and also v1 and v2 to be evaluated.
There is a potentially confusing subtlety. In the above code, before the last line is executed, the expression for v3 has not been evaluated, so the dependence that v3 has on v1 and v2 has not been recorded. Thus, if we call
```
 v1.validate(); 
```
before v3 has ever been evaluated, then it will not trigger an evaluation of v3. Because of this, we recommend that user code call validate() immediately after calling setExpression().
If the expression string is null or empty, or if no value has been specified, then getToken() will return null.
The expression can reference variables that are in scope before the expression is evaluated (i.e., before getToken() or validate() is called). Otherwise, getToken() will throw an exception. All variables contained by the same container, and those contained by the container's container, are in the scope of this variable. Thus, in the above, all three variables are in each other's scope because they belong to the same container. If there are variables in the scope with the same name, then those lower in the hierarchy shadow those that are higher. An instance of ScopeExtendingAttribute can also be used to aggregate a set of variables and add them to the scope.
If a variable is referred to by expressions of other variables, then the name of the variable must be a valid identifier as defined by the Ptolemy II expression language syntax. A valid identifier starts with a letter or underscore, and contains letters, underscores, numerals, dollar signs ($), at signs (@), or pound signs (#).
A variable is a Typeable object. Constraints on its type can be specified relative to other Typeable objects (as inequalities on the types), or relative to specific types. The former are called dynamic type constraints, and the latter are called static type constraints. Static type constraints are specified by the methods:
- setTypeEquals()
- setTypeAtMost()
whereas dynamic type constraints are given by
- setTypeAtLeast()
- setTypeSameAs()
Static type constraints are enforced in this class, meaning that:
- If the variable already has a value (set by setToken() or setExpression()) when you set the static type constraint, then the value must satisfy the type constraint; and
- If after setting a static type constraint you give the token a value, then the value must satisfy the constraints.
A violation will cause an exception (either when setToken() is called or when the expression is evaluated).
The dynamic type constraints are not enforced in this class, but merely reported by the typeConstraintList() method. They must be enforced at a higher level (by a type system) since they involve a network of variables and other typeable objects. In fact, if the variable does not yet have a value, then a type system may use these constraints to infer what the type of the variable needs to be, and then call setTypeEquals().
The token returned by getToken() is always an instance of the class given by the getType() method. This is not necessarily the same as the class of the token that was inserted via setToken(). It might be a distinct type if the token given by setToken() can be converted losslessly into one of the type given by setTypeEquals().
A variable by default has no MoML description (MoML is an XML modeling markup language). Thus, a variable contained by a named object is not persistent, in that if the object is exported to a MoML file, the variable will not be represented. If you prefer that the variable be represented, then you should use the derived class Parameter instead.
A variable is also normally not settable by casual users from the user interface. This is because, by default, getVisibility() returns EXPERT. The derived class Parameter is fully visible by default.
In addition, this class provides as a convenience a "string mode." If the variable is in string mode, then when setting the value of this variable, the string that you pass to setExpression(String) is taken to be literally the value of the instance of StringToken that represents the value of this parameter. It is not necessary to enclose it in quotation marks (and indeed, if you do, the quotation marks will become part of the value of the string). In addition, the type of this parameter will be set to string. In addition, getToken() will never return null; if the value of the string has never been set, then an instance of StringToken is returned that has an empty string as its value. A parameter is in string mode if either setStringMode(true) has been called or it contains an attribute named "_stringMode".
In string mode, the value passed to setExpression(String) may contain references to other variables in scope using the syntax $id, ${id} or $(id). The first case only works if the id consists only of alphanumeric characters and/or underscore, and if the character immediately following the id is not one of these. To get a simple dollar sign, use $$. In string mode, to set the value to be the empty string, create a Parameter in the container that has the value "" and then set the string mode parameter to the $nameOfTheParameter. For example, the parameter might be named myEmptyParameter and have a value ""; the value for the string mode parameter would be $myEmptyParameter. @author Neil Smyth, Xiaojun Liu, Edward A. Lee, Yuhong Xiong @version $Id: Variable.java,v 1.228 2007/12/07 06:31:23 cxh Exp $ @since Ptolemy II 0.2 @Pt.ProposedRating Red (neuendor) @Pt.AcceptedRating Red (cxh) @see ptolemy.data.Token @see ptolemy.data.expr.PtParser @see ptolemy.data.expr.Parameter @see ScopeExtendingAttribute @see #setPersistent(boolean)

        }
    }


    public InequalityTerm getTypeTerm(String name)
            throws IllegalActionException {
        Variable result = getScopedVariable(null, _container, name);


        if (result != null) {
            return result.getTypeTerm();
        } else {
            return null;
        }
    }

View Full Code Here

     *  @return The variable with the specified name in the given port.
     *  @exception IllegalActionException Not thrown in this method.
     *  @see #setRateVariable(Port, String, int)
     */
    public static Variable getRateVariable(Port port, String name) {
        Variable parameter = (Variable) port.getAttribute(name);


        if (parameter == null) {
            String altName = "_" + name;
            parameter = (Variable) port.getAttribute(altName);
        }

View Full Code Here

     *  @exception IllegalActionException If the variable does not contain
     *  a valid token, or the token is not an IntToken.
     */
    public static int getRateVariableValue(Port port, String name,
            int defaultValue) throws IllegalActionException {
        Variable parameter = getRateVariable(port, name);


        if (parameter == null) {
            return defaultValue;
        }


        Token token = parameter.getToken();


        if (token instanceof IntToken) {
            return ((IntToken) token).intValue();
        } else {
            throw new IllegalActionException("Variable "
                    + parameter.getFullName() + " was expected "
                    + "to contain an IntToken, but instead " + "contained a "
                    + token.getType() + ".");
        }
    }

View Full Code Here

     *  @exception IllegalActionException If a new parameter can not be
     *  created for the give port.
     */
    public static void setExpressionIfNotDefined(Port port, String name,
            String value) throws IllegalActionException {
        Variable rateParameter = (Variable) port.getAttribute(name);


        if (rateParameter == null) {
            try {
                String altName = "_" + name;
                rateParameter = (Variable) port.getAttribute(altName);


                if (rateParameter == null) {
                    rateParameter = new Parameter(port, altName);
                    rateParameter.setVisibility(Settable.NOT_EDITABLE);
                    rateParameter.setPersistent(false);
                }


                rateParameter.setExpression(value);
            } catch (KernelException ex) {
                throw new InternalErrorException(port, ex, "Should not occur");
            }
        }
    }

View Full Code Here

     *  @exception IllegalActionException If a new parameter can not be
     *  created for the given port, or the given value is not an acceptable.
     */
    public static void setIfNotDefined(Port port, String name, int value)
            throws IllegalActionException {
        Variable rateParameter = (Variable) port.getAttribute(name);


        if (rateParameter == null) {
            try {
                String altName = "_" + name;
                rateParameter = (Variable) port.getAttribute(altName);


                if (rateParameter == null) {
                    rateParameter = new Parameter(port, altName);
                    rateParameter.setVisibility(Settable.NOT_EDITABLE);
                    rateParameter.setPersistent(false);
                }


                rateParameter.setToken(new IntToken(value));
            } catch (KernelException ex) {
                throw new InternalErrorException(port, ex, "Should not occur");
            }
        }
    }

View Full Code Here

     *  @param context The context for the preference.
     *  @param preferenceName The name of the preference.
     *  @return The value of the preference, or null if it is not set.
     */
    public static Token preferenceValue(NamedObj context, String preferenceName) {
        Variable result = ModelScope.getScopedVariable(null, context,
                preferenceName);


        if (result != null) {
            try {
                return result.getToken();
            } catch (IllegalActionException ex) {
                System.out.println("Warning: Invalid preference: " + ex);
            }
        }

View Full Code Here

        // Make the current global variables conform with any
        // overridden preference values.
        Iterator parameters = attributeList(Variable.class).iterator();


        while (parameters.hasNext()) {
            Variable parameter = (Variable) parameters.next();
            Token token = parameter.getToken();
            Constants.add(parameter.getName(), token);
        }
    }

View Full Code Here

                if (child instanceof ActorScopeExtender) {
                    continue;
                }


                try {
                    Variable variable = NamedObjVariable.getNamedObjVariable(
                            child, true);
                    if (variable != null) {
                        _attributeList.add(variable);
                    }
                } catch (IllegalActionException e) {

View Full Code Here

        if (child == null) {
            return super.getAttribute(name);
        }


        try {
            Variable actorVariable = NamedObjVariable.getNamedObjVariable(
                    child, true);
            return actorVariable;
        } catch (IllegalActionException e) {
            throw new InternalErrorException(e);
        }

View Full Code Here

        // Next, compute the set of variable names defined in this container.
        Set variableNames = new HashSet();


        for (Iterator variables = model.attributeList(Variable.class)
                .iterator(); variables.hasNext();) {
            Variable variable = (Variable) variables.next();
            variableNames.add(variable.getName());
        }


        variableNames = Collections.unmodifiableSet(variableNames);


        // Free variables of contained actors that are defined in this
        // container are not free variables of this container.
        set.removeAll(variableNames);


        // Iterate over all the variables of this container, and add in
        // any free variables they reference.
        PtParser parser = new PtParser();
        ParseTreeFreeVariableCollector collector = new ParseTreeFreeVariableCollector();


        for (Iterator variables = model.attributeList(Variable.class)
                .iterator(); variables.hasNext();) {
            Variable variable = (Variable) variables.next();
            String expression = variable.getExpression();
            ASTPtRootNode root;


            if (variable.isStringMode()) {
                root = parser.generateStringParseTree(expression);
            } else {
                root = parser.generateParseTree(expression);
            }


            Set freeIdentifiers = new HashSet(collector
                    .collectFreeVariables(root));


            // Identifiers that reference other variables in the same container
            // are bound, not free.
            Set tempSet = new HashSet(variableNames);
            tempSet.remove(variable.getName());
            freeIdentifiers.removeAll(tempSet);


            set.addAll(freeIdentifiers);
        }

View Full Code Here

0 1 2 3 4 5 6 7 8

TOP

Related Classes of ptolemy.data.expr.Variable

ptolemy.actor.gt.ActorScopeExtender

ptolemy.actor.gt.util.VariableScope

ptolemy.actor.gui.ExpressionShellTableau

ptolemy.actor.gui.PtolemyPreferences

ptolemy.actor.gui.TokenEffigy

ptolemy.actor.lib.conversions.ExpressionToToken$ExpressionScope

ptolemy.actor.lib.Expression$VariableScope

ptolemy.actor.lib.hoc.IterateOverArray

ptolemy.actor.lib.hoc.RunCompositeActor

ptolemy.actor.lib.io.ExpressionReader

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.