classTraceabilityInfo

Information

The aim of traceability is that anyone working with the model knows at any time why a parameter has a specific value. This is defined in the library with the three keys:

• source: origin of the parameter value (e.g. Estimated), see below.
• info (optional): a short textual explanation how the value was determined.
• reference (optional): identifies the resource where the determination of the value is described, for example web-address, DOI, ISBN, internal report ID of a document, data-sheet etc. The referenced resource must be stored in a way that avoids accidental manipulation, e.g., in a version control system with a given hash, in order to retain the reference information reliably.

Source

It is the way, how the value of the parameter was determined, and is realized as an enumeration SourceType that can take one of the following values.

• Unknown: the source of the value is not known. Such parameters have to be handled with care and are not sufficient for the demand of a good traceability
• Estimated: value from an educated guess, previous projects, extrapolated value, etc.
• Provided: value from a data sheet, supplier specification, etc. The reference (see above) to this source shall be also provided.
• Computed: value from computer aided data such as CAD, CFD, FEM, etc. The reference (see above) to this source shall be also provided.
• Measured: measured value from physical measurements. The reference (see above) to this source shall be also provided.
• Calibrated: value from a model calibration (based on provided data). The setup of the calibration – this means all information needed to repeat exactly this calibration – and the allowed parameter range should be stored in the calibration section of the parameter record, see calibration information.