Analysis Framework Developer's Guide
Analysis Description
The Analysis Description file provides detailed information about the various sections of an Analysis.
<analysis-description>
Attributes
NAME |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|
id |
(required) |
This id MUST match the id given to the Analysis in the |
Elements
NAME |
REQUIRED |
CARDINALITY |
DESCRIPTION |
---|---|---|---|
<analysis-type> |
(required) |
1 |
|
<custom-script> |
(optional) |
0-1 |
|
<groups> |
(required) |
1 |
|
<parameter> |
(optional) |
0-many |
|
<output> |
(optional) |
0-many |
Text
This element has no text.
<analysis-type>
Attributes
NAME |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|
type |
(required) |
Defines how this analysis is to be executed, currently supports |
Elements
NAME |
REQUIRED |
CARDINALITY |
DESCRIPTION |
---|---|---|---|
<property> |
(optional) |
0-many |
a |
Text
This element has no text.
Example
<analysis-type type="simpleIteration"> <property name="iteratingDatasetKey" value="bridgeDamage" /> </analysis-type>
<custom-script>
Attributes
This element has no attributes.
Elements
This element has no children.
Text
Defines a location for a custom OgreScript to use instead of auto-generating one. The format for this script will be defined on a separate page. This location is relative to the bundle in which the analysis is shipped.
Example
<custom-script>scripts/ogrescript-bridgeFunc.xml</custom-script>
- The description MUST have a list of groups to which the parameters can be associated.
<analysis-description id="ncsa.analysis.maeviz.BridgeFunctionality"> <groups> <group-name>Required</group-name> </groups> </analysis-description>
- The description MAY (although not having any
<parameters>
doesn't make much sense) have a list of parameters.
Attributes
NAME |
TYPE |
DEFAULT VALUE |
DESCRIPTION |
---|---|---|---|
group |
|
(required) |
a string which must match a member of |
format |
|
(required) |
the type of the parameter, currently supports |
cardinality |
|
(required) |
how many of this type, currently supports |
key |
|
(required) |
name of property for which value should be added |
friendly-name |
|
(required) |
name of property for which value should be added |