• Created by Unknown User (shawn), last modified on Sep 05, 2007

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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 ncsa.analysis.newAnalyses extension point.

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 simpleIteration

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<property>

(optional)

0-many

a ncsa.tools.common.Property object. Additional properties required by the type of iterator.

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>

<groups>

Groups are used to associate like <parameter> elements together. There are two <group-name> elements which have special meaning to the framework.

  • Required
  • Advanced - Any <parameters> elements which are associated with the Advanced group will not be shown by default.

Attributes

This element has no attributes.

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<group-name>

(required)

1-many

Group to which the parameters can be associated.

Text

This element has no text.

Example

<groups>
    <group-name>Required</group-name>
</groups>

<parameter>

Attributes

NAME

DEFAULT VALUE

DESCRIPTION

group

(required)

a string which must match a member of <groups> above

format

(required)

the type of the parameter, currently supports string or dataset

cardinality

(required)

how many of this type, currently supports single or multiple

key

(required)

name of property for which value should be added

friendly-name

{required)

name of property for which value should be added

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<types>

(optional)

0-many

A list of types that are accepted by this <parameter>.

Text

This element has no text.

Example

<parameter group="Required" format="dataset" cardinality="single" key="functionalityTable" friendly-name="Functionality Table">
    <types>
        <type>bridgeFunctionality</type>
    </types>
</parameter>

<output>

An <output> of type dataset requires two <property> elements.

  • base-dataset-key - The key of the <parameter> which is the base for this new Dataset
  • schema - The id of the schema that this Dataset implements.

Attributes

NAME

DEFAULT VALUE

DESCRIPTION

format

(required)

the type of the parameter, currently supports string or dataset

key

(required)

name of property for which value should be added

friendly-name

{required)

name of property for which value should be added

Elements

NAME

REQUIRED

CARDINALITY

DESCRIPTION

<property>

(optional)

0-many

a ncsa.tools.common.Property object. Additional properties required by the <output>.

Text

This element has no text.

Example

<output friendly-name="Bridge Functionality" key="bridgeFunctionality" format="dataset">
    <property name="base-dataset-key" value="bridgeDamage" /> 
    <property name="schema" value="ncsa.maeviz.schemas.bridgeFunctionalityResults.v1.0" />
</output>
  • No labels