com.luciad.ais.model.procedure

Aviation StandardsClass TLcdProcedureTrajectory

java.lang.Object

com.luciad.ais.model.procedure.TLcdProcedureTrajectory

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdPointList, ILcdPolyline, ILcdShape, ILcdCloneable, ILcdFeatured , ILcdInvalidateable, java.io.Serializable, java.lang.Cloneable

public class TLcdProcedureTrajectory
extends java.lang.Object
implements ILcdPolyline, 
ILcdFeatured
, ILcdDataObject, ILcdInvalidateable

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:

ILcdProcedure, TLcdAircraftPerformanceSettings, TLcdProcedureGeometryCalculator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdProcedureTrajectory(ILcdProcedure aProcedure, TLcdAircraftPerformanceSettings aAircraftPerformanceSettings, TLcdProcedureGeometryCalculator aGeometryCalculator) Constructs a TLcdProcedureTrajectory for the given procedure.

Method Summary

Modifier and Type	Method and Description
boolean	canSetFeature(int aIndex) Returns whether the feature at the given index of the associated ILcdProcedure can be set.
java.lang.Object	clone() Returns a clone of this TLcdProcedureTrajectory object.
boolean	contains2D(double aX, double aY) Returns false.
boolean	contains2D(ILcdPoint aPoint) Returns false.
boolean	contains3D(double aX, double aY, double aZ) Returns false.
boolean	contains3D(ILcdPoint aPoint) Returns false.
TLcdAircraftPerformanceSettings	getAircraftPerformanceSettings() Returns the aircraft performance settings used by this trajectory.
ILcdBounds	getBounds() Returns the bounds of this trajectory.
TLcdDataType	getDataType() Returns the type of this data object.
java.lang.Object	getFeature(int aIndex) Returns the feature at the given index of the associated ILcdProcedure, if it is of the type ILcdFeatured.
int	getFeatureCount() Returns the number of features of the associated ILcdProcedure, if it is of the type ILcdFeatured.
ILcdPoint	getFocusPoint() Returns the focus point of this ILcdShape.
ILcdPoint	getPoint(int aIndex) Returns the trajectory point at the given index.
int	getPointCount() Returns the number of points in this trajectory.
ILcdProcedure	getProcedure() Returns the ILcdProcedure associated with this trajectory.
TLcdProcedureGeometryCalculator	getProcedureGeometryCalculator() Returns the procedure geometry calculator used to calculate this trajectory.
java.lang.Object	getValue(java.lang.String aPropertyName) Convenience method that returns the value of the property with the given name.
java.lang.Object	getValue(TLcdDataProperty aProperty) Returns the value of the given property.
boolean	hasValue(java.lang.String aPropertyName) Indicates whether this data object has a value for the given property.
boolean	hasValue(TLcdDataProperty aProperty) Indicates whether this data object has a value for the given property.
void	invalidate() Discards the geometry cached with this trajectory and recalculates it from the source procedure.
void	invalidateObject() Delegates to invalidate().
void	processProcedureGeometry(ILcdProcedureGeometryHandler aHandler) Iterates over the procedure geometry using an ILcdProcedureGeometryHandler.
void	setAircraftPerformanceSettings(TLcdAircraftPerformanceSettings aPerformance) Sets the aircraft performance settings to be used by this trajectory and invokes the invalidate() method.
void	setFeature(int aIndex, java.lang.Object aObject) Sets the feature at the given index of the associated ILcdProcedure, if it is of the type ILcdFeatured.
void	setProcedureGeometryCalculator(TLcdProcedureGeometryCalculator aGeometryCalculator) Sets the procedure geometry calculator to be used to calculate this trajectory and invokes the invalidate() method.
void	setValue(java.lang.String aPropertyName, java.lang.Object aValue) Convenience method that sets the value of the property with the given name.
void	setValue(TLcdDataProperty aProperty, java.lang.Object aValue) Sets the value of the given property for this data object.
java.lang.String	toString() Returns the toString value of the associated ILcdProcedure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.shape.ILcdPointList

getPointSFCT, getX, getY, getZ

Constructor Detail

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 Detail

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:

invalidate()

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 java.lang.String toString()

Returns the toString value of the associated ILcdProcedure.

Overrides:

toString in class java.lang.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:

ILcdShape.contains2D(double, double)

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:

ILcdShape.contains3D(double, double, double)

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 java.lang.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 java.lang.Object

Returns:

a clone of this TLcdProcedureTrajectory object.

See Also:

Object.clone()

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 java.lang.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:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getPointCount()).

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 java.lang.Object getFeature(int aIndex)
                            throws java.lang.IndexOutOfBoundsException,
                                   java.lang.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:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getFeatureCount()).

java.lang.UnsupportedOperationException - if the associated ILcdProcedure is not of the type ILcdFeatured.

See Also:

ILcdFeatured.setFeature(int, java.lang.Object)

setFeature

public void setFeature(int aIndex,
                       java.lang.Object aObject)
                throws java.lang.IndexOutOfBoundsException,
                       java.lang.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:

java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= getFeatureCount()).

java.lang.UnsupportedOperationException - if the associated ILcdProcedure is not of the type ILcdFeatured.

See Also:

ILcdFeatured.getFeature(int), ILcdFeatured.canSetFeature(int)

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 java.lang.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 java.lang.Object getValue(java.lang.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:

TLcdDataType.getProperty(String)

setValue

public void setValue(TLcdDataProperty aProperty,
                     java.lang.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:

TLcdDataType.getProperty(String)

setValue

public void setValue(java.lang.String aPropertyName,
                     java.lang.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(java.lang.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.