Package com.luciad.ais.model.procedure

Class TLcdProcedureTrajectory

java.lang.Object
com.luciad.ais.model.procedure.TLcdProcedureTrajectory
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdCurve, ILcdPointList, ILcdPolyline, ILcdShape, ILcdCloneable, ILcdFeatured, ILcdInvalidateable, Serializable, Cloneable
public class TLcdProcedureTrajectory extends Object implements ILcdPolyline, ILcdFeatured, ILcdDataObject, ILcdInvalidateable, ILcdCurve
This class is a wrapper object around an ILcdProcedure, provided as a convenience to help display procedures on a map. This class implements ILcdPolyline, so that it is easy to use it with existing LuciadLightspeed tools such as vertical views.

A procedure trajectory stores a reference to a procedure, and also holds a TLcdProcedureGeometryCalculator and TLcdAircraftPerformanceSettings. The combination of these two objects provide a geometrical representation of the procedure. This geometrical representation is internally cached, so external changes to the geometry calculator or the aircraft performance settings should always be accompanied by a call to the invalidate() method, which will ensure that the procedure geometry is properly updated to reflect the changes.

To avoid memory problems when handling large sets of procedure trajectories, the geometrical representation is stored using SoftReference objects: this allows to garbage-collect the geometrical representation, when memory is running low. In order to have the best performance, enough memory is needed to store all geometrical representations.

To access the geometry of a procedure trajectory, two approaches can be used:

  • through the methods available in ILcdPolyline, which give access to the individual points of the procedure trajectory,
  • through an ILcdProcedureGeometryHandler via processProcedureGeometry(ILcdProcedureGeometryHandler), which gives access to high-level information about the geometry that is not available through the ILcdPolyline interface.

Users should try to avoid adding ILcdProcedure objects to an ILcdModel directly, and should prefer using this class instead.

See Also:

  • Constructor Details

    • TLcdProcedureTrajectory

      public TLcdProcedureTrajectory(ILcdProcedure aProcedure, TLcdAircraftPerformanceSettings aAircraftPerformanceSettings, TLcdProcedureGeometryCalculator aGeometryCalculator)
      Constructs a TLcdProcedureTrajectory for the given procedure. The trajectory is built using the given geometry calculator and aircraft performance settings.
      Parameters:
      aProcedure - A procedure to create a trajectory for
      aAircraftPerformanceSettings - The aircraft performance settings to be used to calculate the trajectory
      aGeometryCalculator - The geometry calculator to calculate the trajectory

  • Method Details

    • invalidate

      public void invalidate()
      Discards the geometry cached with this trajectory and recalculates it from the source procedure. Whenever this is done, the ILcdModel containing this trajectory should be notified by means of a call to ALcdModel.elementChanged(Object, int)!

    • invalidateObject

      public void invalidateObject()
      Delegates to invalidate().
      Specified by:
      invalidateObject in interface ILcdInvalidateable
      See Also:

    • processProcedureGeometry

      public void processProcedureGeometry(ILcdProcedureGeometryHandler aHandler)
      Iterates over the procedure geometry using an ILcdProcedureGeometryHandler.

      This gives access to high-level information about the geometry that is not available through the ILcdPolyline interface.

      Parameters:
      aHandler - A handler to iterate over the procedure geometry

    • getProcedure

      public ILcdProcedure getProcedure()
      Returns the ILcdProcedure associated with this trajectory.
      Returns:
      the ILcdProcedure associated with this trajectory.

    • getAircraftPerformanceSettings

      public TLcdAircraftPerformanceSettings getAircraftPerformanceSettings()
      Returns the aircraft performance settings used by this trajectory.

      Important note: when this object is modified, invalidate() must be called on all TLcdProcedureTrajectory objects that are using it.

      Returns:
      the aircraft performance settings used by this trajectory.

    • setAircraftPerformanceSettings

      public void setAircraftPerformanceSettings(TLcdAircraftPerformanceSettings aPerformance)
      Sets the aircraft performance settings to be used by this trajectory and invokes the invalidate() method.
      Parameters:
      aPerformance - the aircraft performance settings to be used by this trajectory.

    • getProcedureGeometryCalculator

      public TLcdProcedureGeometryCalculator getProcedureGeometryCalculator()
      Returns the procedure geometry calculator used to calculate this trajectory.

      Important note: when this object is modified, invalidate() must be called on all TLcdProcedureTrajectory objects that are using it.

      Returns:
      the procedure geometry calculator used to calculate this trajectory.

    • setProcedureGeometryCalculator

      public void setProcedureGeometryCalculator(TLcdProcedureGeometryCalculator aGeometryCalculator)
      Sets the procedure geometry calculator to be used to calculate this trajectory and invokes the invalidate() method.
      Parameters:
      aGeometryCalculator - the procedure geometry calculator to calculate this trajectory.

    • toString

      public String toString()
      Returns the toString value of the associated ILcdProcedure.
      Overrides:
      toString in class Object
      Returns:
      the toString value of the associated ILcdProcedure.

    • getFocusPoint

      public ILcdPoint getFocusPoint()
      Description copied from interface: ILcdShape
      Returns the focus point of this ILcdShape.
      Specified by:
      getFocusPoint in interface ILcdShape
      Returns:
      the focus point of this ILcdShape.

    • contains2D

      public boolean contains2D(ILcdPoint aPoint)
      Returns false.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aPoint - a point
      Returns:
      false.
      See Also:

    • contains2D

      public boolean contains2D(double aX, double aY)
      Returns false.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aX - An X coordinate
      aY - An Y coordinate
      Returns:
      false.

    • contains3D

      public boolean contains3D(ILcdPoint aPoint)
      Returns false.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aPoint - a point
      Returns:
      false.
      See Also:

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Returns false.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aX - An X coordinate
      aY - An Y coordinate
      aZ - A Z coordinate
      Returns:
      false.

    • clone

      public Object clone()
      Returns a clone of this TLcdProcedureTrajectory object. Note: the features of the new object are a shallow clone of the features of this object.
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class Object
      Returns:
      a clone of this TLcdProcedureTrajectory object.
      See Also:

    • getBounds

      public ILcdBounds getBounds()
      Returns the bounds of this trajectory.
      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the bounds of this trajectory.

    • getPointCount

      public int getPointCount()
      Returns the number of points in this trajectory.
      Specified by:
      getPointCount in interface ILcdPointList
      Returns:
      the number of points in this trajectory.

    • getPoint

      public ILcdPoint getPoint(int aIndex) throws IndexOutOfBoundsException
      Returns the trajectory point at the given index.
      Specified by:
      getPoint in interface ILcdPointList
      Parameters:
      aIndex - the index of the point to be retrieved
      Returns:
      the trajectory point at the given index.
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getPointCount()).

    • computePointSFCT

      public void computePointSFCT(double aParam, ILcd3DEditablePoint aPointSFCT)
      Description copied from interface: ILcdCurve
      Computes a point of the curve, defined by the given parameter.
      Specified by:
      computePointSFCT in interface ILcdCurve
      Parameters:
      aParam - a value of the closed interval [0,1]
      aPointSFCT - the point to store the computed curve point in

    • getEndPoint

      public ILcdPoint getEndPoint()
      Description copied from interface: ILcdCurve
      Retrieves the end point of the curve.

      This is equivalent to computePointSFCT(1).

      Specified by:
      getEndPoint in interface ILcdCurve
      Returns:
      the end point of the curve

    • getEndTangent2D

      public double getEndTangent2D()
      Description copied from interface: ILcdCurve
      Returns the angle of the curve's tangent at the end point, in degrees counterclockwise from the direction at 3 o'clock.

      The tangent orientation is from the end point, away from the curve before it.

      This is the same as getTangent2D(1).

      Specified by:
      getEndTangent2D in interface ILcdCurve
      Returns:
      the curve's angle in the end point

    • getInterpolation

      public String getInterpolation()
      Description copied from interface: ILcdCurve
      Returns the interpolation method used by this curve.

      A set of predefined constants are defined in this interface, which are used by the default ILcdCurve implementations provided by LuciadLightspeed.

      Custom implementations can define their own constants, and use them to interpret the interpolation of the curve.

      Specified by:
      getInterpolation in interface ILcdCurve
      Returns:
      the interpolation method used by this curve.

    • getLength2D

      public double getLength2D(double aParam1, double aParam2)
      Description copied from interface: ILcdCurve
      Returns the length between two points of the curve, defined by the given parameters.
      • When aParam1 == aParam2, the length is 0.
      • When aParam1 == 0 and aParam2 == 1, the length is the whole length of the curve.
      • When aParam1 > aParam2, the length is (aParam1 to 1) + (0 to aParam2).
      Specified by:
      getLength2D in interface ILcdCurve
      Parameters:
      aParam1 - a value of the closed interval [0,1]
      aParam2 - a value of the closed interval [0,1]
      Returns:
      the length of the curve.

    • getLineSegmentIntersectionCount

      public int getLineSegmentIntersectionCount(ILcdPoint aP1, ILcdPoint aP2)
      Description copied from interface: ILcdCurve
      Returns the number of intersections between this curve and a line segment defined by the two specified points.

      This information can be used to perform containment calculations, if this curve is closed or if this curve is part of a composite closed curve. By determining the number of intersections between this curve and a line segment starting from a given point in a fixed direction, one can determine whether a point is located within the closed curve by using the even-odd rule.

      Specified by:
      getLineSegmentIntersectionCount in interface ILcdCurve
      Parameters:
      aP1 - the first point of the line segment
      aP2 - the second point of the line segment
      Returns:
      the number of intersections between the curve and the line segment

    • getStartPoint

      public ILcdPoint getStartPoint()
      Description copied from interface: ILcdCurve
      Retrieves the start point of the curve.

      This is equivalent to computePointSFCT(0).

      Specified by:
      getStartPoint in interface ILcdCurve
      Returns:
      the start point of the curve

    • getStartTangent2D

      public double getStartTangent2D()
      Description copied from interface: ILcdCurve
      Returns the angle of the curve's tangent at the start point, in degrees counterclockwise from the direction at 3 o'clock.

      The tangent orientation is from the start point towards the rest of the shape.

      This is the same as getTangent2D(0).

      Specified by:
      getStartTangent2D in interface ILcdCurve
      Returns:
      the curve's angle in the start point

    • getTangent2D

      public double getTangent2D(double aParam)
      Description copied from interface: ILcdCurve
      Returns the angle of the curve's tangent in the point defined by the given parameter, in degrees counterclockwise from the direction at 3 o'clock.

      The tangent orientation is from the point at parameter aParam towards the rest of the shape.

      Specified by:
      getTangent2D in interface ILcdCurve
      Parameters:
      aParam - a value of the closed interval [0,1]
      Returns:
      the curve's angle in the point defined by the given parameter

    • getFeatureCount

      public int getFeatureCount()
      Returns the number of features of the associated ILcdProcedure, if it is of the type ILcdFeatured. Otherwise, 0 is returned.
      Specified by:
      getFeatureCount in interface ILcdFeatured
      Returns:
      the number of features of the associated ILcdProcedure if it is of the type ILcdFeatured, or 0 otherwise.

    • getFeature

      public Object getFeature(int aIndex) throws IndexOutOfBoundsException, UnsupportedOperationException
      Returns the feature at the given index of the associated ILcdProcedure, if it is of the type ILcdFeatured. Otherwise, an UnsupportedOperationException is thrown.
      Specified by:
      getFeature in interface ILcdFeatured
      Parameters:
      aIndex - a valid feature index.
      Returns:
      the feature at the given index of the associated ILcdProcedure, if it is of the type ILcdFeatured.
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getFeatureCount()).
      UnsupportedOperationException - if the associated ILcdProcedure is not of the type ILcdFeatured.
      See Also:

    • setFeature

      public void setFeature(int aIndex, Object aObject) throws IndexOutOfBoundsException, UnsupportedOperationException
      Sets the feature at the given index of the associated ILcdProcedure, if it is of the type ILcdFeatured. Otherwise, an UnsupportedOperationException is thrown.
      Specified by:
      setFeature in interface ILcdFeatured
      Parameters:
      aIndex - the index of the feature to be set
      aObject - the feature value
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getFeatureCount()).
      UnsupportedOperationException - if the associated ILcdProcedure is not of the type ILcdFeatured.
      See Also:

    • canSetFeature

      public boolean canSetFeature(int aIndex)
      Returns whether the feature at the given index of the associated ILcdProcedure can be set. If the procedure is not of the type ILcdFeatured, false is returned.
      Specified by:
      canSetFeature in interface ILcdFeatured
      Parameters:
      aIndex - the index of the feature to be set
      Returns:
      true if the feature at the given index can be set.

    • getDataType

      public TLcdDataType getDataType()
      Description copied from interface: ILcdDataObject
      Returns the type of this data object. This can never be null.
      Specified by:
      getDataType in interface ILcdDataObject
      Returns:
      the type of this data object

    • getValue

      public Object getValue(TLcdDataProperty aProperty)
      Description copied from interface: ILcdDataObject

      Returns the value of the given property.

      If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).

      The property must not be null, and must be declared in the data object's type or in one of its super types. Otherwise an IllegalArgumentException is thrown.

      Specified by:
      getValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which the value is to be returned
      Returns:
      the value of the given property for this data object

    • getValue

      public Object getValue(String aPropertyName)
      Description copied from interface: ILcdDataObject

      Convenience method that returns the value of the property with the given name.

      If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

      See ILcdDataObject.getValue(TLcdDataProperty) for more information.

      Specified by:
      getValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be returned
      Returns:
      the value of the property with the given name
      See Also:

    • setValue

      public void setValue(TLcdDataProperty aProperty, Object aValue)
      Description copied from interface: ILcdDataObject

      Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

      The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

      Specified by:
      setValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which the value is to be set
      aValue - the value to set
      See Also:

    • setValue

      public void setValue(String aPropertyName, Object aValue)
      Description copied from interface: ILcdDataObject

      Convenience method that sets the value of the property with the given name.

      If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

      See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.

      Specified by:
      setValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be set
      aValue - the value to set

    • hasValue

      public boolean hasValue(TLcdDataProperty aProperty)
      Description copied from interface: ILcdDataObject
      Indicates whether this data object has a value for the given property.

      • aProperty is from the right data type, and this instance has a value for it: returns true
      • aProperty is from the right data type, and this instance has no value for it: returns false
      • aProperty is not from the right data type: not allowed, you will get IllegalArgumentException
      • aProperty is null: not allowed, you will get NullPointerException

      A multivalued property is considered to have a value if it has at least one value.

      Specified by:
      hasValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which to return whether a value is present or not.
      Returns:
      true if this data object has a value for the given property, false otherwise.

    • hasValue

      public boolean hasValue(String aPropertyName)
      Description copied from interface: ILcdDataObject
      Indicates whether this data object has a value for the given property.
      See ILcdDataObject.hasValue(TLcdDataProperty) for more information.
      Specified by:
      hasValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property for which to return whether a value is present or not.
      Returns:
      true if this data object has a value for the property with the given name, false otherwise.