Skip to content

Latest commit

 

History

History
46 lines (37 loc) · 3.63 KB

5___SRMD.adoc

File metadata and controls

46 lines (37 loc) · 3.63 KB

Simulation Resource Meta Data File Format

Simulation resource meta data for components or other resources (e.g. parameter sets, etc.) can be provided using SRMD files. These files can be embedded into such resources, where possible, they can be placed outside the resources and reference the resources to which they apply, or they can be tied to the resources through the STMD meta-data mechanisms.

SimulationRessourceMetaData

The SimulationResourceMetaData element is the all enclosing top level XML element of SRMD files.

SimulationResourceMetaDataSchema
Figure 1. SimulationResourceMetaData element structure and attributes

The SimulationTaskMetaData element is structured by following subordinated element.

Table 1. SimulationResourcekMetaData element structure
Sub element name Optional / Mandatory

GElementCommon

The SimulationResourceMetaData element is associated with the following attributes.

Table 2. SimulationResourceMetaData element attributes
Attribute name Optional / Mandatory Atrribute description

version

Mandatory

Version of SRMD format, 0.x for this pre-release.

name

Mandatory

This attribute gives the simulation resource meta data a name, which can be used for purposes of presenting the simulation resource meta data to the user.

data

Optional

This optional attribute gives a URI to the data item this resource meta data applies to. If this attribute is not present, then the data this resource meta data applies to is provided outside of the meta data (e.g. by embedding SRMD into the data format, or providing it as meta data in an STMD file).

checksum

Optional

This attribute gives the checksum over the data item this meta data applies to. This is optional information to allow the identificatio of the data item and the precise algorithm specifying. The checksum is calculated using the algorithm indicated by the checksumType attribute.

checksumtype

Optional

This attribute gives the algorithm for the calculation of the checksum attribute. MUST be SHA3-256 for now, indicating a SHA3 256bit secure hash algorithm, as specified in FIPS 202. In the future other checksum algorithms might be supported.

id

Optional

This attribute gives the model element a file-wide unique id which can be referenced from other elements or via URI fragment identifier.

description

Optional

This attribute gives a human readable longer description of the model element, which can be shown to the user where appropriate.

author

Optional

This attribute gives the name of the author of this file’s content.

fileversion

Optional

This attribute gives a version number for this file’s content.

copyright

Optional

This attribute gives copyright information for this file’s content.

license

Optional

This attribute gives license information for this file’s content.

generatingTool

Optional

This attribute gives the name of the tool that generated this file.

generationDateAndTime

Optional

This attribute gives the date and time this file was generated.

GElementCommon

For the details of the GElementCommon element structure and attributes see chapter [sec-gelementcommon]