Versions Compared

Key

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

...

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

Code Block
     <custom-script>scripts/ogrescript-bridgeFunc.xml</custom-script>

...

NAME

DEFAULT VALUE

DESCRIPTION

group

(required)

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

format

*

the format of whatever phylum of parameter this is.  For datasets, indicates what type of dataset (mapping, shapefile,etc)

phylum

(required)

the type of the parameter, currently supports string, dataset, or datasetboolean

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

optional

false

A value of true denotes that this parameter need not have a value

...

Code Block
<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>	

Task class

Each Analysis MUST implement a class which extends ncsa.analysis.maeviz.ogrescript.tasks.core.SimpleFeatureTask. In the future a choice of base class based on the specific implementation required will be available.

There are two required abstract methods.

Code Block
    protected abstract void preProcess() throws ScriptExecutionException;
    protected abstract void handleFeature( IProgressMonitor monitor ) throws ScriptExecutionException;

...

Code Block
<parameter group="Required" format="dataset" cardinality="single" key="functionalityTable" friendly-name="Functionality Table" />

public void setFunctionalityTable( Dataset d );

The handleFeature method is responsible for two things. First is computing the values that are to be added to the new Feature. Second is to populate the resultMap.

...