Project

General

Profile

hello-report-metadata.xml

Sean Riddle, 04/30/2010 02:05 PM

 
1
<?xml version="1.0"?>
2
<kar:kar xmlns:kar="http://www.kepler-project.org/kar-2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.kepler-project.org/kar-2.0.0 https://code.kepler-project.org/code/kepler/branches/releases/release-branches/core-2.0/resources/KARFile.xsd">
3
        <karFileName>
4
                hello-report.kar
5
        </karFileName>
6
        <karFileSize>
7
                6133
8
        </karFileSize>
9
        <mainAttributes>
10
                <KAR-Version>
11
                        2.0
12
                </KAR-Version>
13
                <Manifest-Version>
14
                        1.4.2
15
                </Manifest-Version>
16
                <module-dependencies>
17
                        provenance;core;reporting
18
                </module-dependencies>
19
                <lsid>
20
                        urn:lsid:kepler-project.org/ns/:882:14:1
21
                </lsid>
22
        </mainAttributes>
23
        <karEntry>
24
                <karEntryAttributes>
25
                        <Name>
26
                                hello-report.urn.lsid.kepler-project.org.ns..882.3.20.xml
27
                        </Name>
28
                        <type>
29
                                ptolemy.actor.TypedCompositeActor
30
                        </type>
31
                        <lsid>
32
                                urn:lsid:kepler-project.org/ns/:882:3:20
33
                        </lsid>
34
                        <handler>
35
                                org.kepler.kar.handlers.ActorMetadataKAREntryHandler
36
                        </handler>
37
                        <dependsOnModule>
38
                                provenance;core
39
                        </dependsOnModule>
40
                </karEntryAttributes>
41
                <karEntryXML>
42

    
43

    
44
<entity name="hello-report" class="org.kepler.moml.CompositeClassEntity">
45
<property name="entityId"  value="urn:lsid:kepler-project.org/ns/:882:3:20" class="org.kepler.moml.NamedObjId"/>
46
<property name="class" value="ptolemy.actor.TypedCompositeActor" class="ptolemy.kernel.util.StringAttribute">
47
  <property name="id" value="null" class="ptolemy.kernel.util.StringAttribute"/>
48
</property>
49

    
50
<property name="derivedFrom" class="org.kepler.moml.NamedObjIdReferralList">
51
</property>
52

    
53

    
54
<property name="TOP Provenance Recorder" class="org.kepler.provenance.ProvenanceRecorder">
55
</property>
56

    
57
<property name="module-dependencies" class="ptolemy.kernel.util.StringAttribute" value="provenance;core">
58
</property>
59

    
60
<property name="Reporting Listener" class="org.kepler.module.reporting.ReportingListener">
61
</property>
62

    
63

    
64
<property name="SDF Director" class="ptolemy.domains.sdf.kernel.SDFDirector">
65
    <property name="iterations" class="ptolemy.data.expr.Parameter" value="1">
66
    </property>
67
    <property name="vectorizationFactor" class="ptolemy.data.expr.Parameter" value="1">
68
    </property>
69
    <property name="allowDisconnectedGraphs" class="ptolemy.data.expr.Parameter" value="false">
70
    </property>
71
    <property name="allowRateChanges" class="ptolemy.data.expr.Parameter" value="false">
72
    </property>
73
    <property name="constrainBufferSizes" class="ptolemy.data.expr.Parameter" value="true">
74
    </property>
75
    <property name="period" class="ptolemy.data.expr.Parameter" value="0.0">
76
    </property>
77
    <property name="synchronizeToRealTime" class="ptolemy.data.expr.Parameter" value="false">
78
    </property>
79
    <property name="timeResolution" class="ptolemy.actor.parameters.SharedParameter" value="1E-10">
80
    </property>
81
    <property name="Scheduler" class="ptolemy.domains.sdf.kernel.SDFScheduler">
82
        <property name="constrainBufferSizes" class="ptolemy.data.expr.Parameter" value="constrainBufferSizes">
83
        </property>
84
    </property>
85
<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">
86
<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>
87
<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Steve Neuendorffer</configure></property>
88
<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>
89
<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>
90
<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>
91
<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>
92
<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>
93
<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>
94
<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>
95
<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>
96
<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>
97
<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>
98
</property>    <property name="entityId" class="org.kepler.moml.NamedObjId" value="urn:lsid:kepler-project.org/ns/:882:5:1">
99
    </property>
100
    <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.domains.sdf.kernel.SDFDirector">
101
        <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:directorclass:1:2">
102
        </property>
103
    </property>
104
    <property name="semanticType00" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:1:1#Director">
105
    </property>
106
    <property name="semanticType11" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:2:1#Director">
107
    </property>
108
    <property name="_location" class="ptolemy.kernel.util.Location" value="{255, 70}">
109
    </property>
110
    <property name="derivedFrom" class="org.kepler.moml.NamedObjIdReferralList" value="urn:lsid:kepler-project.org:director:1:2">
111
    </property>
112
</property>
113

    
114

    
115
<property name="semanticType" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:2:1#LocalOutput">
116
</property>
117

    
118
<relation name="relation" class="ptolemy.actor.TypedIORelation">
119
</relation>
120

    
121
<entity name="String Constant" class="ptolemy.actor.lib.StringConst">
122
    <property name="firingCountLimit" class="ptolemy.data.expr.Parameter" value="NONE">
123
    </property>
124
    <property name="NONE" class="ptolemy.data.expr.Parameter" value="0">
125
    </property>
126
    <property name="value" class="ptolemy.data.expr.Parameter" value="Hello world!">
127
    </property>
128
<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">
129
<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>
130
<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Edward Lee</configure></property>
131
<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>
132
<property name="userLevelDocumentation" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>&lt;p&gt;The StringConstant actor outputs a string specified via the actor's value parameter.&lt;/p&gt;&#10;&#10;&lt;p&gt;Specifying strings with the StringConstant actor is convenient, as the actor does not require that strings be surrounded by quotes. The actor is often used to specify file paths, which can be selected using the Browse button available in the actor's parameters.&lt;/p&gt;&#10;&#10;&lt;p&gt;Specified string values can include references to parameters within scope (i.e., parameters defined at the same level of the hierarchy or higher). &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;&#10;</configure></property>
133
<property name="port:output" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>An output port that broadcasts a string constant specified by the value parameter.  </configure></property>
134
<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>
135
<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>
136
<property name="prop:value" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The value produced by the actor. Specified strings do not require enclosing quotes. (To include a '$' sign in the string, enter '$$'.)</configure></property>
137
</property>    <property name="entityId" class="org.kepler.moml.NamedObjId" value="urn:lsid:kepler-project.org/ns/:882:6:1">
138
    </property>
139
    <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.actor.lib.StringConst">
140
        <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:class:1052:1">
141
        </property>
142
    </property>
143
    <property name="semanticType00" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:1:1#StringFunctionActor">
144
    </property>
145
    <property name="semanticType11" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:2:1#Constant">
146
    </property>
147
    <property name="_icon" class="ptolemy.vergil.icon.BoxedValueIcon">
148
        <property name="attributeName" class="ptolemy.kernel.util.StringAttribute" value="value">
149
        </property>
150
        <property name="displayWidth" class="ptolemy.data.expr.Parameter" value="60">
151
        </property>
152
    </property>
153
    <property name="_location" class="ptolemy.kernel.util.Location" value="{200.0, 180.0}">
154
    </property>
155
    <property name="derivedFrom" class="org.kepler.moml.NamedObjIdReferralList" value="urn:lsid:kepler-project.org:actor:204:1">
156
    </property>
157
</entity>
158
<entity name="Display" class="ptolemy.actor.lib.gui.Display">
159
    <property name="_windowProperties" class="ptolemy.actor.gui.WindowPropertiesAttribute" value="{bounds={478, 357, 484, 186}, maximized=false}">
160
    </property>
161
    <property name="_paneSize" class="ptolemy.actor.gui.SizeAttribute" value="[484, 164]">
162
    </property>
163
    <property name="rowsDisplayed" class="ptolemy.data.expr.Parameter" value="10">
164
    </property>
165
    <property name="columnsDisplayed" class="ptolemy.data.expr.Parameter" value="40">
166
    </property>
167
    <property name="suppressBlankLines" class="ptolemy.data.expr.Parameter" value="false">
168
    </property>
169
    <property name="title" class="ptolemy.data.expr.StringParameter" value="">
170
    </property>
171
<property name="KeplerDocumentation" class="ptolemy.vergil.basic.KeplerDocumentationAttribute">
172
<property name="description" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>
173
<property name="author" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Yuhong Xiong, Edward A. Lee</configure></property>
174
<property name="version" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>null</configure></property>
175
<property name="userLevelDocumentation" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>&lt;p&gt;The Display actor reads tokens of any type via its input multiport, and displays each token on a separate line in a text display window.&lt;/p&gt;&#10;&#10;&lt;p&gt;Specify the size of the text display window with the rowsDisplayed and columnsDisplayed parameters. Simply resizing the window onscreen does not persistently change the size when the workflow is saved, closed, and then re-opened. &lt;/p&gt;&#10;&#10;&lt;p&gt;If the input is a string token, then the actor strips the surrounding quotation marks before displaying the value.&lt;/p&gt; &#10;&#10;&lt;p&gt;Select the suppressBlankLines parameter to specify that the actor not add blank lines to the display. By default, the actor will add blank lines.&lt;/p&gt;&#10;&#10;&lt;p&gt;Note: this actor can consume large amounts of memory. It is not advisable to use it to display large output streams.&lt;/p&gt;</configure></property>
176
<property name="port:input" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>A multiport that accepts tokens of any type.</configure></property>
177
<property name="prop:suppressBlankLines" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>Specify whether the actor should display blank lines (the default) or suppress them.</configure></property>
178
<property name="prop:rowsDisplayed" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The vertical size of the display, in rows. The value is an integer that defaults to 10.</configure></property>
179
<property name="prop:columnsDisplayed" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The horizontal size of the display, in columns. The value is an integer that defaults to 40.</configure></property>
180
<property name="prop:title" class="ptolemy.kernel.util.ConfigurableAttribute"><configure>The title of the text display window. If specified, the value will appear in the title bar of the text display window.</configure></property>
181
</property>    <property name="entityId" class="org.kepler.moml.NamedObjId" value="urn:lsid:kepler-project.org:actor:7:1">
182
    </property>
183
    <property name="class" class="ptolemy.kernel.util.StringAttribute" value="ptolemy.actor.lib.gui.Display">
184
        <property name="id" class="ptolemy.kernel.util.StringAttribute" value="urn:lsid:kepler-project.org:class:883:1">
185
        </property>
186
    </property>
187
    <property name="semanticType00" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:1:1#TextualOutputActor">
188
    </property>
189
    <property name="semanticType11" class="org.kepler.sms.SemanticType" value="urn:lsid:localhost:onto:2:1#TextualOutput">
190
    </property>
191
    <property name="_location" class="ptolemy.kernel.util.Location" value="{350, 305}">
192
    </property>
193
</entity>
194
    <link port="String Constant.output" relation="relation"/>
195
    <link port="Display.input" relation="relation"/>
196
</entity>
197

    
198
                </karEntryXML>
199
        </karEntry>
200
        <karEntry>
201
                <karEntryAttributes>
202
                        <Name>
203
                                hello-report_ROML.xml
204
                        </Name>
205
                        <dependsOn>
206
                                urn:lsid:kepler-project.org/ns/:882:3:20
207
                        </dependsOn>
208
                        <type>
209
                                org.kepler.reporting.roml.ReportLayout
210
                        </type>
211
                        <handler>
212
                                org.kepler.kar.handlers.ReportLayoutKAREntryHandler
213
                        </handler>
214
                        <lsid>
215
                                urn:lsid:kepler-project.org/ns/:882:4:1
216
                        </lsid>
217
                        <dependsOnModule>
218
                                reporting
219
                        </dependsOnModule>
220
                </karEntryAttributes>
221
                <karEntryXML>
222
<report><title>Summary report</title><headerGraphic/><lsid>urn:lsid:kepler-project.org/ns/:882:4:1</lsid><workflow>urn:lsid:kepler-project.org/ns/:882:3:20</workflow><item name=".Unnamed1.Display.input" type="" class="org.kepler.reporting.rio.DynamicReportItem"><properties><property name="ALIGNMENT"/><property name="SCALE"/></properties><label position="north"/><label position="south"/><label position="west"/><label position="east"/></item></report>
223

    
224
                </karEntryXML>
225
        </karEntry>
226
</kar:kar>