Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added reference to label attribute for parameters (GitHub #217)

...

The AnalysisOutputProgrammingCode class may be used to specify programming code statements and/or parameter values for either analyses or outputs. It is used in the programmingCode attribute of either:

  • The Analysis class, to indicate the programming code statements and/or parameter values used to perform a specific analysis, or
  • The Output class, to indicate the programming code and, optionally, parameter values used to produce the results included in a specific output.

...

The programming statements used to produce the results for analyses or outputs may be provided in 1 of 3 ways:

  1. By by storing the statements directly in the code attribute of the AnalysisOutputProgrammingCode class,; 
  2. By by referencing a programming code document in the documentRef attribute of the AnalysisOutputProgrammingCode class (refer to see the DocumentReference section for more information about programming code document references), ; or
  3. For for analyses only, by implied reference to template programming code associated with the analysis method specified in the the methodId attribute of the Analysis class (refer to see the AnalysisProgrammingCodeTemplate section for more information about template programming code).

...

The parameters attribute of the AnalysisOutputProgrammingCode class may be used to specify one or more output- or analysis-specific programming code parameter value. Each parameter value is specified as an instance of the AnalysisOutputCodeParameter class, which includes the name, description, label, and value attributes to specify, respectively, the name, description, label, and (single) value of the parameter. The value attribute contains the parameter value used during either execution of parameterized, analysis- or output-specific programming code, or (for analyses whose method has associated parameterized template programming code) generation of analysis-specific programming code. For more information about the use of parameters with template programming code, including examples, refer to the see the AnalysisProgrammingCodeTemplate section.

...