public class TLcdProcedureLeg extends Object implements ILcdProcedureLeg, ILcdEditableProcedureLeg
ILcdEditableProcedureLeg
.Constructor and Description |
---|
TLcdProcedureLeg()
Deprecated.
|
TLcdProcedureLeg(String aLegType)
Deprecated.
|
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(TLcdProcedureLeg aLeg)
Copy constructor
|
Modifier and Type | Method and 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(String aPropertyName)
Convenience method that returns the value of the property with the given name.
|
Object |
getValue(TLcdDataProperty aProperty)
Returns the value of the given property.
|
boolean |
hasValue(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 |
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(String aPropertyName,
Object aValue)
Convenience method that sets the value of the property with the given name.
|
void |
setValue(TLcdDataProperty aProperty,
Object aValue)
Sets the value of the given property for this data object.
|
String |
toString() |
@Deprecated public TLcdProcedureLeg()
TLcdProcedureLeg(TLcdDataType)
public TLcdProcedureLeg(TLcdProcedureLeg aLeg)
aLeg
- The leg to copy@Deprecated public TLcdProcedureLeg(String aLegType)
TLcdProcedureLeg(TLcdDataType, String)
public TLcdProcedureLeg(TLcdDataType aDataType)
aDataType
- the data type of the returned instanceIllegalArgumentException
- if TLcdAISDataTypes.ProcedureLeg
is not assignable
from the given data typeTLcdAISDataTypes.ProcedureLeg
public TLcdProcedureLeg(TLcdDataType aDataType, String aLegType)
aDataType
- the data type of the returned instanceaLegType
- the type of ARINC leg to create.IllegalArgumentException
- if TLcdAISDataTypes.ProcedureLeg
is not assignable
from the given data typeTLcdAISDataTypes.ProcedureLeg
,
TLcdProcedureLegType
public TLcdDataType getDataType()
ILcdDataObject
null
.getDataType
in interface ILcdDataObject
public Object getValue(TLcdDataProperty aProperty)
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.
getValue
in interface ILcdDataObject
aProperty
- the property for which the value is to be returnedpublic Object getValue(String aPropertyName)
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). SeeILcdDataObject.getValue(TLcdDataProperty)
for more information.getValue
in interface ILcdDataObject
aPropertyName
- the name of the property of which the value is to be returnedTLcdDataType.getProperty(String)
public void setValue(TLcdDataProperty aProperty, Object aValue)
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 thedata 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
.setValue
in interface ILcdDataObject
aProperty
- the property for which the value is to be setaValue
- the value to setTLcdDataType.getProperty(String)
public void setValue(String aPropertyName, Object aValue)
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). SeeILcdDataObject.setValue(TLcdDataProperty, Object)
for more information.setValue
in interface ILcdDataObject
aPropertyName
- the name of the property of which the value is to be setaValue
- the value to setpublic boolean hasValue(TLcdDataProperty aProperty)
ILcdDataObject
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 IllegalArgumentExceptionaProperty
is null
: not allowed, you will get NullPointerExceptionhasValue
in interface ILcdDataObject
aProperty
- the property for which to return whether a value is present or not.true
if this data object has a value for the given property, false
otherwise.public boolean hasValue(String aPropertyName)
ILcdDataObject
ILcdDataObject.hasValue(TLcdDataProperty)
for more information.hasValue
in interface ILcdDataObject
aPropertyName
- the name of the property for which to return whether a value is present
or not.true
if this data object has a value for the property with the given name,
false
otherwise.public int getSequenceNumber()
getSequenceNumber
in interface ILcdProcedureLeg
public void setSequenceNumber(int aSequenceNumber)
ILcdEditableProcedureLeg
setSequenceNumber
in interface ILcdEditableProcedureLeg
public String getTransitionIdentifier()
ILcdProcedureLeg
getTransitionIdentifier
in interface ILcdProcedureLeg
public void setTransitionIdentifier(String aTransitionIdentifier)
ILcdEditableProcedureLeg
setTransitionIdentifier
in interface ILcdEditableProcedureLeg
aTransitionIdentifier
- the transition identifier of this leg.public TLcdProcedureLegRouteType getRouteType()
ILcdProcedureLeg
getRouteType
in interface ILcdProcedureLeg
public void setRouteType(TLcdProcedureLegRouteType aRouteType)
ILcdEditableProcedureLeg
setRouteType
in interface ILcdEditableProcedureLeg
public TLcdProcedureLegType getType()
getType
in interface ILcdProcedureLeg
public void setType(TLcdProcedureLegType aType)
ILcdEditableProcedureLeg
setType
in interface ILcdEditableProcedureLeg
public ILcdPoint getFix()
getFix
in interface ILcdProcedureLeg
public void setFix(ILcdPoint aFix)
ILcdEditableProcedureLeg
setFix
in interface ILcdEditableProcedureLeg
public TLcdProcedureLegFixOverflyType getFixOverflyType()
ILcdProcedureLeg
getFixOverflyType
in interface ILcdProcedureLeg
public void setFixOverflyType(TLcdProcedureLegFixOverflyType aFixOverflyType)
ILcdEditableProcedureLeg
setFixOverflyType
in interface ILcdEditableProcedureLeg
public TLcdProcedureLegTurnDirectionType getTurnDirectionType()
ILcdProcedureLeg
getTurnDirectionType
in interface ILcdProcedureLeg
public void setTurnDirectionType(TLcdProcedureLegTurnDirectionType aTurnDirectionType)
ILcdEditableProcedureLeg
setTurnDirectionType
in interface ILcdEditableProcedureLeg
public ILcdPoint getArcCentreFix()
ILcdProcedureLeg
getArcCentreFix
in interface ILcdProcedureLeg
public void setArcCentreFix(ILcdPoint aArcCentreFix)
ILcdEditableProcedureLeg
setArcCentreFix
in interface ILcdEditableProcedureLeg
public ILcdPoint getRecommendedNavaid()
ILcdProcedureLeg
getRecommendedNavaid
in interface ILcdProcedureLeg
public void setRecommendedNavaid(ILcdPoint aRecommendedNavaid)
ILcdEditableProcedureLeg
setRecommendedNavaid
in interface ILcdEditableProcedureLeg
public double getRho()
ILcdProcedureLeg
getRho
in interface ILcdProcedureLeg
public void setRho(double aRho)
ILcdEditableProcedureLeg
setRho
in interface ILcdEditableProcedureLeg
public double getTheta()
ILcdProcedureLeg
getTheta
in interface ILcdProcedureLeg
public void setTheta(double aTheta)
ILcdEditableProcedureLeg
setTheta
in interface ILcdEditableProcedureLeg
aTheta
- a radial in degrees.public double getCourse()
ILcdProcedureLeg
getCourse
in interface ILcdProcedureLeg
public void setCourse(double aCourse)
ILcdEditableProcedureLeg
setCourse
in interface ILcdEditableProcedureLeg
aCourse
- a course in degrees.public double getDistance()
ILcdProcedureLeg
getDistance
in interface ILcdProcedureLeg
public void setDistance(double aDistance)
ILcdEditableProcedureLeg
setDistance
in interface ILcdEditableProcedureLeg
aDistance
- a distance in meters.public double getDuration()
ILcdProcedureLeg
getDuration
in interface ILcdProcedureLeg
public void setDuration(double aDuration)
ILcdEditableProcedureLeg
setDuration
in interface ILcdEditableProcedureLeg
aDuration
- a duration in seconds.public TLcdProcedureLegAltitudeDescription getAltitudeDescription()
ILcdProcedureLeg
getAltitudeDescription
in interface ILcdProcedureLeg
public void setAltitudeDescription(TLcdProcedureLegAltitudeDescription aAltitudeDescription)
ILcdEditableProcedureLeg
setAltitudeDescription
in interface ILcdEditableProcedureLeg
public double getAltitudeUpper()
ILcdProcedureLeg
getAltitudeDescription()
getAltitudeUpper
in interface ILcdProcedureLeg
public void setAltitudeUpper(double aAltitudeUpper)
ILcdEditableProcedureLeg
setAltitudeUpper
in interface ILcdEditableProcedureLeg
aAltitudeUpper
- an altitude in meters.public double getAltitudeLower()
ILcdProcedureLeg
getAltitudeDescription()
getAltitudeLower
in interface ILcdProcedureLeg
public void setAltitudeLower(double aAltitudeLower)
ILcdEditableProcedureLeg
setAltitudeLower
in interface ILcdEditableProcedureLeg
aAltitudeLower
- an altitude in meters.public ILcdISO19103Measure getOriginalAltitudeUpper()
ILcdProcedureLeg
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.
getOriginalAltitudeUpper
in interface ILcdProcedureLeg
ILcdISO19103Measure
which contains the value and unit of measurepublic void setOriginalAltitudeUpper(ILcdISO19103Measure aOriginalAltitudeUpper)
ILcdEditableProcedureLeg
setOriginalAltitudeUpper
in interface ILcdEditableProcedureLeg
aOriginalAltitudeUpper
- a ILcdISO19103Measure
which contains the value and unit of measure of the altitudepublic ILcdISO19103Measure getOriginalAltitudeLower()
ILcdProcedureLeg
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.
getOriginalAltitudeLower
in interface ILcdProcedureLeg
ILcdISO19103Measure
which contains the value and unit of measurepublic void setOriginalAltitudeLower(ILcdISO19103Measure aOriginalAltitudeLower)
ILcdEditableProcedureLeg
setOriginalAltitudeLower
in interface ILcdEditableProcedureLeg
aOriginalAltitudeLower
- a ILcdISO19103Measure
which contains the value and unit of measure of the altitudepublic TLcdProcedureLegIAPFixRole getIAPFixRole()
ILcdProcedureLeg
getIAPFixRole
in interface ILcdProcedureLeg
public void setIAPFixRole(TLcdProcedureLegIAPFixRole aIAPFixRole)
ILcdEditableProcedureLeg
setIAPFixRole
in interface ILcdEditableProcedureLeg