Package com.luciad.ais.model.procedure

Class TLcdProcedureLeg

java.lang.Object

com.luciad.ais.model.procedure.TLcdProcedureLeg

All Implemented Interfaces:

ILcdEditableProcedureLeg, ILcdProcedureLeg, ILcdDataObject

Direct Known Subclasses:

TLcdFeaturedProcedureLeg

public class TLcdProcedureLeg
extends Object
implements ILcdProcedureLeg, ILcdEditableProcedureLeg

An implementation of ILcdEditableProcedureLeg.

Constructor Summary

Constructors

Constructor	Description
TLcdProcedureLeg()	Deprecated. Use TLcdProcedureLeg(TLcdDataType)
TLcdProcedureLeg(TLcdProcedureLeg aLeg)	Copy constructor
TLcdProcedureLeg(TLcdDataType aDataType)	Creates a new instance for the given type.
TLcdProcedureLeg(TLcdDataType aDataType, String aLegType)	Creates a new instance for the given type and leg type.
TLcdProcedureLeg(String aLegType)	Deprecated. Use TLcdProcedureLeg(TLcdDataType, String)

Method Summary

Modifier and Type	Method	Description
TLcdProcedureLegAltitudeDescription	getAltitudeDescription()	Specifies how the upper and lower altitudes of this leg are to be interpreted.
double	getAltitudeLower()	Specifies the minimal altitude to be flown during this leg.
double	getAltitudeUpper()	Specifies the maximal altitude to be flown during this leg.
ILcdPoint	getArcCentreFix()	For RF legs only, returns the center of the turn arc.
double	getCourse()	The course to be flown during this leg, if applicable.
TLcdDataType	getDataType()	Returns the type of this data object.
double	getDistance()	Specifies the distance for which this leg is to be flown, if applicable.
double	getDuration()	Specifies the amount of time this leg is to be flown, if applicable.
ILcdPoint	getFix()
TLcdProcedureLegFixOverflyType	getFixOverflyType()	Specifies whether the this procedure leg ends with a fly-over or a fly-by.
TLcdProcedureLegIAPFixRole	getIAPFixRole()	Returns the role of a fix in initial approach procedures (IAP).
ILcdISO19103Measure	getOriginalAltitudeLower()	Specifies the minimal altitude to be flown during this leg.
ILcdISO19103Measure	getOriginalAltitudeUpper()	Specifies the maximal altitude to be flown during this leg.
ILcdPoint	getRecommendedNavaid()	An auxiliary navaid for AF, CD, CR legs.
double	getRho()	The distance between the leg terminator and the recommended navaid.
TLcdProcedureLegRouteType	getRouteType()	Returns the route type of this leg (e.g. in transition, common route, out transition, ...).
int	getSequenceNumber()
double	getTheta()	The radial from the recommended navaid to the leg terminator, for AF and CR leg types.
String	getTransitionIdentifier()	Returns the transition identifier of this leg.
TLcdProcedureLegTurnDirectionType	getTurnDirectionType()	Specifies the direction in which the aircraft must turn while flying this procedure leg.
TLcdProcedureLegType	getType()
Object	getValue(TLcdDataProperty aProperty)	Returns the value of the given property.
Object	getValue(String aPropertyName)	Convenience method that returns the value of the property with the given name.
boolean	hasValue(TLcdDataProperty aProperty)	Indicates whether this data object has a value for the given property.
boolean	hasValue(String aPropertyName)	Indicates whether this data object has a value for the given property.
void	setAltitudeDescription(TLcdProcedureLegAltitudeDescription aAltitudeDescription)	Sets the altitude description of this leg.
void	setAltitudeLower(double aAltitudeLower)	Sets the minimal altitude for this leg.
void	setAltitudeUpper(double aAltitudeUpper)	Sets the maximal altitude for this leg.
void	setArcCentreFix(ILcdPoint aArcCentreFix)	For RF legs, sets the center point of the turn arc.
void	setCourse(double aCourse)	Sets the course to be flown during this leg, if applicable.
void	setDistance(double aDistance)	Sets the distance for which this leg should be flown, if applicable.
void	setDuration(double aDuration)	Sets the amount of time for which this leg should be flown, if applicable.
void	setFix(ILcdPoint aFix)	Sets the fix associated with this leg.
void	setFixOverflyType(TLcdProcedureLegFixOverflyType aFixOverflyType)	Sets whether this leg should end with a fly-over or a fly-by.
void	setIAPFixRole(TLcdProcedureLegIAPFixRole aIAPFixRole)	Sets the role of a fix in initial approach procedures (IAP).
void	setOriginalAltitudeLower(ILcdISO19103Measure aOriginalAltitudeLower)	Sets the minimal altitude for this leg.
void	setOriginalAltitudeUpper(ILcdISO19103Measure aOriginalAltitudeUpper)	Sets the maximal altitude for this leg.
void	setRecommendedNavaid(ILcdPoint aRecommendedNavaid)	Sets the secondary navaid for AF, CD, CR legs.
void	setRho(double aRho)	(Not used)
void	setRouteType(TLcdProcedureLegRouteType aRouteType)	Sets the route type of this leg (e.g. in transition, common route, ...).
void	setSequenceNumber(int aSequenceNumber)	Sets the sequence number of this leg.
void	setTheta(double aTheta)	Sets the radial from the recommended navaid to the leg terminator.
void	setTransitionIdentifier(String aTransitionIdentifier)	Sets the transition identifier of this leg.
void	setTurnDirectionType(TLcdProcedureLegTurnDirectionType aTurnDirectionType)	Sets the direction in which the aircraft should turn when flying this leg.
void	setType(TLcdProcedureLegType aType)	Sets the type of this leg.
void	setValue(TLcdDataProperty aProperty, Object aValue)	Sets the value of the given property for this data object.
void	setValue(String aPropertyName, Object aValue)	Convenience method that sets the value of the property with the given name.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

TLcdProcedureLeg

@Deprecated
public TLcdProcedureLeg()

Deprecated.

Use TLcdProcedureLeg(TLcdDataType)

TLcdProcedureLeg

public TLcdProcedureLeg(TLcdProcedureLeg aLeg)

Copy constructor

Parameters:

aLeg - The leg to copy

TLcdProcedureLeg

@Deprecated
public TLcdProcedureLeg(String aLegType)

Deprecated.

Use TLcdProcedureLeg(TLcdDataType, String)

TLcdProcedureLeg

public TLcdProcedureLeg(TLcdDataType aDataType)

Creates a new instance for the given type.

Parameters:

aDataType - the data type of the returned instance

Throws:

IllegalArgumentException - if TLcdAISDataTypes.ProcedureLeg is not assignable from the given data type

Since:

10.1

See Also:

• TLcdAISDataTypes.ProcedureLeg

TLcdProcedureLeg

public TLcdProcedureLeg(TLcdDataType aDataType,
 String aLegType)

Creates a new instance for the given type and leg type.

Parameters:

aDataType - the data type of the returned instance

aLegType - the type of ARINC leg to create.

Throws:

IllegalArgumentException - if TLcdAISDataTypes.ProcedureLeg is not assignable from the given data type

Since:

10.1

See Also:

• TLcdAISDataTypes.ProcedureLeg
• TLcdProcedureLegType

Method Details

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:

• TLcdDataType.getProperty(String)

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:

• TLcdDataType.getProperty(String)

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.

getSequenceNumber

public int getSequenceNumber()

Specified by:

getSequenceNumber in interface ILcdProcedureLeg

Returns:

The sequence number of this leg.

setSequenceNumber

public void setSequenceNumber(int aSequenceNumber)

Description copied from interface: ILcdEditableProcedureLeg

Sets the sequence number of this leg.

Specified by:

setSequenceNumber in interface ILcdEditableProcedureLeg

Parameters:

aSequenceNumber -

getTransitionIdentifier

public String getTransitionIdentifier()

Description copied from interface: ILcdProcedureLeg

Returns the transition identifier of this leg.

Specified by:

getTransitionIdentifier in interface ILcdProcedureLeg

Returns:

the transition identifier of this leg.

setTransitionIdentifier

public void setTransitionIdentifier(String aTransitionIdentifier)

Description copied from interface: ILcdEditableProcedureLeg

Sets the transition identifier of this leg.

Specified by:

setTransitionIdentifier in interface ILcdEditableProcedureLeg

Parameters:

aTransitionIdentifier - the transition identifier of this leg.

getRouteType

public TLcdProcedureLegRouteType getRouteType()

Description copied from interface: ILcdProcedureLeg

Returns the route type of this leg (e.g. in transition, common route, out transition, ...).

Specified by:

getRouteType in interface ILcdProcedureLeg

setRouteType

public void setRouteType(TLcdProcedureLegRouteType aRouteType)

Description copied from interface: ILcdEditableProcedureLeg

Sets the route type of this leg (e.g. in transition, common route, ...).

Specified by:

setRouteType in interface ILcdEditableProcedureLeg

Parameters:

aRouteType -

getType

public TLcdProcedureLegType getType()

Specified by:

getType in interface ILcdProcedureLeg

Returns:

Returns the type of this leg.

setType

public void setType(TLcdProcedureLegType aType)

Description copied from interface: ILcdEditableProcedureLeg

Sets the type of this leg.

Specified by:

setType in interface ILcdEditableProcedureLeg

Parameters:

aType -

getFix

public ILcdPoint getFix()

Specified by:

getFix in interface ILcdProcedureLeg

Returns:

The fix associated with this leg.

setFix

public void setFix(ILcdPoint aFix)

Description copied from interface: ILcdEditableProcedureLeg

Sets the fix associated with this leg.

Specified by:

setFix in interface ILcdEditableProcedureLeg

Parameters:

aFix -

getFixOverflyType

public TLcdProcedureLegFixOverflyType getFixOverflyType()

Description copied from interface: ILcdProcedureLeg

Specifies whether the this procedure leg ends with a fly-over or a fly-by.

Specified by:

getFixOverflyType in interface ILcdProcedureLeg

setFixOverflyType

public void setFixOverflyType(TLcdProcedureLegFixOverflyType aFixOverflyType)

Description copied from interface: ILcdEditableProcedureLeg

Sets whether this leg should end with a fly-over or a fly-by.

Specified by:

setFixOverflyType in interface ILcdEditableProcedureLeg

Parameters:

aFixOverflyType -

getTurnDirectionType

public TLcdProcedureLegTurnDirectionType getTurnDirectionType()

Description copied from interface: ILcdProcedureLeg

Specifies the direction in which the aircraft must turn while flying this procedure leg.

Specified by:

getTurnDirectionType in interface ILcdProcedureLeg

setTurnDirectionType

public void setTurnDirectionType(TLcdProcedureLegTurnDirectionType aTurnDirectionType)

Description copied from interface: ILcdEditableProcedureLeg

Sets the direction in which the aircraft should turn when flying this leg.

Specified by:

setTurnDirectionType in interface ILcdEditableProcedureLeg

Parameters:

aTurnDirectionType -

getArcCentreFix

public ILcdPoint getArcCentreFix()

Description copied from interface: ILcdProcedureLeg

For RF legs only, returns the center of the turn arc.

Specified by:

getArcCentreFix in interface ILcdProcedureLeg

setArcCentreFix

public void setArcCentreFix(ILcdPoint aArcCentreFix)

Description copied from interface: ILcdEditableProcedureLeg

For RF legs, sets the center point of the turn arc.

Specified by:

setArcCentreFix in interface ILcdEditableProcedureLeg

Parameters:

aArcCentreFix -

getRecommendedNavaid

public ILcdPoint getRecommendedNavaid()

Description copied from interface: ILcdProcedureLeg

An auxiliary navaid for AF, CD, CR legs.

Specified by:

getRecommendedNavaid in interface ILcdProcedureLeg

setRecommendedNavaid

public void setRecommendedNavaid(ILcdPoint aRecommendedNavaid)

Description copied from interface: ILcdEditableProcedureLeg

Sets the secondary navaid for AF, CD, CR legs.

Specified by:

setRecommendedNavaid in interface ILcdEditableProcedureLeg

Parameters:

aRecommendedNavaid -

getRho

public double getRho()

Description copied from interface: ILcdProcedureLeg

The distance between the leg terminator and the recommended navaid. (Not used).

Specified by:

getRho in interface ILcdProcedureLeg

Returns:

a distance in meters.

setRho

public void setRho(double aRho)

Description copied from interface: ILcdEditableProcedureLeg

(Not used)

Specified by:

setRho in interface ILcdEditableProcedureLeg

Parameters:

aRho -

getTheta

public double getTheta()

Description copied from interface: ILcdProcedureLeg

The radial from the recommended navaid to the leg terminator, for AF and CR leg types. The radial must be a true bearing, not a magnetic one.

Specified by:

getTheta in interface ILcdProcedureLeg

Returns:

a radial in degrees.

setTheta

public void setTheta(double aTheta)

Description copied from interface: ILcdEditableProcedureLeg

Sets the radial from the recommended navaid to the leg terminator. The radial must be a true bearing, not a magnetic one.

Specified by:

setTheta in interface ILcdEditableProcedureLeg

Parameters:

aTheta - a radial in degrees.

getCourse

public double getCourse()

Description copied from interface: ILcdProcedureLeg

The course to be flown during this leg, if applicable. The course must be a true bearing, not a magnetic one.

Specified by:

getCourse in interface ILcdProcedureLeg

Returns:

a course in degrees.

setCourse

public void setCourse(double aCourse)

Description copied from interface: ILcdEditableProcedureLeg

Sets the course to be flown during this leg, if applicable. The course must be a true bearing, not a magnetic one.

Specified by:

setCourse in interface ILcdEditableProcedureLeg

Parameters:

aCourse - a course in degrees.

getDistance

public double getDistance()

Description copied from interface: ILcdProcedureLeg

Specifies the distance for which this leg is to be flown, if applicable.

Specified by:

getDistance in interface ILcdProcedureLeg

Returns:

a distance in meters.

setDistance

public void setDistance(double aDistance)

Description copied from interface: ILcdEditableProcedureLeg

Sets the distance for which this leg should be flown, if applicable.

Specified by:

setDistance in interface ILcdEditableProcedureLeg

Parameters:

aDistance - a distance in meters.

getDuration

public double getDuration()

Description copied from interface: ILcdProcedureLeg

Specifies the amount of time this leg is to be flown, if applicable.

Specified by:

getDuration in interface ILcdProcedureLeg

Returns:

a duration in seconds.

setDuration

public void setDuration(double aDuration)

Description copied from interface: ILcdEditableProcedureLeg

Sets the amount of time for which this leg should be flown, if applicable.

Specified by:

setDuration in interface ILcdEditableProcedureLeg

Parameters:

aDuration - a duration in seconds.

getAltitudeDescription

public TLcdProcedureLegAltitudeDescription getAltitudeDescription()

Description copied from interface: ILcdProcedureLeg

Specifies how the upper and lower altitudes of this leg are to be interpreted.

Specified by:

getAltitudeDescription in interface ILcdProcedureLeg

setAltitudeDescription

public void setAltitudeDescription(TLcdProcedureLegAltitudeDescription aAltitudeDescription)

Description copied from interface: ILcdEditableProcedureLeg

Sets the altitude description of this leg.

Specified by:

setAltitudeDescription in interface ILcdEditableProcedureLeg

Parameters:

aAltitudeDescription -

getAltitudeUpper

public double getAltitudeUpper()

Description copied from interface: ILcdProcedureLeg

Specifies the maximal altitude to be flown during this leg. The actual altitude that will be calculated depends on the return value of getAltitudeDescription()

Specified by:

getAltitudeUpper in interface ILcdProcedureLeg

Returns:

an altitude in meters.

setAltitudeUpper

public void setAltitudeUpper(double aAltitudeUpper)

Description copied from interface: ILcdEditableProcedureLeg

Sets the maximal altitude for this leg.

Specified by:

setAltitudeUpper in interface ILcdEditableProcedureLeg

Parameters:

aAltitudeUpper - an altitude in meters.

getAltitudeLower

public double getAltitudeLower()

Description copied from interface: ILcdProcedureLeg

Specifies the minimal altitude to be flown during this leg. The actual altitude that will be calculated depends on the return value of getAltitudeDescription()

Specified by:

getAltitudeLower in interface ILcdProcedureLeg

Returns:

an altitude in meters.

setAltitudeLower

public void setAltitudeLower(double aAltitudeLower)

Description copied from interface: ILcdEditableProcedureLeg

Sets the minimal altitude for this leg.

Specified by:

setAltitudeLower in interface ILcdEditableProcedureLeg

Parameters:

aAltitudeLower - an altitude in meters.

getOriginalAltitudeUpper

public ILcdISO19103Measure getOriginalAltitudeUpper()

Description copied from interface: ILcdProcedureLeg

Specifies the maximal altitude to be flown during this leg. The actual altitude that will be calculated depends on the return value of getAltitudeDescription().

This method is similar to ILcdProcedureLeg.getAltitudeUpper(), since they both return the upper altitude. The difference is that ILcdProcedureLeg.getAltitudeUpper() always returns the altitude in meters, while this method returns the value and unit of measure of the altitude as it was stored in the source file.

Specified by:

getOriginalAltitudeUpper in interface ILcdProcedureLeg

Returns:

a ILcdISO19103Measure which contains the value and unit of measure

setOriginalAltitudeUpper

public void setOriginalAltitudeUpper(ILcdISO19103Measure aOriginalAltitudeUpper)

Description copied from interface: ILcdEditableProcedureLeg

Sets the maximal altitude for this leg.

Specified by:

setOriginalAltitudeUpper in interface ILcdEditableProcedureLeg

Parameters:

aOriginalAltitudeUpper - a ILcdISO19103Measure which contains the value and unit of measure of the altitude

getOriginalAltitudeLower

public ILcdISO19103Measure getOriginalAltitudeLower()

Description copied from interface: ILcdProcedureLeg

Specifies the minimal altitude to be flown during this leg. The actual altitude that will be calculated depends on the return value of getAltitudeDescription().

This method is similar to ILcdProcedureLeg.getAltitudeLower(), since they both return the lower altitude. The difference is that ILcdProcedureLeg.getAltitudeLower() always returns the altitude in meters, while this method returns the value and unit of measure of the altitude as it was stored in the source file.

Specified by:

getOriginalAltitudeLower in interface ILcdProcedureLeg

Returns:

a ILcdISO19103Measure which contains the value and unit of measure

setOriginalAltitudeLower

public void setOriginalAltitudeLower(ILcdISO19103Measure aOriginalAltitudeLower)

Description copied from interface: ILcdEditableProcedureLeg

Sets the minimal altitude for this leg.

Specified by:

setOriginalAltitudeLower in interface ILcdEditableProcedureLeg

Parameters:

aOriginalAltitudeLower - a ILcdISO19103Measure which contains the value and unit of measure of the altitude

getIAPFixRole

public TLcdProcedureLegIAPFixRole getIAPFixRole()

Description copied from interface: ILcdProcedureLeg

Returns the role of a fix in initial approach procedures (IAP).

Specified by:

getIAPFixRole in interface ILcdProcedureLeg

Returns:

the IAP fix role, which will be null in SID en STAR procedures, and can also be null in IAPs.

setIAPFixRole

public void setIAPFixRole(TLcdProcedureLegIAPFixRole aIAPFixRole)

Description copied from interface: ILcdEditableProcedureLeg

Sets the role of a fix in initial approach procedures (IAP).

Specified by:

setIAPFixRole in interface ILcdEditableProcedureLeg

Parameters:

aIAPFixRole -

toString

public String toString()

Overrides:

toString in class Object