fr.cnes.sirius.patrius.utils.legs

Interface Leg

All Superinterfaces:

Serializable

All Known Subinterfaces:

AttitudeLeg, AttitudeProfile, LegsSequence<L>, OrientationAngleLeg, OrientationAngleProfile, Slew

All Known Implementing Classes:

AbstractAngularVelocitiesAttitudeProfile, AbstractAttitudeProfile, AbstractIsisSpinBiasSlew, AbstractLegsSequence, AbstractOrientationAngleLeg, AbstractOrientationAngleProfile, AbstractSlew, AngularVelocitiesHarmonicProfile, AngularVelocitiesPolynomialProfile, AngularVelocitiesPolynomialProfileLeg, AngularVelocitiesPolynomialSlew, AttitudeLawLeg, AttitudeLegsSequence, AttitudeProfilesSequence, ConstantOrientationAngleLeg, ConstantSpinSlew, IsisAnalyticalSpinBiasSlew, IsisNumericalSpinBiasSlew, OrientationAngleLawLeg, OrientationAngleLegsSequence, OrientationAngleProfileSequence, QuaternionHarmonicProfile, QuaternionPolynomialProfile, RelativeTabulatedAttitudeLeg, TabulatedAttitude, TabulatedSlew, TwoSpinBiasSlew

public interface Leg
extends Serializable

Interface which makes it obligatory to give an interval of validity and a nature. All the classes implementing this interface should have an interval of validity with CLOSED endpoints.

Since:

4.2

Author:

morerem

Method Summary

Modifier and Type	Method and Description
String	getNature() Return the nature of the leg.
AbsoluteDateInterval	getTimeInterval() Return the time interval of validity of the leg
default String	toPrettyString() Returns a string representation of the leg.
void	truncate(AbsoluteDateInterval newInterval) Truncate the time interval of validity of the leg

Method Detail

getTimeInterval

AbsoluteDateInterval getTimeInterval()

Return the time interval of validity of the leg

Returns:

time interval of validity of the leg

getNature

String getNature()

Return the nature of the leg.

Returns:

nature of the leg

truncate

void truncate(AbsoluteDateInterval newInterval)
       throws PatriusException

Truncate the time interval of validity of the leg

Parameters:

newInterval - the new time interval

Throws:

PatriusException - if the new time interval is not included in the current time interval

toPrettyString

default String toPrettyString()

Returns a string representation of the leg.

Returns:

a string representation of the leg.