Merge pull request #665 from Systems-Modeling/ST6RI-843

ST6RI-843 Annotate adapter transformation code with implemented semantic constraints

Author: seidewitz

kerml/src/examples/Simple Tests/Associations.kerml

@@ -1,7 +1,10 @@
-package Associations {	
+package Associations {
+    datatype X;
+    class Y;
+    
 	assoc A {
-		end x;
-		end [1..*] feature y;
+		end x_cross [1..1] feature x : X; 
+		end y_cross [1..*] feature y : Y;
 	}
 
 	assoc B specializes A {

org.omg.sysml/src/org/omg/sysml/adapter/AcceptActionUsageAdapter.java

@@ -45,7 +45,7 @@ public void computeImplicitGeneralTypes() {
 	@Override
 	public void addDefaultGeneralType() {
 		// Don't add a default type for a transition trigger action because such
-		// an action will always redefine TransitionAction::accepter anyway.
+		// an action will always redefine TransitionAction::accepter anyway: checkAcceptActionUsageTriggerActionSpecialization
 		if (!isTriggerAction()) {
 			super.addDefaultGeneralType();
 		}

org.omg.sysml/src/org/omg/sysml/adapter/ActionUsageAdapter.java

@@ -48,6 +48,12 @@ public ActionUsage getTarget() {
 
 	// Implicit Generalization
 
+	/**
+	 * @satisfies checkAcceptActionUsageTriggerActionSpecialization
+	 * @satisfies checkStepEnclosedPerformanceSpecialization
+	 * @satisfies checkStepOwnedPerformanceSpecialization
+	 * @satisfies checkStepSubperformanceSpecialization
+	 */
 	@Override
 	public void addDefaultGeneralType() {
 		super.addDefaultGeneralType();
@@ -67,6 +73,11 @@ public void addDefaultGeneralType() {
 		}
 	}
 
+	/**
+	 * @satisfies checkAcceptActionUsageSpecialization
+	 * @satisfies checkSendActionUsageSpecialization
+	 * @satisfies checkWhileLoopActionUsageSpecialization
+	 */
 	@Override
 	protected String getDefaultSupertype() {
 		return getDefaultSupertype("base");
@@ -77,6 +88,22 @@ protected boolean isSuboccurrence() {
 		return super.isSuboccurrence() && !isActionOwnedComposite();
 	}
 
+	/**
+	 * @satisfies checkActionUsageSubactionSpecialization
+	 * @satisfies checkAcceptActionUsageSubactionSpecialization
+	 * @satisfies checkDecisionNodeSpecialization
+	 * @satisfies checkForkNodeSpecialization
+	 * @satisfies checkForLoopActionUsageSubactionSpecialization
+	 * @satisfies checkIfActionUsageSubactionSpecialization
+	 * @satisfies checkJoinNodeSpecialization
+	 * @satisfies checkMergeNodeSpecialization
+	 * @satisfies checkAssignmentActionUsageSubactionSpecialization
+	 * @satisfies checkSendActionUsageSubactionSpecialization
+	 * @satisfies checkWhileLoopActionUsageSubactionSpecialization
+	 * @satisfies checkActionUsageOwnedActionSpecialization
+	 * @satisfies checkStateUsageOwnedStateSpecialization
+	 * 
+	 */
 	protected String getSubactionType() {
 		return isActionOwnedComposite()? "subaction": 
 			   isPartOwnedComposite()? "ownedAction":
@@ -96,6 +123,7 @@ public boolean isPerformedAction() {
 	 */
 	@Override
 	public boolean isComputeRedefinitions() {
+		//checkActionUsageStateActionRedefinition
 		String redefinedFeature = getRedefinedFeature(getTarget());
 		return redefinedFeature != null? isComputeRedefinitions:
 				super.isComputeRedefinitions();
@@ -110,6 +138,9 @@ protected List<? extends Feature> getRelevantFeatures(Type type, Element skip) {
 			   Collections.singletonList((Feature)getLibraryType(redefinedFeature));
 	}
 
+	/**
+	 * @satisfies checkTransitionUsageTransitionFeatureSpecialization
+	 */
 	protected static String getRedefinedFeature(Feature target) {
 		FeatureMembership membership = target.getOwningFeatureMembership();
 		String kind = 

org.omg.sysml/src/org/omg/sysml/adapter/AnalysisCaseUsageAdapter.java

@@ -38,6 +38,8 @@ public AnalysisCaseUsage getTarget() {
 
 	@Override
 	protected String getSubactionType() {
+		//checkAnalysisCaseUsageSpecialization
+		//checkAnalysisCaseUsageSubAnalysisCaseSpecialization
 		return isSubAnalysisCase()? "subAnalysisCase": super.getSubactionType();	
 	}
 

org.omg.sysml/src/org/omg/sysml/adapter/AssertConstraintUsageAdapter.java

@@ -36,6 +36,9 @@ public AssertConstraintUsage getTarget() {
 		return (AssertConstraintUsage)super.getTarget();
 	}
 
+	/**
+	 * @satisfies checkAssertConstraintUsageSpecialization
+	 */
 	@Override
 	protected String getDefaultSupertype() {
 		return getTarget().isNegated()?

org.omg.sysml/src/org/omg/sysml/adapter/AssignmentActionUsageAdapter.java

@@ -34,6 +34,11 @@ public AssignmentActionUsage getTarget() {
 		return (AssignmentActionUsage)super.getTarget();
 	}
 
+	/**
+	 * @satisfies checkAssignmentActionUsageReferentRedefinition
+	 * @satisfies checkAssignmentActionUsageAccessedFeatureRedefinition
+	 * @satisfies checkAssignmentActionUsageStartingAtRedefinition
+	 */
 	protected void addTargetRedefinitions() {
 		AssignmentActionUsage target = getTarget();
 		addFeatureWriteTypes(TypeUtil.getOwnedParametersOf(target), target.getReferent());

org.omg.sysml/src/org/omg/sysml/adapter/AssociationAdapter.java

@@ -33,7 +33,13 @@ public AssociationAdapter(Association element) {
 	public Association getTarget() {
 		return (Association)super.getTarget();
 	}
-
+	
+	/**
+	 * @satisfies checkAssociationSpecialization
+	 * @satisfies checkAssociationBinarySpecialization
+	 * @satisfies checkAssociationStructureSpecialization
+	 * @satisfies checkAssociationStructureBinarySpecialization
+	 */
 	@Override
 	protected String getDefaultSupertype() {
 		return getTarget().getOwnedEndFeature().size() != 2 ? 

org.omg.sysml/src/org/omg/sysml/adapter/CalculationDefinitionAdapter.java

@@ -33,6 +33,9 @@ public CalculationDefinition getTarget() {
 		return (CalculationDefinition)super.getTarget();
 	}
 
+	/**
+	 * @satisfies checkFunctionResultBindingConnector
+	 */
 	@Override
 	public void doTransform() {
 		super.doTransform();

org.omg.sysml/src/org/omg/sysml/adapter/CalculationUsageAdapter.java

@@ -38,12 +38,22 @@ public CalculationUsage getTarget() {
 		return (CalculationUsage)super.getTarget();
 	}
 
+	/**
+	 * @satisfies checkCalculationUsageSpecialization
+	 * @satisfies checkCalculationUsageSubcalculationSpecialization
+	 */
 	@Override
 	protected String getSubactionType() {
 		return isSubcalculation()? "subcalculation": super.getSubactionType();	
 	}		
 
 	public boolean isSubcalculation() {
+		/*
+		 * TODO: Update checkCalculationUsageSubcalculationSpecialization
+		 * 
+    	 * isNonEntryExitComposite check is not part of the OCL
+    	 * See SYSML12-298
+		 */
 		CalculationUsage target = getTarget();
 		Type owningType = target.getOwningType();
 		return isNonEntryExitComposite() &&

org.omg.sysml/src/org/omg/sysml/adapter/CaseUsageAdapter.java

@@ -1,6 +1,6 @@
 /*******************************************************************************
  * SysML 2 Pilot Implementation
- * Copyright (c) 2021, 2023-2024 Model Driven Solutions, Inc.
+ * Copyright (c) 2021, 2023-2025 Model Driven Solutions, Inc.
  *    
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU Lesser General Public License as published by
@@ -47,12 +47,22 @@ public boolean hasRelevantSubjectParameter() {
 
 	// Implicit Generalization
 
+	/**
+	 * @satisfies checkCaseUsageSpecialization
+	 * @satisfies checkCaseUsageSubcaseSpecialization
+	 */
 	@Override
 	protected String getSubactionType() {
 		return isSubcase()? "subcase": super.getSubactionType();	
 	}
 
 	public boolean isSubcase() {
+		/*
+		 * TODO: Update checkCaseUsageSubcaseSpecialization
+		 * 
+		 * nonEntryExit part of the check is not reflected of the OCL
+    	 * See SYSML21-298
+		 */
 		CaseUsage target = getTarget();
 		Type owningType = target.getOwningType();
 		return isNonEntryExitComposite() &&