Versions Compared

Key

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

...

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. No spaces allowed.

friendly-name

{required)

name of property for which value should be added

...

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;

Requirements

For each <parameter> there must be a corresponding set method which corresponds to the key attribute in the <parameter>.

Example:

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.

Example:

Code Block

resultMap.put( COL_LS_SLIGHT, dmg[0] );
resultMap.put( COL_LS_MODERATE, dmg[1] );

As a best practice, add public final static constants for each column in the Feature.