All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdAIXM51HoldingUse extends TLcdAIXM51AbstractAIXMObject
Describes how the holding pattern is used on a segment.
Since:
10.0
  • Field Details

    • HOLDING_USE_PROPERTY

      public static final TLcdDataProperty HOLDING_USE_PROPERTY
      Data property that maps to the holdingUse element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeHoldingUse>.
    • INSTRUCTION_PROPERTY

      public static final TLcdDataProperty INSTRUCTION_PROPERTY
      Data property that maps to the instruction element. The possible values for this property are instances of TLcdAIXM51Optional<String>.
    • INSTRUCTED_ALTITUDE_PROPERTY

      public static final TLcdDataProperty INSTRUCTED_ALTITUDE_PROPERTY
      Data property that maps to the instructedAltitude element. The possible values for this property are instances of TLcdAIXM51ValDistanceVertical.
    • INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY

      public static final TLcdDataProperty INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY
      Data property that maps to the instructionAltitudeReference element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeVerticalReference>.
    • ANNOTATION_PROPERTY

      public static final TLcdDataProperty ANNOTATION_PROPERTY
      Data property that maps to the annotation element. The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51Note>>.
    • THE_HOLDING_PATTERN_PROPERTY

      public static final TLcdDataProperty THE_HOLDING_PATTERN_PROPERTY
      Data property that maps to the theHoldingPattern element. The possible values for this property are instances of TLcdAIXM51FeatureAssociation<TLcdAIXM51HoldingPatternTimeSlice>.
    • EXTENSION_PROPERTY

      public static final TLcdDataProperty EXTENSION_PROPERTY
      Data property that maps to the extension element. The possible values for this property are instances of List<TLcdAIXM51Link<TLcdAIXM51AbstractExtension>>.
  • Constructor Details

    • TLcdAIXM51HoldingUse

      public TLcdAIXM51HoldingUse()
    • TLcdAIXM51HoldingUse

      public TLcdAIXM51HoldingUse(TLcdDataType aType)
  • Method Details

    • getHoldingUse

      public TLcdAIXM51CodeHoldingUse getHoldingUse()
      Returns the role value contained in the value of the HOLDING_USE_PROPERTY property. Returns null if the value of the HOLDING_USE_PROPERTY property is null.

      Indicates how the holding is used on the approach segment.

      Returns:
      the role value of the HOLDING_USE_PROPERTY property.
      See Also:
    • setHoldingUse

      public void setHoldingUse(TLcdAIXM51CodeHoldingUse aValue)
      Sets the value of the property that maps to the holdingUse element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the HOLDING_USE_PROPERTY property is set to null.

      Indicates how the holding is used on the approach segment.

      Parameters:
      aValue - the role value to set for the HOLDING_USE_PROPERTY property.
    • getInstruction

      public String getInstruction()
      Returns the role value contained in the value of the INSTRUCTION_PROPERTY property. Returns null if the value of the INSTRUCTION_PROPERTY property is null.

      Operational instructions concerning the use of the Holding Pattern in relation with a Procedure.

      Returns:
      the role value of the INSTRUCTION_PROPERTY property.
      See Also:
    • setInstruction

      public void setInstruction(String aValue)
      Sets the value of the property that maps to the instruction element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the INSTRUCTION_PROPERTY property is set to null.

      Operational instructions concerning the use of the Holding Pattern in relation with a Procedure.

      Parameters:
      aValue - the role value to set for the INSTRUCTION_PROPERTY property.
    • getInstructedAltitude

      public TLcdAIXM51ValDistanceVertical getInstructedAltitude()
      Returns the value of the property that maps to the instructedAltitude element.

      An altitude referenced in the holding use instructions.

      Returns:
      the value of the INSTRUCTED_ALTITUDE_PROPERTY property.
    • setInstructedAltitude

      public void setInstructedAltitude(TLcdAIXM51ValDistanceVertical aValue)
      Sets the value of the property that maps to the instructedAltitude element.

      An altitude referenced in the holding use instructions.

      Parameters:
      aValue - the value to set for the INSTRUCTED_ALTITUDE_PROPERTY property.
    • getInstructionAltitudeReference

      public TLcdAIXM51CodeVerticalReference getInstructionAltitudeReference()
      Returns the role value contained in the value of the INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY property. Returns null if the value of the INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY property is null.

      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 role value of the INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY property.
      See Also:
    • setInstructionAltitudeReference

      public void setInstructionAltitudeReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the property that maps to the instructionAltitudeReference element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY property is set to null.

      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 role value to set for the INSTRUCTION_ALTITUDE_REFERENCE_PROPERTY property.
    • getAnnotation

      public List<TLcdAIXM51Note> getAnnotation()
      Gets the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
      Returns:
      the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
      See Also:
    • getTheHoldingPattern

      public TLcdAIXM51Feature<TLcdAIXM51HoldingPatternTimeSlice> getTheHoldingPattern()
      Returns the role value contained in the value of the THE_HOLDING_PATTERN_PROPERTY property. Returns null if the value of the THE_HOLDING_PATTERN_PROPERTY property is null.

      Established holding used on a procedure.

      Returns:
      the role value of the THE_HOLDING_PATTERN_PROPERTY property.
      See Also:
    • setTheHoldingPattern

      public void setTheHoldingPattern(TLcdAIXM51Feature<TLcdAIXM51HoldingPatternTimeSlice> aValue)
      Sets the value of the property that maps to the theHoldingPattern element. to a new instance of the association class TLcdAIXM51FeatureAssociation initialized with the given role value. In case the given role value is null, the THE_HOLDING_PATTERN_PROPERTY property is set to null.

      Established holding used on a procedure.

      Parameters:
      aValue - the role value to set for the THE_HOLDING_PATTERN_PROPERTY property.
    • getExtension

      public List<TLcdAIXM51AbstractExtension> getExtension()
      Gets the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      Returns:
      the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      See Also: