Package com.luciad.format.aixm51.model.features.airspace

Class TLcdAIXM51AirspaceVolume

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.gml32.model.TLcdGML32AbstractGML
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMObject
com.luciad.format.aixm51.model.features.airspace.TLcdAIXM51AirspaceVolume
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdShape, ILcdEditableExtrudedShape, ILcdExtrudedShape, ILcdCloneable, ILcdDeepCloneable, Serializable, Cloneable
public class TLcdAIXM51AirspaceVolume extends TLcdAIXM51AbstractAIXMObject implements ILcdEditableExtrudedShape
Class representing an AIXM 5.1 airspace volume. The geometric information of the volume can be accessed through the ILcdExtrudedShape interface.
Since:
10.0
See Also:

  • Field Details

  • Constructor Details

    • TLcdAIXM51AirspaceVolume

      public TLcdAIXM51AirspaceVolume()
      Constructs a new instance of the TLcdAIXM51DataTypes.AirspaceVolumeType type.

    • TLcdAIXM51AirspaceVolume

      public TLcdAIXM51AirspaceVolume(TLcdDataType aType)
      Constructs a new instance for the given type. The type should be equal to or a subtype of of AirspaceVolume.
      Parameters:
      aType - the type for which to construct a new instance

  • Method Details

    • getBaseShape

      public ILcdShape getBaseShape()
      Returns the base shape of the extruded volume, which is the horizontal projection of the airspace volume.
      Specified by:
      getBaseShape in interface ILcdExtrudedShape
      Returns:
      base shape of the extruded shape.

    • 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
      Overrides:
      setValue in class TLcdDataObject
      Parameters:
      aProperty - the property for which the value is to be set
      aValue - the value to set
      See Also:

    • getMinimumZ

      public double getMinimumZ()
      Returns the minimum Z value of the extruded shape. This corresponds to the lower limit of the airspace volume.

      The value is converted to metres before being returned.

      Specified by:
      getMinimumZ in interface ILcdExtrudedShape
      Returns:
      The minimum Z value of the extruded shape in metres.

    • getMaximumZ

      public double getMaximumZ()
      Returns the maximum Z value of the extruded shape. This corresponds to the upper limit of the airspace volume.

      The value is converted to metres before being returned.

      Specified by:
      getMaximumZ in interface ILcdExtrudedShape
      Returns:
      The maximum Z value of the extruded shape in metres.

    • 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 aILcdPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aILcdPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains2D

      public boolean contains2D(double v, double v1)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      v - the x coordinate of the point.
      v1 - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • contains3D

      public boolean contains3D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      aZ - the z coordinate of the point.
      Returns:
      the boolean result of the containment test.

    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

      If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.

      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • setBaseShape

      public void setBaseShape(ILcdShape aBaseShape)
      Description copied from interface: ILcdEditableExtrudedShape
      Sets the base shape that is extruded.
      Specified by:
      setBaseShape in interface ILcdEditableExtrudedShape
      Parameters:
      aBaseShape - the base shape that is extruded.

    • setMinimumZ

      public void setMinimumZ(double aMinimumZ)
      Description copied from interface: ILcdEditableExtrudedShape
      Sets the minimum Z value.
      Specified by:
      setMinimumZ in interface ILcdEditableExtrudedShape
      Parameters:
      aMinimumZ - the minimum Z value.

    • setMaximumZ

      public void setMaximumZ(double aMaximumZ)
      Description copied from interface: ILcdEditableExtrudedShape
      Sets the maximum Z value.
      Specified by:
      setMaximumZ in interface ILcdEditableExtrudedShape
      Parameters:
      aMaximumZ - the maximum Z value.

    • getUpperLimit

      public TLcdAIXM51ValDistanceVertical getUpperLimit()
      Returns the value of the property that maps to the upperLimit element.

      The vertical position of the airspace ceiling.

      Returns:
      the value of the UPPER_LIMIT_PROPERTY property.

    • setUpperLimit

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

      The vertical position of the airspace ceiling.

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

    • getUpperLimitReference

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

      The reference surface used for the value of the upper limit. For example, Mean Sea Level, Ground, standard pressure, etc..

      Returns:
      the role value of the UPPER_LIMIT_REFERENCE_PROPERTY property.
      See Also:

    • setUpperLimitReference

      public void setUpperLimitReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the property that maps to the upperLimitReference 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 UPPER_LIMIT_REFERENCE_PROPERTY property is set to null.

      The reference surface used for the value of the upper limit. For example, Mean Sea Level, Ground, standard pressure, etc..

      Parameters:
      aValue - the role value to set for the UPPER_LIMIT_REFERENCE_PROPERTY property.

    • getMaximumLimit

      public TLcdAIXM51ValDistanceVertical getMaximumLimit()
      Returns the value of the property that maps to the maximumLimit element.

      When specified, the maximum limit overrides the upper limit, in those parts of the airspace where the upper limit is situated below the maximum limit.

      Returns:
      the value of the MAXIMUM_LIMIT_PROPERTY property.

    • setMaximumLimit

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

      When specified, the maximum limit overrides the upper limit, in those parts of the airspace where the upper limit is situated below the maximum limit.

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

    • getMaximumLimitReference

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

      The reference surface used for the value of the maximum limit. For example, Mean Sea Level, Ground, standard pressure, etc..

      Returns:
      the role value of the MAXIMUM_LIMIT_REFERENCE_PROPERTY property.
      See Also:

    • setMaximumLimitReference

      public void setMaximumLimitReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the property that maps to the maximumLimitReference 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 MAXIMUM_LIMIT_REFERENCE_PROPERTY property is set to null.

      The reference surface used for the value of the maximum limit. For example, Mean Sea Level, Ground, standard pressure, etc..

      Parameters:
      aValue - the role value to set for the MAXIMUM_LIMIT_REFERENCE_PROPERTY property.

    • getLowerLimit

      public TLcdAIXM51ValDistanceVertical getLowerLimit()
      Returns the value of the property that maps to the lowerLimit element.

      The vertical position of the airspace floor.

      Returns:
      the value of the LOWER_LIMIT_PROPERTY property.

    • setLowerLimit

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

      The vertical position of the airspace floor.

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

    • getLowerLimitReference

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

      The reference surface used for the value of the lower limit. For example, Mean Sea Level, Ground, standard pressure, etc..

      Returns:
      the role value of the LOWER_LIMIT_REFERENCE_PROPERTY property.
      See Also:

    • setLowerLimitReference

      public void setLowerLimitReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the property that maps to the lowerLimitReference 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 LOWER_LIMIT_REFERENCE_PROPERTY property is set to null.

      The reference surface used for the value of the lower limit. For example, Mean Sea Level, Ground, standard pressure, etc..

      Parameters:
      aValue - the role value to set for the LOWER_LIMIT_REFERENCE_PROPERTY property.

    • getMinimumLimit

      public TLcdAIXM51ValDistanceVertical getMinimumLimit()
      Returns the value of the property that maps to the minimumLimit element.

      When specified, the minimum limit overrides the lower limit, in those parts of the airspace where the lower limit is situated below the minimum limit. For example, an airspace that has "Upper FL 245, Lower 11 500 FT MSL but at least 2 000 FT GND'.

      Returns:
      the value of the MINIMUM_LIMIT_PROPERTY property.

    • setMinimumLimit

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

      When specified, the minimum limit overrides the lower limit, in those parts of the airspace where the lower limit is situated below the minimum limit. For example, an airspace that has "Upper FL 245, Lower 11 500 FT MSL but at least 2 000 FT GND'.

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

    • getMinimumLimitReference

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

      The reference surface used for the value of the minimum limit. For example, Mean Sea Level, Ground, standard pressure, etc.

      Returns:
      the role value of the MINIMUM_LIMIT_REFERENCE_PROPERTY property.
      See Also:

    • setMinimumLimitReference

      public void setMinimumLimitReference(TLcdAIXM51CodeVerticalReference aValue)
      Sets the value of the property that maps to the minimumLimitReference 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 MINIMUM_LIMIT_REFERENCE_PROPERTY property is set to null.

      The reference surface used for the value of the minimum limit. For example, Mean Sea Level, Ground, standard pressure, etc.

      Parameters:
      aValue - the role value to set for the MINIMUM_LIMIT_REFERENCE_PROPERTY property.

    • getWidth

      public TLcdAIXM51ValDistance getWidth()
      Returns the value of the property that maps to the width element.

      The width of the corridor, in case the AirspaceVolume has been originally defined as having a corridor shape.

      Returns:
      the value of the WIDTH_PROPERTY property.

    • setWidth

      public void setWidth(TLcdAIXM51ValDistance aValue)
      Sets the value of the property that maps to the width element.

      The width of the corridor, in case the AirspaceVolume has been originally defined as having a corridor shape.

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

    • getHorizontalProjection

      public TLcdAIXM51Surface getHorizontalProjection()
      Returns the role value contained in the value of the HORIZONTAL_PROJECTION_PROPERTY property. Returns null if the value of the HORIZONTAL_PROJECTION_PROPERTY property is null.

      The surface defining the horizontal shape of the AirspaceVolume.

      Returns:
      the role value of the HORIZONTAL_PROJECTION_PROPERTY property.
      See Also:

    • setHorizontalProjection

      public void setHorizontalProjection(TLcdAIXM51Surface aValue)
      Sets the value of the property that maps to the horizontalProjection element. to a new instance of the association class TLcdAIXM51Property initialized with the given role value. In case the given role value is null, the HORIZONTAL_PROJECTION_PROPERTY property is set to null.

      The surface defining the horizontal shape of the AirspaceVolume.

      Parameters:
      aValue - the role value to set for the HORIZONTAL_PROJECTION_PROPERTY property.

    • getCentreline

      public TLcdAIXM51Curve getCentreline()
      Returns the role value contained in the value of the CENTRELINE_PROPERTY property. Returns null if the value of the CENTRELINE_PROPERTY property is null.

      The centerline of an AirspaceVolume, in case the AirspaceVolume has been originally defined as having a corridor shape.

      Returns:
      the role value of the CENTRELINE_PROPERTY property.
      See Also:

    • setCentreline

      public void setCentreline(TLcdAIXM51Curve aValue)
      Sets the value of the property that maps to the centreline element. to a new instance of the association class TLcdAIXM51Property initialized with the given role value. In case the given role value is null, the CENTRELINE_PROPERTY property is set to null.

      The centerline of an AirspaceVolume, in case the AirspaceVolume has been originally defined as having a corridor shape.

      Parameters:
      aValue - the role value to set for the CENTRELINE_PROPERTY property.

    • getContributorAirspace

      public TLcdAIXM51AirspaceVolumeDependency getContributorAirspace()
      Returns the role value contained in the value of the CONTRIBUTOR_AIRSPACE_PROPERTY property. Returns null if the value of the CONTRIBUTOR_AIRSPACE_PROPERTY property is null.

      A (parent) Airspace, whose geometry has an impact on the geometry of the AirspaceVolume.

      Returns:
      the role value of the CONTRIBUTOR_AIRSPACE_PROPERTY property.
      See Also:

    • setContributorAirspace

      public void setContributorAirspace(TLcdAIXM51AirspaceVolumeDependency aValue)
      Sets the value of the property that maps to the contributorAirspace element. to a new instance of the association class TLcdAIXM51Property initialized with the given role value. In case the given role value is null, the CONTRIBUTOR_AIRSPACE_PROPERTY property is set to null.

      A (parent) Airspace, whose geometry has an impact on the geometry of the AirspaceVolume.

      Parameters:
      aValue - the role value to set for the CONTRIBUTOR_AIRSPACE_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:

    • 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: