fr.cnes.sirius.patrius.utils.legs

Interface Leg

All Superinterfaces:

TimeStamped

All Known Subinterfaces:

AttitudeLeg, AttitudeProfile, OrientationAngleLeg, OrientationAngleProfile, Slew

All Known Implementing Classes:

AbstractAngularVelocitiesAttitudeProfile, AbstractAttitudeProfile, AbstractOrientationAngleLeg, AbstractOrientationAngleProfile, AngularVelocitiesHarmonicProfile, AngularVelocitiesPolynomialProfile, AngularVelocitiesPolynomialProfileLeg, AngularVelocitiesPolynomialSlew, AttitudeLawLeg, ConstantOrientationAngleLeg, ConstantSpinSlew, OrientationAngleLawLeg, OrientationAngleProfileSequence, QuaternionDatePolynomialProfile, QuaternionHarmonicProfile, QuaternionPolynomialProfile, RelativeTabulatedAttitudeLeg, TabulatedAttitude, TabulatedSlew

public interface Leg
extends TimeStamped

A leg is an object which is valid between two dates.

It’s also TimeStamped by the beginning date.

Please note a Leg should be immutable, and please see Leg#copy(AbsoluteDateInterval) method.

Since:

4.7

Author:

Julien Anxionnat (CNES — DSO/DV/MP)

See Also:

TimeStamped, LegsSequence

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEG_NATURE Default nature.

Method Summary

Modifier and Type	Method and Description
default boolean	contains(AbsoluteDate dateIn) Check whether the given date is contained in the interval of the current leg.
Leg	copy(AbsoluteDateInterval newInterval) Creates a new leg from this one.
default AbsoluteDate	getDate() Returns the leg start date.
default AbsoluteDate	getEnd() Returns the leg end date.
default String	getNature() Returns the nature of the leg.
AbsoluteDateInterval	getTimeInterval() Returns the time interval of the leg.
default String	toPrettyString() Returns a nice String representation.

Field Detail

LEG_NATURE

static final String LEG_NATURE

Default nature.

See Also:

Constant Field Values

Method Detail

getNature

default String getNature()

Returns the nature of the leg.

Returns:

The “nature” of the leg.

getTimeInterval

AbsoluteDateInterval getTimeInterval()

Returns the time interval of the leg.

Returns:

the time interval of the leg.

getDate

default AbsoluteDate getDate()

Returns the leg start date.

Specified by:

getDate in interface TimeStamped

Returns:

the leg start date

getEnd

default AbsoluteDate getEnd()

Returns the leg end date.

Returns:

the leg end date

copy

Leg copy(AbsoluteDateInterval newInterval)

Creates a new leg from this one.

Parameters:

newInterval - The time interval of the leg to create

Returns:

A new Leg valid on provided interval

Throws:

IllegalArgumentException - If the given newInterval is problematic (too long, too short, whatever)

toPrettyString

default String toPrettyString()

Returns a nice String representation.

Returns:

A nice String representation.

contains

default boolean contains(AbsoluteDate dateIn)

Check whether the given date is contained in the interval of the current leg.

Parameters:

dateIn - date to check

Returns:

boolean: if true, the given date is contained in the interval; if false, it is not