Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Code Block

<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 Each description MAY define 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

Code Block

<analysis-description id="ncsa.analysis.maeviz.BridgeFunctionality">
     <custom-script>scripts/ogrescript-bridgeFunc.xml</custom-script>
</analysis-description>
  • The description MUST have a list of groups to which the parameters can be associated.

...

  • 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

java.lang.Object

(required)

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

format

java.lang.String

(required)

the type of the parameter, currently supports string or dataset

cardinality

java.lang.String

(required)

how many of this type, currently supports single or multiple

key

java.lang.String

(required)

name of property for which value should be added

friendly-name

java.lang.String

(required)

name of property for which value should be added