Examples of PortParameter

ptolemy.actor.parameters.PortParameter
This parameter creates an associated port that can be used to update the current value of the parameter. This parameter has two values, which may not be equal, a current value and a persistent value. The persistent value is returned by getExpression() and is set by any of three different mechanisms:
- calling setExpression();
- calling setToken(); and
- specifying a value as a constructor argument.
All three of these will also set the current value, which is then equal to the persistent value. The current value is returned by get getToken() and is set by any of three different mechanisms:
- calling setCurrentValue();
- calling update() sets the current value if there is an associated port, and that port has a token to consume; and
These three techniques do not change the persistent value, so after these are used, the persistent value and current value may be different.
When using this parameter in an actor, care must be exercised to call update() exactly once per firing prior to calling getToken(). Each time update() is called, a new token will be consumed from the associated port (if the port is connected and has a token). If this is called multiple times in an iteration, it may result in consuming tokens that were intended for subsequent iterations. Thus, for example, update() should not be called in fire() and then again in postfire(). Moreover, in some domains (such as DE), it is essential that if a token is provided on a port, that it is consumed. In DE, the actor will be repeatedly fired until the token is consumed. Thus, it is an error to not call update() once per iteration. For an example of an actor that uses this mechanism, see Ramp.

If this actor is placed in a container that does not implement the TypedActor interface, then no associated port is created, and it functions as an ordinary parameter. This is useful, for example, if this is put in a library, where one would not want the associated port to appear.

There are a few situations where PortParameter might not do what you expect:
1. If it is used in a transparent composite actor, then a token provided to a PortParameter will never be read. A transparent composite actor is one without a director.
  Workaround: Put a director in the composite.
2. Certain actors (such as the Integrator in CT) read parameter values only during initialization. During initialization, a PortParameter can only have a value set via the parameter (it can't have yet received a token). So if the initial value of the Integrator is set to the value of the PortParameter, then it will see only the parameter value, never the value provided via the port.
  Workaround: Use a RunCompositeActor to contain the model with the Integrator.
@see ptolemy.actor.lib.Ramp @see ParameterPort @author Edward A. Lee @version $Id: PortParameter.java,v 1.46 2007/02/04 07:34:35 cxh Exp $ @since Ptolemy II 3.0 @Pt.ProposedRating Green (eal) @Pt.AcceptedRating Yellow (neuendor)

Examples of ptolemy.actor.parameters.PortParameter

            throws NameDuplicationException, IllegalActionException {
        super(container, name);


        output.setTypeEquals(BaseType.INT);


        mean = new PortParameter(this, "mean", new DoubleToken(1.0));
        mean.setTypeEquals(BaseType.DOUBLE);
        new SingletonParameter(mean.getPort(), "_showName")
                .setToken(BooleanToken.TRUE);


        mean.moveToFirst();

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

            throws NameDuplicationException, IllegalActionException {
        super(container, name);


        output.setTypeEquals(BaseType.DOUBLE);


        freedom = new PortParameter(this, "freedom", new DoubleToken(1.0));
        freedom.setTypeEquals(BaseType.DOUBLE);
        new SingletonParameter(freedom.getPort(), "_showName")
                .setToken(BooleanToken.TRUE);


        freedom.moveToFirst();

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

            throws NameDuplicationException, IllegalActionException {
        super(container, name);


        output.setTypeEquals(BaseType.DOUBLE);


        mean = new PortParameter(this, "mean", new DoubleToken(1.0));
        mean.setTypeEquals(BaseType.DOUBLE);
        new SingletonParameter(mean.getPort(), "_showName")
                .setToken(BooleanToken.TRUE);


        gamma = new PortParameter(this, "gamma", new DoubleToken(1.0));
        gamma.setTypeEquals(BaseType.DOUBLE);
        new SingletonParameter(gamma.getPort(), "_showName")
                .setToken(BooleanToken.TRUE);


        cut = new PortParameter(this, "cut", new DoubleToken(1.0));
        cut.setTypeEquals(BaseType.DOUBLE);
        new SingletonParameter(cut.getPort(), "_showName")
                .setToken(BooleanToken.TRUE);


        cut.moveToFirst();

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

    public Ramp(CompositeEntity container, String name)
            throws NameDuplicationException, IllegalActionException {
        super(container, name);
        init = new Parameter(this, "init");
        init.setExpression("0");
        step = new PortParameter(this, "step");
        step.setExpression("1");


        // set the type constraints.
        output.setTypeAtLeast(init);
        output.setTypeAtLeast(step);

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

            throws NameDuplicationException, IllegalActionException {
        super(container, name);


        output.setTypeEquals(BaseType.DOUBLE);


        mean = new PortParameter(this, "mean", new DoubleToken(0.0));
        mean.setTypeEquals(BaseType.DOUBLE);


        standardDeviation = new PortParameter(this, "standardDeviation");
        standardDeviation.setExpression("1.0");
        standardDeviation.setTypeEquals(BaseType.DOUBLE);
    }

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter


        numberOfBins = new Parameter(this, "numberOfBins");
        numberOfBins.setExpression("10");
        numberOfBins.setTypeEquals(BaseType.INT);


        inputCount = new PortParameter(this, "inputCount");
        inputCount.setExpression("10");
        inputCount.setTypeEquals(BaseType.INT);


        input_tokenConsumptionRate = new Parameter(input,
                "tokenConsumptionRate");

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

        derivative.setTypeEquals(BaseType.DOUBLE);


        state = new TypedIOPort(this, "state", false, true);
        state.setTypeEquals(BaseType.DOUBLE);


        initialState = new PortParameter(this, "initialState", new DoubleToken(
                0.0));
        initialState.setTypeEquals(BaseType.DOUBLE);
        cardinality = new StringAttribute(initialState.getPort(), "_cardinal");
        cardinality.setExpression("SOUTH");
    }

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

    public MicaCompositeActor(CompositeEntity container, String name)
            throws IllegalActionException, NameDuplicationException {
        super(container, name);


        // Persistent photo input port.
        photo = new PortParameter(this, "photo");
        photo.setExpression("0");
        photo.setTypeEquals(BaseType.DOUBLE);


        // Persistent temperature input port.
        temperature = new PortParameter(this, "temperature");
        temperature.setExpression("0");
        temperature.setTypeEquals(BaseType.DOUBLE);


        // Persistent microphone input port.
        microphone = new PortParameter(this, "microphone");
        microphone.setExpression("0");
        microphone.setTypeEquals(BaseType.DOUBLE);


        // Persistent accelerometer (x-axis) input port.
        accelerometerX = new PortParameter(this, "accelerometerX");
        accelerometerX.setExpression("0");
        accelerometerX.setTypeEquals(BaseType.DOUBLE);


        // Persistent accelerometer (y-axis) input port.
        accelerometerY = new PortParameter(this, "accelerometerY");
        accelerometerY.setExpression("0");
        accelerometerY.setTypeEquals(BaseType.DOUBLE);


        // Persistent magnetometer (x-axis) input port.
        magnetometerX = new PortParameter(this, "magnetometerX");
        magnetometerX.setExpression("0");
        magnetometerX.setTypeEquals(BaseType.DOUBLE);


        // Persistent magnetometer (y-axis) input port.
        magnetometerY = new PortParameter(this, "magnetometerY");
        magnetometerY.setExpression("0");
        magnetometerY.setTypeEquals(BaseType.DOUBLE);


        // Red LED output port.
        ledRed = new TypedIOPort(this, "ledRed", false, true);

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

        super(container, name);


        output.setTypeSameAs(input);


        // FIXME: Put in a name change from newServiceTime to serviceTime in MoML filters.
        serviceTime = new PortParameter(this, "serviceTime");
        serviceTime.setExpression("1.0");
        serviceTime.setTypeEquals(BaseType.DOUBLE);
        // Put the delay port at the bottom of the icon by default.
        StringAttribute cardinality = new StringAttribute(
                serviceTime.getPort(), "_cardinal");

View Full Code Here

Examples of ptolemy.actor.parameters.PortParameter

    /** Override the method of the super class to initialize the
     *  parameter values.
     */
    protected void _init() throws NameDuplicationException,
            IllegalActionException {
        delay = new PortParameter(this, "delay");
        delay.setExpression("1.0");
        delay.setTypeEquals(BaseType.DOUBLE);
    }

View Full Code Here

0 1 2 3 4 5

TOP

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.