LatencyContributorComponent.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.flows.model;

import org.osate.aadl2.ComponentCategory;
import org.osate.aadl2.ComponentClassifier;
import org.osate.aadl2.ComponentType;
import org.osate.aadl2.FlowSpecification;
import org.osate.aadl2.NamedElement;
import org.osate.aadl2.VirtualBus;
import org.osate.aadl2.instance.ComponentInstance;
import org.osate.aadl2.instance.FlowElementInstance;
import org.osate.aadl2.instance.FlowSpecificationInstance;

/**
 * A latency Result represents something in the flow
 * that can contribute to increase/decrease the latency.
 *
 * This class contains the result for a latency contributor
 * with min/max latency.
 *
 * @author julien
 *
 */
public class LatencyContributorComponent extends LatencyContributor {
	private final FlowSpecification flowSpec;

	public LatencyContributorComponent(NamedElement ci, boolean majorFrameDelay) {
		this(ci, null, majorFrameDelay);
	}

	/**
	 * @since 4.0
	 */
	public LatencyContributorComponent(NamedElement ci, FlowElementInstance flowElement, boolean majorFrameDelay) {
		super(majorFrameDelay);
		this.relatedElement = ci;

		FlowSpecification fs = null;
		if (flowElement instanceof FlowSpecificationInstance) {
			fs = ((FlowSpecificationInstance) flowElement).getFlowSpecification();
		}
		flowSpec = fs;
	}

	@Override
	protected String getContributorType() {
		ComponentInstance relatedComponentInstance;
		ComponentType relatedComponentType;

		if (relatedElement instanceof ComponentInstance) {
			relatedComponentInstance = (ComponentInstance) relatedElement;
			if (relatedComponentInstance.getCategory() == ComponentCategory.VIRTUAL_BUS) {
				return "protocol";
			}
			if (relatedComponentInstance.getCategory() == ComponentCategory.VIRTUAL_PROCESSOR) {
				return "partition";
			}
			return relatedComponentInstance.getCategory().getName();
		}
		if (relatedElement instanceof VirtualBus) {
			return "protocol";
		}
		if (relatedElement instanceof ComponentClassifier) {
			relatedComponentType = (ComponentType) relatedElement;
			return relatedComponentType.getCategory().getName();
		}
		return "component";
	}

	@Override
	protected String getFlowSpecName() {
		if (flowSpec != null) {
			return flowSpec.getKind() + " " + flowSpec.getName();
		} else {
			return "";
		}
	}

}