/*
 * $Id$
 * This file is a part of the Arakhne Foundation Classes, http://www.arakhne.org/afc
 *
 * Copyright (c) 2000-2012 Stephane GALLAND.
 * Copyright (c) 2005-10, Multiagent Team, Laboratoire Systemes et Transports,
 *                        Universite de Technologie de Belfort-Montbeliard.
 * Copyright (c) 2013-2020 The original authors, and other authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.arakhne.afc.math.physics.kinematic.angular;

import org.eclipse.xtext.xbase.lib.Inline;
import org.eclipse.xtext.xbase.lib.Pure;

import org.arakhne.afc.math.physics.AngularUnit;

/**
 * This interface describes an object that is able to
 * provide angular instant speed, velocity, acceleration, and
 * the maximal values for the speeds.
 *
 * @author $Author: sgalland$
 * @version $FullVersion$
 * @mavengroupid $GroupId$
 * @mavenartifactid $ArtifactId$
 * @since 13.0
 */
public interface AngularAccelerationKinematic extends AngularInstantAccelerationKinematic, AngularVelocityKinematic {

	/** Returns the maximal angular acceleration of this object in r/s^2.
	 *
	 * @return the maximal angular acceleration of this object in r/s^2,
	 *     always &gt;= 0.
	 */
	@Pure
	@Inline(value = "getMaxAngularAcceleration($1.RADIANS_PER_SECOND)", imported = {AngularUnit.class})
	default double getMaxAngularAcceleration() {
		return getMaxAngularAcceleration(AngularUnit.RADIANS_PER_SECOND);
	}

	/** Returns the maximal angular acceleration of this object in the given unit.
	 *
	 * @param unit the unit in which the acceleration will be given
	 * @return the maximal angular acceleration of this object in the given unit,
	 *     always &gt;= 0.
	 */
	@Pure
	double getMaxAngularAcceleration(AngularUnit unit);

	/** Returns the maximal angular deceleration of this object in r/s^2.
	 *
	 * @return the maximal angular deceleration of this object in r/s^2,
	 *     always &gt;= 0.
	 */
	@Pure
	@Inline(value = "getMaxAngularDeceleration($1.RADIANS_PER_SECOND)", imported = {AngularUnit.class})
	default double getMaxAngularDeceleration() {
		return getMaxAngularDeceleration(AngularUnit.RADIANS_PER_SECOND);
	}

	/** Returns the maximal angular deceleration of this object the given unit.
	 *
	 * @param unit the unit in which the deceleration will be given
	 * @return the maximal angular deceleration of this object in the given unit,
	 *     always &gt;= 0.
	 */
	@Pure
	double getMaxAngularDeceleration(AngularUnit unit);

}
