Package com.luciad.format.aixm51.model.features.procedure.procedureoverview

Class TLcdAIXM51AbstractSegmentLegTimeSlice

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.gml32.model.TLcdGML32AbstractGML
com.luciad.format.gml32.model.TLcdGML32AbstractTimeSlice
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMTimeSliceBase
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMTimeSlice
com.luciad.format.aixm51.model.features.procedure.procedureoverview.TLcdAIXM51AbstractSegmentLegTimeSlice
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdShape, ILcdShapeList, ILcdTimeBounded, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable
Direct Known Subclasses:
TLcdAIXM51AbstractApproachLegTimeSlice, TLcdAIXM51ArrivalLegTimeSlice, TLcdAIXM51DepartureLegTimeSlice
public class TLcdAIXM51AbstractSegmentLegTimeSlice extends TLcdAIXM51AbstractAIXMTimeSlice
An abstract class that represents a segment leg. This class does not have a corresponding TLcdDataType, but should be initialized with a time slice type that corresponds to a feature type that is an extension of TLcdAIXM51DataTypes.AbstractSegmentLegType.

The corresponding abstract time slice type does not exist because it is not defined in the AIXM 5.1 XML schema.

Since:
10.1
See Also:

  • Field Details

    • INTERPRETATION_PROPERTY

      public static final TLcdDataProperty INTERPRETATION_PROPERTY
      Data property that maps to the interpretation element. The possible values for this property are instances of ELcdAIXM51Interpretation.

    • SEQUENCE_NUMBER_PROPERTY

      public static final TLcdDataProperty SEQUENCE_NUMBER_PROPERTY
      Data property that maps to the sequenceNumber element. The possible values for this property are instances of long.

    • CORRECTION_NUMBER_PROPERTY

      public static final TLcdDataProperty CORRECTION_NUMBER_PROPERTY
      Data property that maps to the correctionNumber element. The possible values for this property are instances of long.

    • TIME_SLICE_METADATA_PROPERTY

      public static final TLcdDataProperty TIME_SLICE_METADATA_PROPERTY
      Data property that maps to the timeSliceMetadata element. The possible values for this property are instances of TLcdAIXM51FeatureTimeSliceMetadataProperty.

    • FEATURE_LIFETIME_PROPERTY

      public static final TLcdDataProperty FEATURE_LIFETIME_PROPERTY
      Data property that maps to the featureLifetime element. The possible values for this property are instances of TLcdGML32TimePrimitiveProperty.

  • Constructor Details

    • TLcdAIXM51AbstractSegmentLegTimeSlice

      public TLcdAIXM51AbstractSegmentLegTimeSlice(TLcdDataType aType)

  • Method Details

    • getEndConditionDesignator

      public TLcdAIXM51CodeSegmentTermination getEndConditionDesignator()
      Gets the value of the endConditionDesignator property.

      An indication of the event that allows identifying the end of the leg and the start of the next leg on the procedure. For example, reaching an altitude or outbound timing.

      Returns:
      the value of the endConditionDesignator property.
      See Also:

    • setEndConditionDesignator

      public void setEndConditionDesignator(TLcdAIXM51CodeSegmentTermination aValue)
      Sets the value of the endConditionDesignator property.

      An indication of the event that allows identifying the end of the leg and the start of the next leg on the procedure. For example, reaching an altitude or outbound timing.

      Parameters:
      aValue - the value to set for the endConditionDesignator property.

    • getLegPath

      public TLcdAIXM51CodeTrajectory getLegPath()
      Gets the value of the legPath property.

      A code defining a specific type of flight path such as arc, base turn outbound, base turn inbound, track, proc turn, hold in lieu.

      Returns:
      the value of the legPath property.
      See Also:

    • setLegPath

      public void setLegPath(TLcdAIXM51CodeTrajectory aValue)
      Sets the value of the legPath property.

      A code defining a specific type of flight path such as arc, base turn outbound, base turn inbound, track, proc turn, hold in lieu.

      Parameters:
      aValue - the value to set for the legPath property.

    • getLegTypeARINC

      public TLcdAIXM51CodeSegmentPath getLegTypeARINC()
      Gets the value of the legTypeARINC property.

      A comprehensive description of the 'path and terminator' concept is given in ARINC Specification 424, Attachment 5, Path and Terminator.

      Returns:
      the value of the legTypeARINC property.
      See Also:

    • setLegTypeARINC

      public void setLegTypeARINC(TLcdAIXM51CodeSegmentPath aValue)
      Sets the value of the legTypeARINC property.

      A comprehensive description of the 'path and terminator' concept is given in ARINC Specification 424, Attachment 5, Path and Terminator.

      Parameters:
      aValue - the value to set for the legTypeARINC property.

    • getCourse

      public Double getCourse()
      Gets the value of the course property.

      The value of the course angle in degrees.

      Returns:
      the value of the course property.
      See Also:

    • setCourse

      public void setCourse(Double aValue)
      Sets the value of the course property.

      The value of the course angle in degrees.

      Parameters:
      aValue - the value to set for the course property.

    • getCourseType

      public TLcdAIXM51CodeCourse getCourseType()
      Gets the value of the courseType property.

      A code indicating the type of course to be observed. E.g. true track, magnetic track, heading, VOR radial, true bearing, magnetic bearing.

      Returns:
      the value of the courseType property.
      See Also:

    • setCourseType

      public void setCourseType(TLcdAIXM51CodeCourse aValue)
      Sets the value of the courseType property.

      A code indicating the type of course to be observed. E.g. true track, magnetic track, heading, VOR radial, true bearing, magnetic bearing.

      Parameters:
      aValue - the value to set for the courseType property.

    • getCourseDirection

      public TLcdAIXM51CodeDirectionReference getCourseDirection()
      Gets the value of the courseDirection property.

      Indicates flight direction to/from the navaid providing the course guidance.

      Returns:
      the value of the courseDirection property.
      See Also:

    • setCourseDirection

      public void setCourseDirection(TLcdAIXM51CodeDirectionReference aValue)
      Sets the value of the courseDirection property.

      Indicates flight direction to/from the navaid providing the course guidance.

      Parameters:
      aValue - the value to set for the courseDirection property.

    • getTurnDirection

      public TLcdAIXM51CodeDirectionTurn getTurnDirection()
      Gets the value of the turnDirection property.

      A code indicating the direction of the turn.

      Returns:
      the value of the turnDirection property.
      See Also:

    • setTurnDirection

      public void setTurnDirection(TLcdAIXM51CodeDirectionTurn aValue)
      Sets the value of the turnDirection property.

      A code indicating the direction of the turn.

      Parameters:
      aValue - the value to set for the turnDirection property.

    • getSpeedLimit

      public TLcdAIXM51ValSpeed getSpeedLimit()
      Gets the value of the speedLimit property.

      The value of the speed limit on the procedure leg. Rules: As a plausibility rule, value should be equivalent to between 0 and 400, when expressed in Km/h.

      Returns:
      the value of the speedLimit property.

    • setSpeedLimit

      public void setSpeedLimit(TLcdAIXM51ValSpeed aValue)
      Sets the value of the speedLimit property.

      The value of the speed limit on the procedure leg. Rules: As a plausibility rule, value should be equivalent to between 0 and 400, when expressed in Km/h.

      Parameters:
      aValue - the value to set for the speedLimit property.

    • getSpeedReference

      public TLcdAIXM51CodeSpeedReference getSpeedReference()
      Gets the value of the speedReference property.

      A code indicating the reference system for a speed value.

      Returns:
      the value of the speedReference property.
      See Also:

    • setSpeedReference

      public void setSpeedReference(TLcdAIXM51CodeSpeedReference aValue)
      Sets the value of the speedReference property.

      A code indicating the reference system for a speed value.

      Parameters:
      aValue - the value to set for the speedReference property.

    • getSpeedInterpretation

      public TLcdAIXM51CodeAltitudeUse getSpeedInterpretation()
      Gets the value of the speedInterpretation property.

      A code indicating how the speed attributes of a procedure leg should be interpreted.

      Returns:
      the value of the speedInterpretation property.
      See Also:

    • setSpeedInterpretation

      public void setSpeedInterpretation(TLcdAIXM51CodeAltitudeUse aValue)
      Sets the value of the speedInterpretation property.

      A code indicating how the speed attributes of a procedure leg should be interpreted.

      Parameters:
      aValue - the value to set for the speedInterpretation property.

    • getBankAngle

      public Double getBankAngle()
      Gets the value of the bankAngle property.

      The recommended bank angle of the aircraft on the turn. Rules: As a plausibility rule, value should be between 5 and 35 degrees.

      Returns:
      the value of the bankAngle property.
      See Also:

    • setBankAngle

      public void setBankAngle(Double aValue)
      Sets the value of the bankAngle property.

      The recommended bank angle of the aircraft on the turn. Rules: As a plausibility rule, value should be between 5 and 35 degrees.

      Parameters:
      aValue - the value to set for the bankAngle property.

    • getLength

      public TLcdAIXM51ValDistance getLength()
      Gets the value of the length property.

      Length of the segment

      Returns:
      the value of the length property.

    • setLength

      public void setLength(TLcdAIXM51ValDistance aValue)
      Sets the value of the length property.

      Length of the segment

      Parameters:
      aValue - the value to set for the length property.

    • getDuration

      public TLcdAIXM51ValDuration getDuration()
      Gets the value of the duration property.

      Segment duration

      Returns:
      the value of the duration property.

    • setDuration

      public void setDuration(TLcdAIXM51ValDuration aValue)
      Sets the value of the duration property.

      Segment duration

      Parameters:
      aValue - the value to set for the duration property.

    • getProcedureTurnRequired

      public TLcdAIXM51CodeYesNo getProcedureTurnRequired()
      Gets the value of the procedureTurnRequired property.

      Indicates if a procedure turn is required at the end of the segmentleg. Default is No.

      Returns:
      the value of the procedureTurnRequired property.
      See Also:

    • setProcedureTurnRequired

      public void setProcedureTurnRequired(TLcdAIXM51CodeYesNo aValue)
      Sets the value of the procedureTurnRequired property.

      Indicates if a procedure turn is required at the end of the segmentleg. Default is No.

      Parameters:
      aValue - the value to set for the procedureTurnRequired property.

    • getUpperLimitAltitude

      public TLcdAIXM51ValDistanceVertical getUpperLimitAltitude()
      Gets the value of the upperLimitAltitude property.

      The value of the upper altitude used with codeDescrDistVer: At or below the higher altitude. Between the lower and the upper altitude.

      Returns:
      the value of the upperLimitAltitude property.

    • setUpperLimitAltitude

      public void setUpperLimitAltitude(TLcdAIXM51ValDistanceVertical aValue)
      Sets the value of the upperLimitAltitude property.

      The value of the upper altitude used with codeDescrDistVer: At or below the higher altitude. Between the lower and the upper altitude.

      Parameters:
      aValue - the value to set for the upperLimitAltitude property.

    • getUpperLimitReference

      public TLcdAIXM51CodeVerticalReference getUpperLimitReference()
      Gets the value of the upperLimitReference property.

      A code indicating the reference for a vertical distance. Two series of values exist: 1) real distance: from GND, from the MSL, from the WGS-84 ellipsoid 2) pressure distance: QFE, QNH, STD.

      Returns:
      the value of the upperLimitReference property.
      See Also:

    • setUpperLimitReference

      public void setUpperLimitReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the upperLimitReference property.

      A code indicating the reference for a vertical distance. Two series of values exist: 1) real distance: from GND, from the MSL, from the WGS-84 ellipsoid 2) pressure distance: QFE, QNH, STD.

      Parameters:
      aValue - the value to set for the upperLimitReference property.

    • getLowerLimitAltitude

      public TLcdAIXM51ValDistanceVertical getLowerLimitAltitude()
      Gets the value of the lowerLimitAltitude property.

      The lower limit altitude. used with codeDescrDistVer: At or above the lower altitude. At the lower altitude Between the lower and the upper altitude. Lower altitude is recommended. Expect lower altitude by ATC.

      Returns:
      the value of the lowerLimitAltitude property.

    • setLowerLimitAltitude

      public void setLowerLimitAltitude(TLcdAIXM51ValDistanceVertical aValue)
      Sets the value of the lowerLimitAltitude property.

      The lower limit altitude. used with codeDescrDistVer: At or above the lower altitude. At the lower altitude Between the lower and the upper altitude. Lower altitude is recommended. Expect lower altitude by ATC.

      Parameters:
      aValue - the value to set for the lowerLimitAltitude property.

    • getLowerLimitReference

      public TLcdAIXM51CodeVerticalReference getLowerLimitReference()
      Gets the value of the lowerLimitReference property.

      A code indicating the reference for a vertical distance. Two series of values exist: 1) real distance: from GND, from the MSL, from the WGS-84 ellipsoid 2) pressure distance: QFE, QNH, STD.

      Returns:
      the value of the lowerLimitReference property.
      See Also:

    • setLowerLimitReference

      public void setLowerLimitReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the lowerLimitReference property.

      A code indicating the reference for a vertical distance. Two series of values exist: 1) real distance: from GND, from the MSL, from the WGS-84 ellipsoid 2) pressure distance: QFE, QNH, STD.

      Parameters:
      aValue - the value to set for the lowerLimitReference property.

    • getAltitudeInterpretation

      public TLcdAIXM51CodeAltitudeUse getAltitudeInterpretation()
      Gets the value of the altitudeInterpretation property.

      A code indicating how the altitude attributes of a procedure leg should be interpreted.

      Returns:
      the value of the altitudeInterpretation property.
      See Also:

    • setAltitudeInterpretation

      public void setAltitudeInterpretation(TLcdAIXM51CodeAltitudeUse aValue)
      Sets the value of the altitudeInterpretation property.

      A code indicating how the altitude attributes of a procedure leg should be interpreted.

      Parameters:
      aValue - the value to set for the altitudeInterpretation property.

    • getAltitudeOverrideATC

      public TLcdAIXM51ValDistanceVertical getAltitudeOverrideATC()
      Gets the value of the altitudeOverrideATC property.

      Alternate altitude when directed by Air Traffic Control

      Returns:
      the value of the altitudeOverrideATC property.

    • setAltitudeOverrideATC

      public void setAltitudeOverrideATC(TLcdAIXM51ValDistanceVertical aValue)
      Sets the value of the altitudeOverrideATC property.

      Alternate altitude when directed by Air Traffic Control

      Parameters:
      aValue - the value to set for the altitudeOverrideATC property.

    • getAltitudeOverrideReference

      public TLcdAIXM51CodeVerticalReference getAltitudeOverrideReference()
      Gets the value of the altitudeOverrideReference property.

      A code indicating the reference for a vertical distance. Two series of values exist: 1) real distance: from GND, from the MSL, from the WGS-84 ellipsoid 2) pressure distance: QFE, QNH, STD.

      Returns:
      the value of the altitudeOverrideReference property.
      See Also:

    • setAltitudeOverrideReference

      public void setAltitudeOverrideReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of thealtitudeOverrideReference property.

      A code indicating the reference for a vertical distance. Two series of values exist: 1) real distance: from GND, from the MSL, from the WGS-84 ellipsoid 2) pressure distance: QFE, QNH, STD.

      Parameters:
      aValue - the value to set for the altitudeOverrideReference property.

    • getVerticalAngle

      public Double getVerticalAngle()
      Gets the value of the verticalAngle property.

      The value of the vertical climb angle of the aircraft on the procedure leg. A negative value means descent. Rules: As a plausibility rule, value should be between -10 and +50 degrees.

      Returns:
      the value of the verticalAngle property.
      See Also:

    • setVerticalAngle

      public void setVerticalAngle(Double aValue)
      Sets the value of the verticalAngle property.

      The value of the vertical climb angle of the aircraft on the procedure leg. A negative value means descent. Rules: As a plausibility rule, value should be between -10 and +50 degrees.

      Parameters:
      aValue - the value to set for the verticalAngle property.

    • getStartPoint

      public TLcdAIXM51TerminalSegmentPoint getStartPoint()
      Gets the value of the startPoint property.

      determines the starting point of the segment

      Returns:
      the value of the startPoint property.
      See Also:

    • setStartPoint

      public void setStartPoint(TLcdAIXM51TerminalSegmentPoint aValue)
      Sets the value of the startPoint property.

      determines the starting point of the segment

      Parameters:
      aValue - the value to set for the startPoint property.

    • getEndPoint

      public TLcdAIXM51TerminalSegmentPoint getEndPoint()
      Gets the value of the endPoint property.

      determines the ending point of the segment

      Returns:
      the value of the endPoint property.
      See Also:

    • setEndPoint

      public void setEndPoint(TLcdAIXM51TerminalSegmentPoint aValue)
      Sets the value of the endPoint property.

      determines the ending point of the segment

      Parameters:
      aValue - the value to set for the endPoint property.

    • getTrajectory

      public TLcdAIXM51Curve getTrajectory()
      Gets the value of the trajectory property.

      Segment Leg is depicted by the trajectory

      Returns:
      the value of the trajectory property.
      See Also:

    • setTrajectory

      public void setTrajectory(TLcdAIXM51Curve aValue)
      Sets the value of the trajectory property.

      Segment Leg is depicted by the trajectory

      Parameters:
      aValue - the value to set for the trajectory property.

    • getArcCentre

      public TLcdAIXM51TerminalSegmentPoint getArcCentre()
      Gets the value of thearcCentre property.

      An segment known as an Arc can be defined as a radius and distance around a center point.

      Returns:
      the value of the arcCentre property.
      See Also:

    • setArcCentre

      public void setArcCentre(TLcdAIXM51TerminalSegmentPoint aValue)
      Sets the value of the arcCentre property.

      An segment known as an Arc can be defined as a radius and distance around a center point.

      Parameters:
      aValue - the value to set for the arcCentre property.

    • getAngle

      public TLcdAIXM51Feature<TLcdAIXM51AngleIndicationTimeSlice> getAngle()
      Gets the value of the angle property.

      Aircraft trajectory must not cross the angle indication.

      Returns:
      the value of the angle property.
      See Also:

    • setAngle

      public void setAngle(TLcdAIXM51Feature<TLcdAIXM51AngleIndicationTimeSlice> aValue)
      Sets the value of the angle property.

      Aircraft trajectory must not cross the angle indication.

      Parameters:
      aValue - the value to set for the angle property.

    • getDistance

      public TLcdAIXM51Feature<TLcdAIXM51DistanceIndicationTimeSlice> getDistance()
      Gets the value of the distance property.

      Aircraft trajectory must not cross this distance indication.

      Returns:
      the value of the distance property.
      See Also:

    • setDistance

      public void setDistance(TLcdAIXM51Feature<TLcdAIXM51DistanceIndicationTimeSlice> aValue)
      Sets the value of the distance property.

      Aircraft trajectory must not cross this distance indication.

      Parameters:
      aValue - the value to set for the distance property.

    • getAircraftCategory

      public List<TLcdAIXM51AircraftCharacteristic> getAircraftCategory()
      Gets the value of the aircraftCategory property.

      A segment leg can be established for specific aircraft characteristics.

      Returns:
      the value of the aircraftCategory property.
      See Also:

    • getHolding

      public TLcdAIXM51HoldingUse getHolding()
      Gets the value of the holding property.

      The segment leg uses a holding pattern for arrival holding, missed approach holding or hold in lieu of procedure turn.

      Returns:
      the value of the holding property.
      See Also:

    • setHolding

      public void setHolding(TLcdAIXM51HoldingUse aValue)
      Sets the value of the holding property.

      The segment leg uses a holding pattern for arrival holding, missed approach holding or hold in lieu of procedure turn.

      Parameters:
      aValue - the value to set for the holding property.

    • getDesignSurface

      public List<TLcdAIXM51ObstacleAssessmentArea> getDesignSurface()
      Gets the value of the designSurface property.
      Returns:
      the value of the designSurface property.
      See Also:

    • getAnnotation

      public List<TLcdAIXM51Note> getAnnotation()
      Gets the value of the annotation property.
      Returns:
      the value of the annotation property.
      See Also:

    • getInterpretation

      public ELcdAIXM51Interpretation getInterpretation()
      Returns the value of the property that maps to the interpretation element.

      Property indicating how the timeslice is to be interpreted. See the AIXM Temporality model for details.

      Returns:
      the value of the INTERPRETATION_PROPERTY property.

    • setInterpretation

      public void setInterpretation(ELcdAIXM51Interpretation aValue)
      Sets the value of the property that maps to the interpretation element.

      Property indicating how the timeslice is to be interpreted. See the AIXM Temporality model for details.

      Parameters:
      aValue - the value to set for the INTERPRETATION_PROPERTY property.

    • getSequenceNumber

      public long getSequenceNumber()
      Returns the value of the property that maps to the sequenceNumber element.

      Used for the identification of the Time Slice concerned. See the AIXM Temporality model for details.

      Returns:
      the value of the SEQUENCE_NUMBER_PROPERTY property.

    • setSequenceNumber

      public void setSequenceNumber(long aValue)
      Sets the value of the property that maps to the sequenceNumber element.

      Used for the identification of the Time Slice concerned. See the AIXM Temporality model for details.

      Parameters:
      aValue - the value to set for the SEQUENCE_NUMBER_PROPERTY property.

    • getCorrectionNumber

      public long getCorrectionNumber()
      Returns the value of the property that maps to the correctionNumber element.

      Used for indicating the order of the corrections of a Time Slice. See the AIXM Temporality model for details.

      Returns:
      the value of the CORRECTION_NUMBER_PROPERTY property.

    • setCorrectionNumber

      public void setCorrectionNumber(long aValue)
      Sets the value of the property that maps to the correctionNumber element.

      Used for indicating the order of the corrections of a Time Slice. See the AIXM Temporality model for details.

      Parameters:
      aValue - the value to set for the CORRECTION_NUMBER_PROPERTY property.

    • getTimeSliceMetadata

      public TLcdAIXM51FeatureTimeSliceMetadataProperty getTimeSliceMetadata()
      Returns the value of the property that maps to the timeSliceMetadata element.
      Returns:
      the value of the TIME_SLICE_METADATA_PROPERTY property.

    • setTimeSliceMetadata

      public void setTimeSliceMetadata(TLcdAIXM51FeatureTimeSliceMetadataProperty aValue)
      Sets the value of the property that maps to the timeSliceMetadata element.
      Parameters:
      aValue - the value to set for the TIME_SLICE_METADATA_PROPERTY property.

    • getFeatureLifetime

      public TLcdGML32AbstractTimePrimitive getFeatureLifetime()
      Returns the value of the property that maps to the featureLifetime element.

      The start and end of life of the feature. See the AIXM Temporality model for details.

      Returns:
      the value of the FEATURE_LIFETIME_PROPERTY property.
      See Also:

    • setFeatureLifetime

      public void setFeatureLifetime(TLcdGML32AbstractTimePrimitive aValue)
      Sets the value of the property that maps to the featureLifetime element.

      The start and end of life of the feature. See the AIXM Temporality model for details.

      Parameters:
      aValue - the value to set for the FEATURE_LIFETIME_PROPERTY property.