Versions Compared

Key

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

...

The AnalysisOutputProgrammingCode class is use may be used to specify programming code used 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.

...

ARS AnalysisOutputProgrammingCode

Attributes

Corresponding ARM for Define-XML

arm:ProgrammingCode Attributes/Elements

contextContext attribute
codearm:Code element
documentRefdef:DocumentRef element

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

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

When programming statements are provided directly or via a document reference (option 1 or 2), the In each instance of the AnalysisOutputProgrammingCode class, the context attribute is used to specify the name and version of the computer language used for the programming statements and the programming statements themselves are provided either directly in the code attribute or via a programming code document reference provided in the documentRef attribute. Refer to the DocumentReference section for more information about programming code document references.


If the analysis method for an analysis has associated template programming code (i.e., template programming code is specified in the codeTemplate attribute of the instance of the AnalysisMethod class referenced in the methodId attribute of the analysis), sponsors may choose to implement the template programming code in different ways. The template programming code may be used to generate executable, analysis-specific programming code statements which are then stored as part of the definition of the analysis (using the code or documentRef attribute of the AnalysisOutputProgrammingCode class; option 1 or 2 above). Alternatively, if the template programming code is already executable or generation of executable programming statements is implemented at runtime, the template programming code may be implemented by reference only (option 3). If template programming code is implemented by reference only, neither of the code or documentRef attributes of the AnalysisOutputProgrammingCode class is used: the programmingCode attribute of the analysis is either not used, or it is used only to specify analysis-specific parameter values in the parameters attribute of the AnalysisOutputProgrammingCode class.



Pagenav