src/main/java/org/eclipse/mdm/api/base/model/AxisType.java

/*
 * Copyright (c) 2016 Gigatronik Ingolstadt GmbH and others
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */

package org.eclipse.mdm.api.base.model;

/**
 * This is the axis type enumeration as defined in the ASAM ODS NVH model.
 *
 * @since 1.0.0
 * @author Viktor Stoehr, Gigatronik Ingolstadt GmbH
 * @author Sebastian Dirsch, Gigatronik Ingolstadt GmbH
 * @see Channel
 */
public class AxisType extends EnumerationValue {

	/**
	 * A {@link Channel} of this type may be displayed as the x-axis.
	 */
	public static final AxisType X_AXIS = new AxisType(0);

	/**
	 * A {@link Channel} of this type may be displayed as the y-axis.
	 */
	public static final AxisType Y_AXIS = new AxisType(1);

	/**
	 * A {@link Channel} of this type may be displayed as the x- or y-axis.
	 */
	public static final AxisType XY_AXIS = new AxisType(2);

	/**
	 * Returns true if this axis type is {@link #X_AXIS}.
	 *
	 * @return Returns {@code true} if this constant is the constant described
	 *         above.
	 */
	public boolean isXAxis() {
		return X_AXIS == this;
	}

	/**
	 * Returns true if this axis type is {@link #Y_AXIS}.
	 *
	 * @return Returns {@code true} if this constant is the constant described
	 *         above.
	 */
	public boolean isYAxis() {
		return Y_AXIS == this;
	}

	/**
	 * Returns true if this axis type is {@link #XY_AXIS}.
	 *
	 * @return Returns {@code true} if this constant is the constant described
	 *         above.
	 */
	public boolean isXYAxis() {
		return XY_AXIS == this;
	}

	/**
	 * Constructor, makes sure that the order matches the order of the static
	 * fields
	 */
	AxisType(int ord) {
		super(ord);
	}
}