no.ntnu.ihb.sspgen.ssp.SystemStructureCommon.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dsl Show documentation
Show all versions of dsl Show documentation
A Kotlin DSL for generating SSP archives
This is the normative XML Schema 1.0 schema for the MAP SSP
SystemStructure 1.0 common content across formats.
Version: 1.0
Copyright 2016 -- 2019 Modelica Association Project "SSP"
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:
1. Redistributions of source code must retain the above
copyright notice, this list of conditions and the
following disclaimer.
2. Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other
materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
This attribute group specifies the attributes common to all model elements.
This attribute gives the model element a file-wide unique id which can
be referenced from other elements or via URI fragment identifier.
This attribute gives a human readable longer description of the
model element, which can be shown to the user where appropriate.
This attribute group specifies the optional meta-data attributes common to
all top-level container elements of all defined file formats.
This attribute gives the name of the author of this file's content.
This attribute gives a version number for this file's content.
This attribute gives copyright information for this file's content.
This attribute gives license information for this file's content.
This attribute gives the name of the tool that generated this file.
This attribute gives the date and time this file was generated.
Name of the Enumeration Item
The Value of the Enumeration Item
This attribute specifies the name of the enumeration in the system description,
which must be unique within in the system description.
Exponent of SI base unit "kg"
Exponent of SI base unit "m"
Exponent of SI base unit "s"
Exponent of SI base unit "A"
Exponent of SI base unit "K"
Exponent of SI base unit "mol"
Exponent of SI base unit "cd"
Exponent of SI derived unit "rad"
This attribute specifies the name of the unit in the system description,
which must be unique within in the system description.
The unique name of the type of the annotation.
In order to ensure uniqueness all types should be identified
with reverse domain name notation (cf. Java package names
or Apple UTIs) of a domain that is controlled by the entity
defining the semantics and content of the annotation.
For vendor-specific annotations this would e.g. be a domain
controlled by the tool vendor.
For MAP-SSP defined annotations, this will be a domain under
the org.modelica prefix.
This element gives the type of a connector or signal dictionary entry
(called entity below).
This attribute gives the unit of the entity and must
reference one of the unit definitions provided in the Units
element of the containing file.
If a unit is not supplied, the unit is determined through
default mechanisms: For FMU components, the unit of the
underlying variable would be used, for systems the units
of connected underlying connectors could be used if unambiguous.
If a unit cannot be deduced unambinguously, the user should
be informed of this error.
This attribute specifies the name of the enumeration
which references into the set of defined enumerations
of the system structure description, as contained in
the Enumerations element of the root element.
This optional attribute specifies the MIME type of the
underlying binary data, which defaults to the non-specific
application/octet-stream type. This information can be
used by the implementation to detect mismatches between
connected binary connectors, or provide automatic means of
conversion between different formats. It should be noted
that the implementation is not required to provide this
service, i.e. it remains the responsibility of the operator
to ensure only compatible binary connectors are connected.
This element specifies the transformation to be applied to a value prior to its
use in a connection or parameter mapping.
This element provides for a linear transformation to be performed on the
parameter values and is valid for parameters of a continuous type.
This attribute specifies an optional factor value to use in a linear
transformation of the source parameter value to the target parameter
value, i.e. in the calculation target = factor * source + offset.
Note that conversions based on different units are performed, unless
prevented by suppressUnitConversion, prior to the application of the
linear transformation, i.e. the value of source is already converted
to the target unit in the formula above.
This attribute specifies an optional offset value to use in a linear
transformation of the source parameter value to the target parameter
value, i.e. in the calculation target = factor * source + offset.
Note that conversions based on different units are performed, unless
prevented by suppressUnitConversion, prior to the application of the
linear transformation, i.e. the value of source is already converted
to the target unit in the formula above.
This element provides for a transformation of boolean parameter values
based on a mapping table and is valid for parameters of boolean type.
Each mapping table entry is provided by a MapEntry element.
This attribute gives the value of the parameter in the
parameter source that this entry applies to.
This attribute gives the value of the parameter to use
when applying it to the system or component that is to be
parametrized.
This element provides for a transformation of integer parameter values
based on a mapping table and is valid for parameters of integer and
enumeration type. Each mapping table entry is provided by a MapEntry
element.
This attribute gives the value of the parameter in the
parameter source that this entry applies to.
This attribute gives the value of the parameter to use
when applying it to the system or component that is to be
parametrized.
This element provides for a transformation of enumeration parameter values
based on a mapping table of their enumeration item names and is valid for
parameters of enumeration type. Each mapping table entry is provided by a
MapEntry element.
This attribute gives the value of the parameter in the
parameter source that this entry applies to.
This attribute gives the value of the parameter to use
when applying it to the system or component that is to be
parametrized.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy