Kepler

<?xml version="1.0" standalone="no"?>

<!DOCTYPE entity PUBLIC "-//UC Berkeley//DTD MoML 1//EN"

    "http://ptolemy.eecs.berkeley.edu/xml/dtd/MoML_1.dtd">

<entity name="paramx" class="ptolemy.actor.TypedCompositeActor">

    <display name="paramx"/>

    <property name="_createdBy" class="ptolemy.kernel.attributes.VersionAttribute" value="8.1.devel">

    </property>

    <property name="SDF Director" class="ptolemy.domains.sdf.kernel.SDFDirector">

        <property name="iterations" class="ptolemy.data.expr.Parameter" value="0">

        </property>

        <property name="vectorizationFactor" class="ptolemy.data.expr.Parameter" value="1">

        </property>

        <property name="allowDisconnectedGraphs" class="ptolemy.data.expr.Parameter" value="false">

        </property>

        <property name="allowRateChanges" class="ptolemy.data.expr.Parameter" value="false">

        </property>

        <property name="constrainBufferSizes" class="ptolemy.data.expr.Parameter" value="true">

        </property>

        <property name="period" class="ptolemy.data.expr.Parameter" value="0.0">

        </property>

        <property name="synchronizeToRealTime" class="ptolemy.data.expr.Parameter" value="false">

        </property>

        <property name="timeResolution" class="ptolemy.actor.parameters.SharedParameter" value="1E-10">

        </property>

        <property name="Scheduler" class="ptolemy.domains.sdf.kernel.SDFScheduler">

            <property name="constrainBufferSizes" class="ptolemy.data.expr.Parameter" value="constrainBufferSizes">

            </property>

        </property>

<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">

<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Steve Neuendorffer</configure></property>

<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="userLevelDocumentation" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>&#10;&lt;p&gt;The SDF Director is often used to oversee fairly simple, sequential workflows in which the director can determine the order of actor invocation from the workflow. Types of workflows that would run well under an SDF Director include processing and reformatting tabular data, converting one data type to another, and reading and plotting a series of data points. A workflow in which an image is read, processed (rotated, scaled, clipped, filtered, etc.), and then displayed, is also an example of a sequential workflow that requires a director simply to ensure that each actor fires in the proper order (i.e., that each actor executes only after it receives its required inputs).&lt;/p&gt;&#10;&#10;&lt;p&gt;The SDF Director is very efficient and will not tax system resources with overhead. However, this efficiency requires that certain conditions be met, namely that the data consumption and production rate of each actor in an SDF workflow be constant and declared. If an actor reads one piece of data and calculates and outputs a single result, it must always read and output a single token of data. This data rate cannot change during workflow execution and, in general, workflows that require dynamic scheduling and/or flow control cannot use this director. Additionally, the SDF Director has no understanding of passing time (at least by default), and actors that depend on a notion of time may not work as expected. For example, a TimedPlotter actor will plot all values at time zero when used in SDF. &lt;/p&gt;&#10;&#10;&lt;p&gt;By default, the SDF Director requires that all actors in its workflow be connected. Otherwise, the director cannot account for concurrency between disconnected workflow parts. Usually, a PN Director should be used for workflows that contain disconnected actors; however, the SDF Director's allowDisconnectedGraphs parameter may also be set to true. The SDF Director will then schedule each disconnected &quot;island&quot; independently. The director cannot infer the sequential relationship between disconnected actors (i.e., nothing forces the director to finish executing all actors on one island before firing actors on another). However, the order of execution within each island should be correct. Usually, disconnected graphs in an SDF model indicate an error.&lt;/p&gt;&#10; &#10;&lt;p&gt;Because SDF Directors schedule actors to fire only after they receive their inputs, workflows that require loops (feeding an actor's output back into its input port for further processing) can cause &quot;deadlock&quot; errors. The deadlock errors occur because the actor depends on its own output value as an initial input. To fix this problem, use a SampleDelay actor to generate and inject an initial input value into the workflow.&lt;/p&gt;&#10;&#10;&lt;p&gt;The SDF Director determines the order in which actors execute and how many times each actor needs to be fired to complete a single iteration of the workflow. This schedule is calculated BEFORE the director begins to iterate the workflow. Because the SDF Director calculates a schedule in advance, it is quite efficient. However, SDF workflows must be static. In other words, the same number of tokens must be consumed/produced at every iteration of the workflow. Workflows that require dynamic control structures, such as a BooleanSwitch actor that sends output on one of two ports depending on the value of a 'control', cannot be used with an SDF Director because the number of tokens on each output can change for each execution.&lt;/p&gt;&#10;&#10;&lt;p&gt;Unless otherwise specified, the SDF Director assumes that each actor consumes and produces exactly one token per channel on each firing. Actors that do not follow the one-token-per-channel firing convention (e.g., Repeat or Ramp) must declare the number of tokens they produce or consume via the appropriate parameters. &lt;/p&gt;&#10;&#10;&lt;p&gt;The number of times a workflow is iterated is controlled by the director's iterations parameter. By default, this parameter is set to &quot;0&quot;. Note that &quot;0&quot; does not mean &quot;no iterations.&quot; Rather, &quot;0&quot; means that the workflow will iterate forever. Values greater than zero specify the actual number of times the director should execute the entire workflow. A value of 1, meaning that the director will run the workflow once, is often the best setting when building an SDF workflow. &lt;/p&gt;&#10;&#10;&lt;p&gt;The amount of data processed by an SDF workflow is a function of both the number of times the workflow iterates and the value of the director's vectorizationFactor parameter. The vectorizationFactor is used to increase the efficiency of a workflow by increasing the number of times actors fire each time the workflow iterates. If the parameter is set to a positive integer (other than 1), the director will fire each actor the specified number of times more than normal. The default is 1, indicating that no vectorization should be performed. Keep in mind that changing the vectorizationFactor parameter changes the meaning of a nested SDF workflow and may cause deadlock in a workflow that uses it. &lt;/p&gt;&#10;&#10;&lt;p&gt;The SDF Director has several advanced parameters that are generally only relevant when an SDF workflow contains composite components. In most cases the period, timeResolution, synchronizeToRealTime, allowRateChanges, timeResolution, and constrainBufferSizes parameters can be left at their default values.&lt;/p&gt;&#10;&#10;&lt;p&gt;For more information about the SDF Director, see the Ptolemy documentation (http://ptolemy.eecs.berkeley.edu/papers/05/ptIIdesign3-domains/ptIIdesign3-domains.pdf).&lt;/p&gt;&#10;&#10;</configure></property>

<property name="prop:allowDisconnectedGraphs" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether to allow disconnected actors in the workflow (by default, all actors are required to be connected). If disconnected actors are permitted, the SDF Director will schedule each disconnected 'island' independently. Nothing &quot;forces&quot; the director to finish executing all actors on one island before firing actors on another. However, the order of execution within each island should be correct. Usually, disconnected graphs in an SDF workflow indicate an error.</configure></property>

<property name="prop:allowRateChanges" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether dynamic rate changes are permitted or not. By default, rate changes are not permitted, and the director will perform a check to disallow such workflows. If the parameter is selected, then workflows that require rate parameters to be modified during execution are valid, and the SDF Director will dynamically compute a new schedule at runtime. This is an advanced parameter that can usually be left at its default value.</configure></property>

<property name="prop:constrainBufferSizes" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether buffer sizes are fixed. By default, buffers are fixed, and attempts to write to the buffer that cause the buffer to exceed its scheduled size result in an error. This is an advanced parameter that can usually be left at its default value.</configure></property>

<property name="prop:timeResolution" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The time precision used by this director. All time values are rounded to the nearest multiple of this number. The value is a double that defaults to &quot;1E-10&quot; (which is 10-10). This is an advanced parameter that can usually be left at its default value.</configure></property>

<property name="prop:iterations" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify the number of times a workflow is iterated. By default, this parameter is set to &quot;0&quot;. Note that &quot;0&quot; does not mean &quot;no iterations.&quot; Rather, &quot;0&quot; means that the workflow will iterate forever. Values greater than zero specify the actual number of times the director should execute the entire workflow. A value of 1, meaning that the director will run the workflow once, is often the best setting when building an SDF workflow. </configure></property>

<property name="prop:vectorizationFactor" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The vectorizationFactor is used to increase the efficiency of a workflow by increasing the number of times actors fire each time the workflow iterates. If the parameter is set to a positive integer (other than 1), the director will fire each actor the specified number of times more than normal. The default is 1, indicating that no vectorization should be performed. Keep in mind that changing the vectorizationFactor parameter changes the meaning of a nested SDF workflow and may cause deadlock in a workflow that uses it. </configure></property>

<property name="prop:synchronizeToRealTime" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether the execution should synchronize to real time or not. By default, the director does not synchronize to real time. If synchronize is selected, the director will only process the workflow when elapsed real time matches the product of the period parameter and the iteration count. Note: if the period parameter has a value of 0.0 (the default), then selecting this parameter has no effect. This is an advanced parameter that can usually be left at its default value.</configure></property>

<property name="prop:period" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The time period of each iteration. The value is a double that defaults to 0.0, which means that the director does not increment workflow time. If the value greater than 0.0, the actor will increment workflow time each time it fires. This is an advanced parameter that can usually be left at its default value. </configure></property>

</property>        

        <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.domains.sdf.kernel.SDFDirector">

            <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:directorclass:1:2">

            </property>

        </property>

        <property name="_location" class="ptolemy.kernel.util.Location" value="{100, 65}">

        </property>

    </property>

    <property name="x" class="ptolemy.data.expr.Parameter" value="1">

<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">

<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="userLevelDocumentation" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

</property>

        <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.data.expr.Parameter">

            <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:class:1184:1">

            </property>

        </property>

        <property name="_hideName" class="ptolemy.kernel.util.SingletonAttribute">

        </property>

        <property name="_icon" class="ptolemy.vergil.icon.ValueIcon">

            <property name="_color" class="ptolemy.actor.gui.ColorAttribute" value="{0.0, 0.0, 1.0, 1.0}">

            </property>

        </property>

        <property name="_smallIconDescription" class="ptolemy.kernel.util.SingletonConfigurableAttribute">

            <configure>

      <svg>

        <text x="20" style="font-size:14; font-family:SansSerif; fill:blue" y="20">-P-</text>

      </svg>

    </configure>

        </property>

        <property name="_editorFactory" class="ptolemy.vergil.toolbox.VisibleParameterEditorFactory">

        </property>

        <property name="_location" class="ptolemy.kernel.util.Location" value="{305, 60}">

        </property>

    </property>

    <property name="_windowProperties" class="ptolemy.actor.gui.WindowPropertiesAttribute" value="{bounds={183, 46, 1073, 807}, maximized=false}">

    </property>

    <property name="_vergilSize" class="ptolemy.actor.gui.SizeAttribute" value="[732, 654]">

    </property>

    <property name="_vergilZoomFactor" class="ptolemy.data.expr.ExpertParameter" value="1.0">

    </property>

    <property name="_vergilCenter" class="ptolemy.data.expr.ExpertParameter" value="{366.0, 327.0}">

    </property>

    <entity name="Constant" class="ptolemy.actor.lib.Const">

        <property name="firingCountLimit" class="ptolemy.data.expr.Parameter" value="1">

        </property>

        <property name="NONE" class="ptolemy.data.expr.Parameter" value="0">

        </property>

        <property name="value" class="ptolemy.data.expr.Parameter" value="x">

        </property>

<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">

<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="userLevelDocumentation" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>&lt;p&gt;The Constant actor outputs a constant, which is specified by the value parameter. By default, the actor outputs the integer 1.&lt;/p&gt;&#10;&#10;&lt;p&gt;The actor can be used to output other types of values, e.g., a string (such as &quot;Hello&quot;) or a double (such as 1.2). The actor'&#10;s output type matches the type of the specified value.&lt;/p&gt;&#10;&#10;&lt;p&gt;NOTE: If using a PN Director, the 'firingCountLimit' parameter is often set to a finite integer (e.g. '1') so that the workflow will terminate. &lt;/p&gt;&#10;</configure></property>

<property name="port:output" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>An output port that broadcasts the specified constant. By default, the output is 1.</configure></property>

<property name="port:trigger" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>A multiport that has no declared type (in other words, the port can accept any data type: double, int, array, etc.) If the port is connected, the actor will not fire until the trigger port receives an input token. Connecting the port is optional, but useful when scheduling the actor to perform at a certain time.</configure></property>

<property name="prop:firingCountLimit" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The limit on the number of times the actor will fire. The default value is 'NONE', meaning there is no limit on the number of time the constant will be provided to the output port. Any integer can be provided as a value for this parameter.</configure></property>

<property name="prop:value" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The value produced by the Constant actor. By default, the value is the integer token 1. The value can be set to another type, e.g., a string (such as &quot;Hello&quot;) or a double (such as 1.2). The  output type matches the type of the value specified here.</configure></property>

</property>

        <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.actor.lib.Const">

            <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:class:877:1">

            </property>

        </property>

        <property name="kar" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:kar:57:1">

        </property>

        <property name="_icon" class="ptolemy.vergil.icon.BoxedValueIcon">

            <property name="attributeName" class="ptolemy.kernel.util.StringAttribute" value="value">

            </property>

            <property name="displayWidth" class="ptolemy.data.expr.Parameter" value="40">

            </property>

        </property>

        <property name="_location" class="ptolemy.kernel.util.Location" value="{100, 180}">

        </property>

    </entity>

    <entity name="Line Writer" class="ptolemy.actor.lib.io.LineWriter">

        <property name="fileName" class="ptolemy.actor.parameters.FilePortParameter" value="System.out">

        </property>

        <property name="append" class="ptolemy.data.expr.Parameter" value="false">

        </property>

        <property name="confirmOverwrite" class="ptolemy.data.expr.Parameter" value="true">

        </property>

        <property name="alwaysFlush" class="ptolemy.data.expr.Parameter" value="false">

        </property>

<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">

<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Edward A. Lee</configure></property>

<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>

<property name="userLevelDocumentation" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>&lt;p&gt;The LineWriter actor reads a string token and writes it, one line at a time and without enclosing quotation marks, to a file. The actor has no output.&lt;/p&gt;&#10;&#10;&lt;p&gt;The actor is similar to the FileWriter and TextFileWriter actors, except that the LineWriter does not output the generated file path, while the other two actors do. To write to a file one line at a time with enclosing quotation marks, use the ExpressionWriter actor. &lt;/p&gt;&#10;&#10;&lt;p&gt;Specify whether the input tokens are appended to the specified file (if it exists), or if an existing file is overwritten--with or without confirmation--via the append and confirmOverwrite parameters.&lt;/p&gt;</configure></property>

<property name="port:input" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>An input port that receives a string token to write--one line at a time--to a file.</configure></property>

<property name="prop:append" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether to append the generated file to the existing, specified file. By default, the actor will overwrite any preexisting file.</configure></property>

<property name="prop:confirmOverwrite" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether the actor should confirm before overwriting an existing file. By default, the actor will not ask for confirmation.</configure></property>

<property name="prop:fileName" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The file name to which to write. See FileParameter for more information about specifying file names. The default value is &quot;System.out&quot;.</configure></property>

</property>

        <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.actor.lib.io.LineWriter">

            <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:class:938:1">

            </property>

        </property>

        <property name="_location" class="ptolemy.kernel.util.Location" value="{230, 185}">

        </property>

    </entity>

    <relation name="relation" class="ptolemy.actor.TypedIORelation">

    </relation>

    <link port="Constant.output" relation="relation"/>

    <link port="Line Writer.input" relation="relation"/>

</entity>