View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.math3.geometry.euclidean.threed;
19  
20  import org.apache.commons.math3.exception.MathIllegalStateException;
21  import org.apache.commons.math3.exception.util.LocalizedFormats;
22  
23  /** This class represents exceptions thrown while extractiong Cardan
24   * or Euler angles from a rotation.
25  
26   * @version $Id: CardanEulerSingularityException.java 1416643 2012-12-03 19:37:14Z tn $
27   * @since 1.2
28   */
29  public class CardanEulerSingularityException
30    extends MathIllegalStateException {
31  
32      /** Serializable version identifier */
33      private static final long serialVersionUID = -1360952845582206770L;
34  
35      /**
36       * Simple constructor.
37       * build an exception with a default message.
38       * @param isCardan if true, the rotation is related to Cardan angles,
39       * if false it is related to EulerAngles
40       */
41      public CardanEulerSingularityException(boolean isCardan) {
42          super(isCardan ? LocalizedFormats.CARDAN_ANGLES_SINGULARITY : LocalizedFormats.EULER_ANGLES_SINGULARITY);
43      }
44  
45  }