agi.foundation.access

(agi.foundation.core-2024r2.jar)

Interface ILinkConstraint

All Known Implementing Classes:

AlwaysSatisfiedLinkConstraint, AngleInPlaneConstraint, AngleOutOfPlaneConstraint, AzimuthAngleConstraint, AzimuthAngleRateConstraint, AzimuthElevationMaskConstraint, CentralBodyObstructionConstraint, CentralBodySurfaceCurveElevationAngleConstraint, CentralBodySurfaceRegionElevationAngleConstraint, CentralBodySurfaceRegionSensorVolumeConstraint, CircularEquatorialOrbitGrazingAngleConstraint, CommunicationLinkConstraint, CovarianceSeparationConstraint, ElevationAngleConstraint, ElevationAngleRateConstraint, GroundSampleDistanceConstraint, HeightAboveHorizonConstraint, RangeConstraint, RangeRateConstraint, SensorVolumeConstraint, SurfaceDistanceConstraint, TerrainLineOfSightConstraint, TotalAngularRateConstraint

public interface ILinkConstraint

An interface to an AccessConstraint that constrains the relationship between two objects.

Method Summary

Modifier and Type	Method and Description
IServiceProvider	getConstrainedLink() Gets the link to which this constraint applies.
LinkRole	getConstrainedLinkEnd() Gets the end of the link to which this constraint applies.
void	setConstrainedLink(IServiceProvider value) Sets the link to which this constraint applies.
void	setConstrainedLinkEnd(LinkRole value) Sets the end of the link to which this constraint applies.

Method Detail

getConstrainedLink

IServiceProvider getConstrainedLink()

Gets the link to which this constraint applies.

setConstrainedLink

void setConstrainedLink(IServiceProvider value)

Sets the link to which this constraint applies.

getConstrainedLinkEnd

@Nonnull
LinkRole getConstrainedLinkEnd()

Gets the end of the link to which this constraint applies. Usually this corresponds to the end of the link that is observing the relationship between the objects for the purpose of the constraint computation.

Some link constraints may be identical when observed from either end and will ignore this property.

setConstrainedLinkEnd

void setConstrainedLinkEnd(@Nonnull
                           LinkRole value)

Sets the end of the link to which this constraint applies. Usually this corresponds to the end of the link that is observing the relationship between the objects for the purpose of the constraint computation.

Some link constraints may be identical when observed from either end and will ignore this property.