DoPropertyTotals.java

/**
 * Copyright (c) 2004-2025 Carnegie Mellon University and others. (see Contributors file). 
 * All Rights Reserved.
 * 
 * NO WARRANTY. ALL MATERIAL IS FURNISHED ON AN "AS-IS" BASIS. CARNEGIE MELLON UNIVERSITY MAKES NO WARRANTIES OF ANY
 * KIND, EITHER EXPRESSED OR IMPLIED, AS TO ANY MATTER INCLUDING, BUT NOT LIMITED TO, WARRANTY OF FITNESS FOR PURPOSE
 * OR MERCHANTABILITY, EXCLUSIVITY, OR RESULTS OBTAINED FROM USE OF THE MATERIAL. CARNEGIE MELLON UNIVERSITY DOES NOT
 * MAKE ANY WARRANTY OF ANY KIND WITH RESPECT TO FREEDOM FROM PATENT, TRADEMARK, OR COPYRIGHT INFRINGEMENT.
 * 
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * SPDX-License-Identifier: EPL-2.0
 * 
 * Created, in part, with funding and support from the United States Government. (see Acknowledgments file).
 * 
 * This program includes and/or can make use of certain third party source code, object code, documentation and other
 * files ("Third Party Software"). The Third Party Software that is used by this program is dependent upon your system
 * configuration. By using this program, You agree to comply with any and all relevant Third Party Software terms and
 * conditions contained in any such Third Party Software or separate license file distributed with such Third Party
 * Software. The parties who own the Third Party Software ("Third Party Licensors") are intended third party benefici-
 * aries to this license with respect to the terms applicable to their Third Party Software. Third Party Software li-
 * censes only apply to the Third Party Software and not any other portion of this program or this program as a whole.
 */
package org.osate.analysis.architecture.handlers;

import org.eclipse.core.runtime.IProgressMonitor;
import org.osate.aadl2.Element;
import org.osate.aadl2.NamedElement;
import org.osate.aadl2.instance.ComponentInstance;
import org.osate.aadl2.instance.SystemInstance;
import org.osate.aadl2.modelsupport.errorreporting.AnalysisErrorReporterManager;
import org.osate.analysis.architecture.PropertyTotals;
import org.osate.result.Result;
import org.osate.ui.handlers.AaxlReadOnlyHandlerAsJob;

public final class DoPropertyTotals extends AaxlReadOnlyHandlerAsJob {
	@Override
	public String getMarkerType() {
		return "org.osate.analysis.architecture.WeightTotalObjectMarker";
	}

	@Override
	protected String getActionName() {
		return "Weight totals";
	}

	@Override
	public boolean initializeAction(NamedElement obj) {
		setCSVLog("WeightAnalysis", obj);
		return true;
	}

	public void setErrManager() {
		this.errManager = new AnalysisErrorReporterManager(this.getAnalysisErrorReporterFactory());
	}

	public void saveReport() {
		this.getCSVLog().saveToFile();
	}

	@Override
	public void doAaxlAction(IProgressMonitor monitor, Element obj) {
		/*
		 * Doesn't make sense to set the number of work units, because
		 * the whole point of this action is count the number of elements.
		 * To set the work units we would effectively have to count everything
		 * twice.
		 */
		monitor.beginTask("Gathering weight summaries", IProgressMonitor.UNKNOWN);

		if (!(obj instanceof ComponentInstance)) {
			warning(obj, "Weight totals: Please invoke command on an instance model");
			monitor.done();
			return;
		}

		// Get the system instance (if any)
		SystemInstance si = ((ComponentInstance) obj).getSystemInstance();

		PropertyTotals.invoke(si).getResults().forEach(result -> generateMarkers(result));

		monitor.done();
	}

	public void invoke(IProgressMonitor monitor, SystemInstance root) {
		actionBody(monitor, root);
	}

	private void generateMarkers(Result result) {
		result.getSubResults().forEach(subResult -> generateMarkers(subResult));
		result.getDiagnostics().forEach(issue -> {
			switch (issue.getDiagnosticType()) {
			case ERROR:
				error((Element) issue.getModelElement(), issue.getMessage());
				break;
			case INFO:
				info((Element) issue.getModelElement(), issue.getMessage());
				break;
			case WARNING:
				warning((Element) issue.getModelElement(), issue.getMessage());
				break;
			default:
				// Do nothing.
			}
		});
	}
}