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

Class TLcdAIXM51VerticalStructurePart

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.shared.schedules.TLcdAIXM51AbstractPropertiesWithSchedule
com.luciad.format.aixm51.model.features.obstacle.TLcdAIXM51VerticalStructurePart
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdShape, ILcdExtrudedShape, ILcdCloneable, ILcdDeepCloneable, Serializable, Cloneable
public class TLcdAIXM51VerticalStructurePart extends TLcdAIXM51AbstractPropertiesWithSchedule implements ILcdExtrudedShape
Class representing a AIXM 5.1 Vertical Structure Part. The geometric properties of the part can be accessed through the ILcdExtrudedShape interface.
Since:
10.0
See Also:

  • Field Details

    • TIME_INTERVAL_PROPERTY

      public static final TLcdDataProperty TIME_INTERVAL_PROPERTY
      Data property that maps to the timeInterval element. The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51Timesheet>>.

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

    • SPECIAL_DATE_AUTHORITY_PROPERTY

      public static final TLcdDataProperty SPECIAL_DATE_AUTHORITY_PROPERTY
      Data property that maps to the specialDateAuthority element. The possible values for this property are instances of List<TLcdAIXM51FeatureAssociation<TLcdAIXM51OrganisationAuthorityTimeSlice>>.

    • VERTICAL_EXTENT_PROPERTY

      public static final TLcdDataProperty VERTICAL_EXTENT_PROPERTY
      Data property that maps to the verticalExtent element. The possible values for this property are instances of TLcdAIXM51ValDistance.

    • VERTICAL_EXTENT_ACCURACY_PROPERTY

      public static final TLcdDataProperty VERTICAL_EXTENT_ACCURACY_PROPERTY
      Data property that maps to the verticalExtentAccuracy element. The possible values for this property are instances of TLcdAIXM51ValDistance.

    • TYPE_PROPERTY

      public static final TLcdDataProperty TYPE_PROPERTY
      Data property that maps to the type element. The possible values for this property are the public QName constants defined in this class.

    • CONSTRUCTION_STATUS_PROPERTY

      public static final TLcdDataProperty CONSTRUCTION_STATUS_PROPERTY
      Data property that maps to the constructionStatus element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeStatusConstruction>.

    • MARKING_PATTERN_PROPERTY

      public static final TLcdDataProperty MARKING_PATTERN_PROPERTY
      Data property that maps to the markingPattern element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeVerticalStructureMarking>.

    • MARKING_FIRST_COLOUR_PROPERTY

      public static final TLcdDataProperty MARKING_FIRST_COLOUR_PROPERTY
      Data property that maps to the markingFirstColour element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeColour>.

    • MARKING_SECOND_COLOUR_PROPERTY

      public static final TLcdDataProperty MARKING_SECOND_COLOUR_PROPERTY
      Data property that maps to the markingSecondColour element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeColour>.

    • MOBILE_PROPERTY

      public static final TLcdDataProperty MOBILE_PROPERTY
      Data property that maps to the mobile element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeYesNo>.

    • FRANGIBLE_PROPERTY

      public static final TLcdDataProperty FRANGIBLE_PROPERTY
      Data property that maps to the frangible element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeYesNo>.

    • VISIBLE_MATERIAL_PROPERTY

      public static final TLcdDataProperty VISIBLE_MATERIAL_PROPERTY
      Data property that maps to the visibleMaterial element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeVerticalStructureMaterial>.

    • DESIGNATOR_PROPERTY

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

    • HORIZONTAL_PROJECTION_PROPERTY

      public static final TLcdDataProperty HORIZONTAL_PROJECTION_PROPERTY
      Data property that maps to the choice between the horizontalProjection_location and horizontalProjection_linearExtent and horizontalProjection_surfaceExtent elements. The possible values for this property are instances of

    • LIGHTING_PROPERTY

      public static final TLcdDataProperty LIGHTING_PROPERTY
      Data property that maps to the lighting element. The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51LightElement>>.

    • 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

    • TLcdAIXM51VerticalStructurePart

      public TLcdAIXM51VerticalStructurePart()

    • TLcdAIXM51VerticalStructurePart

      public TLcdAIXM51VerticalStructurePart(TLcdDataType aType)

  • Method Details

    • getBaseShape

      public ILcdShape getBaseShape()
      Returns an ILcdShapeList containing the horizontal projections of this part. The ILcdShapeList will contain the linearExtent, location and surfaceExtent, if they exist.
      Specified by:
      getBaseShape in interface ILcdExtrudedShape
      Returns:
      base shape of the extruded shape.

    • getMinimumZ

      public double getMinimumZ()
      Returns the minimum Z value
      Specified by:
      getMinimumZ in interface ILcdExtrudedShape
      Returns:
      the minimum Z value of the extruded shape.

    • getMaximumZ

      public double getMaximumZ()
      Returns the maximum Z value, which corresponds to the vertical extent added to the minimum Z value.

      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 aPoint)
      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:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains2D

      public boolean contains2D(double aX, double aY)
      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:
      aX - the x coordinate of the point.
      aY - 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.

    • getTimeInterval

      public List<TLcdAIXM51Timesheet> getTimeInterval()
      Gets the value of the TIME_INTERVAL_PROPERTY property adapted to a list of TLcdAIXM51Timesheet instances.

      A component of the schedule.

      Overrides:
      getTimeInterval in class TLcdAIXM51AbstractPropertiesWithSchedule
      Returns:
      the value of the TIME_INTERVAL_PROPERTY property adapted to a list of TLcdAIXM51Timesheet instances.
      See Also:

    • getAnnotation

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

    • getSpecialDateAuthority

      public List<TLcdAIXM51Feature<TLcdAIXM51OrganisationAuthorityTimeSlice>> getSpecialDateAuthority()
      Gets the value of the SPECIAL_DATE_AUTHORITY_PROPERTY property adapted to a list of TLcdAIXM51Feature instances.

      Indicates that the SpecialDates associated with the related OrganisationAuthority are applicable to the schedule definition.

      Overrides:
      getSpecialDateAuthority in class TLcdAIXM51AbstractPropertiesWithSchedule
      Returns:
      the value of the SPECIAL_DATE_AUTHORITY_PROPERTY property adapted to a list of TLcdAIXM51Feature instances.
      See Also:

    • getVerticalExtent

      public TLcdAIXM51ValDistance getVerticalExtent()
      Returns the value of the property that maps to the verticalExtent element.

      The extent of the vertical structure part.

      Returns:
      the value of the VERTICAL_EXTENT_PROPERTY property.

    • setVerticalExtent

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

      The extent of the vertical structure part.

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

    • getVerticalExtentAccuracy

      public TLcdAIXM51ValDistance getVerticalExtentAccuracy()
      Returns the value of the property that maps to the verticalExtentAccuracy element.

      Accuracy of the value of the declared vertical extent.

      Returns:
      the value of the VERTICAL_EXTENT_ACCURACY_PROPERTY property.

    • setVerticalExtentAccuracy

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

      Accuracy of the value of the declared vertical extent.

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

    • getType

      public TLcdAIXM51CodeVerticalStructure getType()
      Returns the role value contained in the value of the TYPE_PROPERTY property. Returns null if the value of the TYPE_PROPERTY property is null.

      The possible values for this property are the public QName constants defined in this class.

      A code indicating the type of vertical structure, such as building, tower, cable, etc.

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

    • setType

      public void setType(TLcdAIXM51CodeVerticalStructure aValue)
      Sets the value of the property that maps to the type 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 TYPE_PROPERTY property is set to null.

      The possible values for this property are the public QName constants defined in this class.

      A code indicating the type of vertical structure, such as building, tower, cable, etc.

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

    • getConstructionStatus

      public TLcdAIXM51CodeStatusConstruction getConstructionStatus()
      Returns the role value contained in the value of the CONSTRUCTION_STATUS_PROPERTY property. Returns null if the value of the CONSTRUCTION_STATUS_PROPERTY property is null.

      This property enables the provision of information about the construction of the man-made object that constitutes the vertical structure.

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

    • setConstructionStatus

      public void setConstructionStatus(TLcdAIXM51CodeStatusConstruction aValue)
      Sets the value of the property that maps to the constructionStatus 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 CONSTRUCTION_STATUS_PROPERTY property is set to null.

      This property enables the provision of information about the construction of the man-made object that constitutes the vertical structure.

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

    • getMarkingPattern

      public TLcdAIXM51CodeVerticalStructureMarking getMarkingPattern()
      Returns the role value contained in the value of the MARKING_PATTERN_PROPERTY property. Returns null if the value of the MARKING_PATTERN_PROPERTY property is null.

      The general layout of the external paint or another marking element, intended to increase the visibility of the vertical structure.

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

    • setMarkingPattern

      public void setMarkingPattern(TLcdAIXM51CodeVerticalStructureMarking aValue)
      Sets the value of the property that maps to the markingPattern 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 MARKING_PATTERN_PROPERTY property is set to null.

      The general layout of the external paint or another marking element, intended to increase the visibility of the vertical structure.

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

    • getMarkingFirstColour

      public TLcdAIXM51CodeColour getMarkingFirstColour()
      Returns the role value contained in the value of the MARKING_FIRST_COLOUR_PROPERTY property. Returns null if the value of the MARKING_FIRST_COLOUR_PROPERTY property is null.

      The principal colour of the marking.

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

    • setMarkingFirstColour

      public void setMarkingFirstColour(TLcdAIXM51CodeColour aValue)
      Sets the value of the property that maps to the markingFirstColour 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 MARKING_FIRST_COLOUR_PROPERTY property is set to null.

      The principal colour of the marking.

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

    • getMarkingSecondColour

      public TLcdAIXM51CodeColour getMarkingSecondColour()
      Returns the role value contained in the value of the MARKING_SECOND_COLOUR_PROPERTY property. Returns null if the value of the MARKING_SECOND_COLOUR_PROPERTY property is null.

      The secondary colour for the marking.

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

    • setMarkingSecondColour

      public void setMarkingSecondColour(TLcdAIXM51CodeColour aValue)
      Sets the value of the property that maps to the markingSecondColour 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 MARKING_SECOND_COLOUR_PROPERTY property is set to null.

      The secondary colour for the marking.

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

    • getMobile

      public TLcdAIXM51CodeYesNo getMobile()
      Returns the role value contained in the value of the MOBILE_PROPERTY property. Returns null if the value of the MOBILE_PROPERTY property is null.

      A flag indicating whether the vertical structure is expected to move around its nominal location. The accuracy property of the related Point, Surface or Point can be used to provide the maximum displacement range.

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

    • setMobile

      public void setMobile(TLcdAIXM51CodeYesNo aValue)
      Sets the value of the property that maps to the mobile 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 MOBILE_PROPERTY property is set to null.

      A flag indicating whether the vertical structure is expected to move around its nominal location. The accuracy property of the related Point, Surface or Point can be used to provide the maximum displacement range.

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

    • getFrangible

      public TLcdAIXM51CodeYesNo getFrangible()
      Returns the role value contained in the value of the FRANGIBLE_PROPERTY property. Returns null if the value of the FRANGIBLE_PROPERTY property is null.

      Boolean indicating whether the obstruction is easily broken

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

    • setFrangible

      public void setFrangible(TLcdAIXM51CodeYesNo aValue)
      Sets the value of the property that maps to the frangible 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 FRANGIBLE_PROPERTY property is set to null.

      Boolean indicating whether the obstruction is easily broken

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

    • getVisibleMaterial

      public TLcdAIXM51CodeVerticalStructureMaterial getVisibleMaterial()
      Returns the role value contained in the value of the VISIBLE_MATERIAL_PROPERTY property. Returns null if the value of the VISIBLE_MATERIAL_PROPERTY property is null.

      The type(s) of material that compose the load-bearing structure and/or exterior facing of a vertical construction (for example: a building or non-building structure).

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

    • setVisibleMaterial

      public void setVisibleMaterial(TLcdAIXM51CodeVerticalStructureMaterial aValue)
      Sets the value of the property that maps to the visibleMaterial 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 VISIBLE_MATERIAL_PROPERTY property is set to null.

      The type(s) of material that compose the load-bearing structure and/or exterior facing of a vertical construction (for example: a building or non-building structure).

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

    • getDesignator

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

      An alphanumeric code by which the structure is identified locally.

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

    • setDesignator

      public void setDesignator(String aValue)
      Sets the value of the property that maps to the designator 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 DESIGNATOR_PROPERTY property is set to null.

      An alphanumeric code by which the structure is identified locally.

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

    • getHorizontalProjection

      public TLcdGML32AbstractGeometricPrimitive getHorizontalProjection()
      Returns the value of the property that maps to the choice between the horizontalProjection_location and horizontalProjection_linearExtent and horizontalProjection_surfaceExtent elements.

      The possible values for this property are instances of

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

    • setHorizontalProjection

      public void setHorizontalProjection(TLcdGML32AbstractGeometricPrimitive aValue)
      Sets the value of the property that maps to the choice between the horizontalProjection_location and horizontalProjection_linearExtent and horizontalProjection_surfaceExtent elements.

      The possible values for this property are instances of

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

    • getLighting

      public List<TLcdAIXM51LightElement> getLighting()
      Gets the value of the LIGHTING_PROPERTY property adapted to a list of TLcdAIXM51LightElement instances.

      An element of the vertical structure part lighting.

      Returns:
      the value of the LIGHTING_PROPERTY property adapted to a list of TLcdAIXM51LightElement 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: