fr.cnes.sirius.patrius.utils
Class AngleInterval

java.lang.Object
  fr.cnes.sirius.patrius.utils.AbstractInterval
      fr.cnes.sirius.patrius.utils.AngleInterval

All Implemented Interfaces:

Serializable

public final class AngleInterval
extends AbstractInterval
implements Serializable

- This class describes an angle interval.

- It contains no method other than getters and setters : the operations on angles are available in the AngleTools class

See DV-MATHS_50.

Since:

1.0

Version:

$Id: AngleInterval.java 6322 2012-09-20 15:51:39Z CardosoP $

Author:

Thomas TRAPIER

See Also:

Serialized Form

Use sample :

There are two ways of building an angle interval : with the two end points, or with a reference angle and the interval length.

AngleInterval angleInterval = new AngleInterval(lowerType, lowerAngle, upperAngle, upperType);

AngleInterval angleInterval = new AngleInterval(reference, length, lowerType, upperType);

Concurrency :

immutable

Constructor Summary

AngleInterval(double referenceIn, double lengthIn, IntervalEndpointType lowerEndPointIn, IntervalEndpointType upperEndPointIn)
Constructor
Needs the reference angle and the interval length.

AngleInterval(IntervalEndpointType lowerEndPointIn, double lowerAngleIn, double upperAngleIn, IntervalEndpointType upperEndPointIn)
Constructor
Needs the two end points values.

Method Summary

double	getLength()
double	getLowerAngle()
double	getReference()
double	getUpperAngle()
String	toString() This method returns a String representing the interval, with boundaries as brackets and the lower/upper values. Example : "] 0.0 rad , 1.2534 rad [" for an open interval. Warning : this representation is subject to change.

Methods inherited from class fr.cnes.sirius.patrius.utils.AbstractInterval

getLowerEndPoint, getUpperEndPoint, setLowerEndPoint, setUpperEndPoint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AngleInterval

public AngleInterval(IntervalEndpointType lowerEndPointIn,
                     double lowerAngleIn,
                     double upperAngleIn,
                     IntervalEndpointType upperEndPointIn)

Constructor
Needs the two end points values.

Parameters:

lowerEndPointIn - lower end point type of the interval

lowerAngleIn - lower angle of the interval

upperAngleIn - upper angle of the interval

upperEndPointIn - upper end point type of the interval

Throws:

MathIllegalArgumentException - if the interval is invalid

Since:

1.0

AngleInterval

public AngleInterval(double referenceIn,
                     double lengthIn,
                     IntervalEndpointType lowerEndPointIn,
                     IntervalEndpointType upperEndPointIn)

Constructor
Needs the reference angle and the interval length.

Parameters:

referenceIn - reference angle of the interval

lengthIn - length of the interval

lowerEndPointIn - lower end point type of the interval

upperEndPointIn - upper end point type of the interval

Throws:

MathIllegalArgumentException - if the interval is invalid

Since:

1.0

Method Detail

toString

public String toString()

This method returns a String representing the interval, with boundaries as brackets and the lower/upper values.
Example : "] 0.0 rad , 1.2534 rad [" for an open interval.
Warning : this representation is subject to change.

Overrides:

toString in class Object

Returns:

a String representation

See Also:

Object.toString()

getLowerAngle

public double getLowerAngle()

Returns:

the lowerAngle

getUpperAngle

public double getUpperAngle()

Returns:

the upperAngle

getReference

public double getReference()

Returns:

the reference

getLength

public double getLength()

Returns:

the length