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 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.

Excerpt Include
ARSP:ER Diagram: AnalysisOutputProgrammingCodeARSP:
ER Diagram: AnalysisOutputProgrammingCode

...

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, see the AnalysisProgrammingCodeTemplate section.

The provision of programming code, the implementation of any template programming code and the use of programming code parameters should be consistent within any given reporting event.

Example

Include Page
ARSP:programmingCode: SimpleARSP:
programmingCode: Simple

Example

Include Page
ARSP:programmingCode: ParameterizedARSP:
programmingCode: Parameterized

...