Release preparation: javadoc, list of validations, help
diff --git a/plugins/org.eclipse.app4mc.amalthea.model.help/docu/model_basics.textile b/plugins/org.eclipse.app4mc.amalthea.model.help/docu/model_basics.textile
index 5a7f8a7..3fe2ae3 100644
--- a/plugins/org.eclipse.app4mc.amalthea.model.help/docu/model_basics.textile
+++ b/plugins/org.eclipse.app4mc.amalthea.model.help/docu/model_basics.textile
@@ -120,7 +120,7 @@
h4. Weibull Distribution
-The Weibull distribution is a statistical distribution whose shape is mathematically defined by kappa > 0 and the scale of the distribution by lambda > 0. In the model, it is parameterized using the mean value, the lower and upper bound, and the probability that a real-valued random variable of that distribution will not take a value less than or equal to a specific value. To calculate the scale and shape parameter for the Weibull distribution from the model parameters, the equation of the mean (see "Weibull distribution - Wikipedia":https://en.wikipedia.org/wiki/Weibull_distribution) is solved for the scale parameter, first. Then, the resulting equation for lambda is plugged into the equation of the cumulative distribution function (CDF) for the Weibull distribution. Finally, the lower and upper bound allow to shift this function and the remaining unknown shape parameter in the equation is numerically approximated until the value of the parameter that constraints the distribution regarding the per mill of remaining values is reached.
+The Weibull distribution is a statistical distribution whose shape is mathematically defined by kappa > 0 and the scale of the distribution by lambda > 0. In the model, it is parameterized using the mean value, the lower and upper bound, and the probability that a real-valued random variable of that distribution will not take a value less than or equal to a specific value. To calculate the scale and shape parameter for the Weibull distribution from the model parameters, the equation of the mean ( see "Weibull distribution - Wikipedia":https://en.wikipedia.org/wiki/Weibull_distribution ) is solved for the scale parameter, first. Then, the resulting equation for lambda is plugged into the equation of the cumulative distribution function (CDF) for the Weibull distribution. Finally, the lower and upper bound allow to shift this function and the remaining unknown shape parameter in the equation is numerically approximated until the value of the parameter that constraints the distribution regarding the per mill of remaining values is reached.
!../pictures/model_common_deviation_weibull.png!
diff --git a/plugins/org.eclipse.app4mc.amalthea.model/build-javadoc.ant b/plugins/org.eclipse.app4mc.amalthea.model/build-javadoc.ant
index facebf2..3163add 100644
--- a/plugins/org.eclipse.app4mc.amalthea.model/build-javadoc.ant
+++ b/plugins/org.eclipse.app4mc.amalthea.model/build-javadoc.ant
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!--
* *******************************************************************************
- * Copyright (c) 2020 Robert Bosch GmbH and others.
+ * Copyright (c) 2020-2022 Robert Bosch GmbH and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
@@ -28,7 +28,7 @@
notree="true"
packagenames="org.eclipse.app4mc.amalthea.model.io"
source="1.8"
- sourcefiles="src/org/eclipse/app4mc/amalthea/model/AmaltheaIndex.java,src/org/eclipse/app4mc/amalthea/model/builder/ConstraintsBuilder.java,src/org/eclipse/app4mc/amalthea/model/util/SoftwareUtil.java,src/org/eclipse/app4mc/amalthea/model/util/RuntimeUtil.java,src/org/eclipse/app4mc/amalthea/model/builder/CommonElementsBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/AmaltheaBuilder.java,src/org/eclipse/app4mc/amalthea/model/util/DeploymentUtil.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaMerger.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaServices.java,src/org/eclipse/app4mc/amalthea/model/builder/MappingBuilder.java,src/org/eclipse/app4mc/amalthea/model/util/HardwareUtil.java,src/org/eclipse/app4mc/amalthea/model/util/TimeUtil.java,src/org/eclipse/app4mc/amalthea/model/util/WeibullUtil.java,src/org/eclipse/app4mc/amalthea/model/util/ConstraintsUtil.java,src/org/eclipse/app4mc/amalthea/model/util/ModelUtil.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaCrossReferenceAdapter.java,src/org/eclipse/app4mc/amalthea/model/util/InstructionsUtil.java,src/org/eclipse/app4mc/amalthea/model/util/FactoryUtil.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaExtensions.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaServices2.java,src/org/eclipse/app4mc/amalthea/model/builder/HardwareBuilder.java,src/org/eclipse/app4mc/amalthea/model/util/CustomPropertyUtil.java,src/org/eclipse/app4mc/amalthea/model/builder/DatatypeBuilder.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaValidations.java,src/org/eclipse/app4mc/amalthea/model/builder/OperatingSystemBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/SoftwareBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/InstructionsBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/StimuliBuilder.java"
+ sourcefiles="src/org/eclipse/app4mc/amalthea/model/AmaltheaCrossReferenceAdapter.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaExtensions.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaIndex.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaMerger.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaServices.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaServices2.java,src/org/eclipse/app4mc/amalthea/model/AmaltheaValidations.java,src/org/eclipse/app4mc/amalthea/model/builder/AmaltheaBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/CommonElementsBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/ConstraintsBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/DatatypeBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/HardwareBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/InstructionsBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/MappingBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/OperatingSystemBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/SoftwareBuilder.java,src/org/eclipse/app4mc/amalthea/model/builder/StimuliBuilder.java,src/org/eclipse/app4mc/amalthea/model/check/ModelStructureCheck.java,src/org/eclipse/app4mc/amalthea/model/io/AmaltheaFileHelper.java,src/org/eclipse/app4mc/amalthea/model/io/AmaltheaLoader.java,src/org/eclipse/app4mc/amalthea/model/io/AmaltheaWriter.java,src/org/eclipse/app4mc/amalthea/model/util/ConstraintsUtil.java,src/org/eclipse/app4mc/amalthea/model/util/CustomPropertyUtil.java,src/org/eclipse/app4mc/amalthea/model/util/DeploymentUtil.java,src/org/eclipse/app4mc/amalthea/model/util/FactoryUtil.java,src/org/eclipse/app4mc/amalthea/model/util/HardwareUtil.java,src/org/eclipse/app4mc/amalthea/model/util/InstructionsUtil.java,src/org/eclipse/app4mc/amalthea/model/util/ModelUtil.java,src/org/eclipse/app4mc/amalthea/model/util/RuntimeUtil.java,src/org/eclipse/app4mc/amalthea/model/util/SoftwareUtil.java,src/org/eclipse/app4mc/amalthea/model/util/TimeUtil.java,src/org/eclipse/app4mc/amalthea/model/util/WeibullUtil.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EMPeriodic.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EMPeriodicBurst.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EMPeriodicRelative.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EMPeriodicSynthetic.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EMSingle.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EMVariableRate.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/EventModelFactory.java,src/org/eclipse/app4mc/amalthea/model/util/stimuli/IEventModel.java"
sourcepath="xcore-gen;xtend-gen;src"
splitindex="false"
use="false"
diff --git a/plugins/org.eclipse.app4mc.validation.help/docu/user_validation.textile b/plugins/org.eclipse.app4mc.validation.help/docu/user_validation.textile
index a71c20d..3bbfa28 100644
--- a/plugins/org.eclipse.app4mc.validation.help/docu/user_validation.textile
+++ b/plugins/org.eclipse.app4mc.validation.help/docu/user_validation.textile
@@ -26,7 +26,6 @@
** @org.eclipse.app4mc.amalthea.validations.standard.BasicProfile@
** @org.eclipse.app4mc.amalthea.validations.standard.ConstraintsProfile@
** @org.eclipse.app4mc.amalthea.validations.standard.EMFProfile@
-** @org.eclipse.app4mc.amalthea.validations.standard.EMFScopeProfile@
** @org.eclipse.app4mc.amalthea.validations.standard.HardwareProfile@
** @org.eclipse.app4mc.amalthea.validations.standard.MappingProfile@
** @org.eclipse.app4mc.amalthea.validations.standard.OSProfile@
@@ -51,50 +50,43 @@
* Validations:
** AM-Constraints-EventChain (ERROR - AbstractEventChain)
*** Stimulus and response shall not reference the same event
-*** The stimulus of the first segment has to be the same as the stimulus of the event chain
-*** The stimulus of other segments have to be equal to the response of the previous segment
*** The response of the last segment has to be the same as the response of the event chain
+*** The stimulus of other segments have to be equal to the response of the previous segment
+*** The stimulus of the first segment has to be the same as the stimulus of the event chain
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.standard.EMFProfile@<br/>
**Amalthea EMF Validations**
__Standard EMF validations for AMALTHEA models (generated).__
* Validations:
** AM-EMF-INTRINSIC (UNDEFINED - EObject)
-*** EMF extended metadata constraints (generated)
*** AMALTHEA invariants (generated)
-p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.standard.EMFScopeProfile@<br/>
-**Amalthea Scope Validations**
-__Validations to ensure unique names in folder scope.__
-* Validations:
-** AM-EMF-SCOPE (ERROR - Amalthea)
-*** ID has to be unique in folder scope
-*** ID has to be set for objects of type IReferable
+*** EMF extended metadata constraints (generated)
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.standard.HardwareProfile@<br/>
**Hardware Validations**
* Validations:
** AM-HW-AccessPath (ERROR - HwAccessPath)
-*** HwAccessPath ranges and memory size must be consistent
*** HwAccessPath elements must be consistent
+*** HwAccessPath ranges and memory size must be consistent
** AM-HW-Connection (ERROR - HwConnection)
-*** HwConnections must refer to two HwPorts
*** HwConnections must be linked to HwPorts of the same Interface
+*** HwConnections must refer to two HwPorts
** AM-HW-Definition (ERROR - HwDefinition)
*** Only one feature of a category can be referred
** AM-HW-Port (ERROR - HwPort)
*** A HwPort can only have one (non internal) HwConnection
** AM-HW-Structure (ERROR - HwStructure)
*** Connections must only refer to contained HwPorts
-*** Inner connections always need one Initiator and one Responder HwPort
*** Delegated connections always connect HwPorts of the same type
+*** Inner connections always need one Initiator and one Responder HwPort
** AM-HW-Module-Definition (WARNING - HwModule)
+*** Cache definition must be set
+*** ConnectionHandler definition must be set
*** Memory definition must be set
*** ProcessingUnit definition must be set
-*** ConnectionHandler definition must be set
-*** Cache definition must be set
** AM-HW-Port-BitWidth (WARNING - HwPort)
*** Bitwidth should be greater than zero
** AM-HW-Port-Definition (WARNING - HwPort)
-*** PortType must be set
*** PortInterface must be set
+*** PortType must be set
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.standard.MappingProfile@<br/>
**Mapping Validations**
* Validations:
@@ -152,22 +144,28 @@
** Sim-Basic-Identifiers (ERROR - IReferable)
*** All names of IReferable objects must be valid C++ identifier names
** TA-Basic-ContinuousValueGaussDistribution-mean (ERROR - ContinuousValueGaussDistribution)
-*** Mean must not be less than the lower bound
*** Mean must not be greater than the upper bound
+*** Mean must not be less than the lower bound
** TA-Basic-DiscreteValueGaussDistribution-mean (ERROR - DiscreteValueGaussDistribution)
-*** Mean must not be less than the lower bound
*** Mean must not be greater than the upper bound
+*** Mean must not be less than the lower bound
** TA-Basic-TimeGaussDistribution-mean (ERROR - TimeGaussDistribution)
-*** Mean must not be less than the lower bound
*** Mean must not be greater than the upper bound
+*** Mean must not be less than the lower bound
+** Sim-supported-model-elements (WARNING - EObject)
+*** Checks that the model elements are supported in APP4MCsim
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.sim.SimHardwareProfile@<br/>
**Hardware Validations (APP4MC.sim)**
* Validations:
** Inchron-HWModule-MissingClockReference (ERROR - HwModule)
*** HW Module must have 'Frequency Domain' reference
-** Sim-HW-Connection (ERROR - HwConnection)
-*** Either read AND write latency, or datarate, or both must be set
-** Sim-HW-MemoryDefinition (INFO - MemoryDefinition)
+** Sim-HW-ProcessingUnit (ERROR - ProcessingUnit)
+*** ProcessingUnit definition must be set
+** Sim-HW-AccessElement (WARNING - HwAccessElement)
+*** Either hwAccessPath must be set or at least one of read latency and datarate must be set. Either hwAccessPath must be set or at least one of write latency and datarate must be set.
+** Sim-HW-Connection (WARNING - HwConnection)
+*** Either read latency or data rate or both must be set. Either write latency or data rate or both must be set.
+** Sim-HW-MemoryDefinition (WARNING - MemoryDefinition)
*** Either access latency or datarate (or both) must be set
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.sim.SimMappingProfile@<br/>
**Mapping Validations (APP4MC.sim)**
@@ -202,14 +200,14 @@
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.sim.SimSoftwareProfile@<br/>
**Software Validations (APP4MC.sim)**
* Validations:
-** Sim-Software-AbstractMemoryElementIsMapped (ERROR - LabelAccess)
-*** Checks if label access type is set
+** Sim-Software-AbstractMemoryElementIsMapped (ERROR - ModeLabelAccess)
+*** Checks if modeLabel access type is valid
** Sim-Software-AbstractMemoryElementIsMapped (ERROR - Label)
*** Checks if label is mapped to a memory node
** Sim-Software-AbstractMemoryElementIsMapped (ERROR - Channel)
*** Checks if channel is mapped to a Memory
-** Sim-Software-AbstractMemoryElementIsMapped (ERROR - ModeLabelAccess)
-*** Checks if modeLabel access type is valid
+** Sim-Software-AbstractMemoryElementIsMapped (ERROR - LabelAccess)
+*** Checks if label access type is set
** Sim-Software-ChannelAccessFeasibility (ERROR - ChannelAccess)
*** Checks if a channel access can be performed from certain runnable
** Sim-Software-ChannelElements (ERROR - ChannelAccess)
@@ -218,8 +216,6 @@
*** Checks if a label access can be performed from certain runnable
** Sim-Software-Process (ERROR - Process)
*** At least one stimulus must be set
-** Inchron-SW-Runnable-MustHaveActivityGraph (WARNING - Runnable)
-*** Runnable must have at least one ActivityGraph
** Inchron-SW-Task-MustHaveActivityGraph (WARNING - Task)
*** Task must have atleast one ActivityGraph
** Sim-Software-AbstractMemoryElementIsMapped (WARNING - ModeLabel)
@@ -228,6 +224,8 @@
*** Checks if a modeLabel access can be performed from certain runnable
** TA-Software-ModeConditionConjunctionAlwaysFalse (WARNING - ModeConditionConjunction)
** TA-Software-ModeConditionDisjunctionAlwaysTrue (WARNING - ModeConditionDisjunction)
+** Inchron-SW-Runnable-MustHaveActivityGraph (INFO - Runnable)
+*** Runnable must have at least one ActivityGraph
h4. Timing Architects Validations
@@ -250,14 +248,14 @@
**Basic Validations (Timing Architects)**
* Validations:
** TA-Basic-ContinuousValueGaussDistribution-mean (ERROR - ContinuousValueGaussDistribution)
-*** Mean must not be less than the lower bound
*** Mean must not be greater than the upper bound
+*** Mean must not be less than the lower bound
** TA-Basic-DiscreteValueGaussDistribution-mean (ERROR - DiscreteValueGaussDistribution)
-*** Mean must not be less than the lower bound
*** Mean must not be greater than the upper bound
+*** Mean must not be less than the lower bound
** TA-Basic-TimeGaussDistribution-mean (ERROR - TimeGaussDistribution)
-*** Mean must not be less than the lower bound
*** Mean must not be greater than the upper bound
+*** Mean must not be less than the lower bound
p{padding: 10px; background: #fafafa; border: 1px solid #888; border-radius: 5px}. @org.eclipse.app4mc.amalthea.validations.ta.TAConstraintsProfile@<br/>
**Constraints Validations (Timing Architects)**
* Validations:
