Package com.luciad.ais.model.obstacle

Class TLcdObstacle

java.lang.Object
com.luciad.ais.shape.TLcdAISPoint
com.luciad.ais.model.obstacle.TLcdObstacle
All Implemented Interfaces:
ILcdEditableObstacle, ILcdObstacle, ILcdDataObject, ILcdBounded, ILcdPoint, ILcdShape, ILcd2DEditablePoint, ILcd2DEditableShape, ILcd3DEditablePoint, ILcd3DEditableShape, ILcdCloneable, Serializable, Cloneable
Direct Known Subclasses:
TLcdFeaturedObstacle
public class TLcdObstacle extends TLcdAISPoint implements ILcdEditableObstacle
This class defines an obstacle.

An obstacle is a fixed object whether temporary or permanent, or a part thereof, that is located on an area intended for the surface movement of aircraft or that extends above a defined surface intended to protect aircraft in flight.

Note that this class extends TLcdAISPoint, and so it is required to set a delegate point implementation using the setLocation() method before using the obstacle object.

See Also:

  • Field Details

    • LOCATION_PROPERTY

      public static final TLcdDataProperty LOCATION_PROPERTY
      The location property of the WayPoint type. Values for this property are of type ILcd3DEditablePoint.

    • LIGHTED_PROPERTY

      public static final TLcdDataProperty LIGHTED_PROPERTY
      The location property of the WayPoint type. Values for this property are of type Boolean.

  • Constructor Details

  • Method Details

    • getDataType

      public TLcdDataType getDataType()
      Description copied from interface: ILcdDataObject
      Returns the type of this data object. This can never be null.
      Specified by:
      getDataType in interface ILcdDataObject
      Returns:
      the type of this data object

    • getValue

      public Object getValue(TLcdDataProperty aProperty)
      Description copied from interface: 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.

      Specified by:
      getValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which the value is to be returned
      Returns:
      the value of the given property for this data object

    • getValue

      public Object getValue(String aPropertyName)
      Description copied from interface: 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).

      See ILcdDataObject.getValue(TLcdDataProperty) for more information.

      Specified by:
      getValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be returned
      Returns:
      the value of the property with the given name
      See Also:

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

    • setValue

      public void setValue(String aPropertyName, Object aValue)
      Description copied from interface: 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).

      See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.

      Specified by:
      setValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be set
      aValue - the value to set

    • setLighted

      public void setLighted(boolean aIsLighted)
      Description copied from interface: ILcdEditableObstacle
      Specifies a boolean indicated that the obstacle is lighted.
      Specified by:
      setLighted in interface ILcdEditableObstacle
      Parameters:
      aIsLighted -

    • isLighted

      public boolean isLighted()
      Description copied from interface: ILcdObstacle
      Returns a boolean indicating that the obstacle is lighted.
      Specified by:
      isLighted in interface ILcdObstacle

    • hasValue

      public boolean hasValue(TLcdDataProperty aProperty)
      Description copied from interface: ILcdDataObject
      Indicates whether this data object has a value for the given property.

      • 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 IllegalArgumentException
      • aProperty is null: not allowed, you will get NullPointerException

      A multivalued property is considered to have a value if it has at least one value.

      Specified by:
      hasValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which to return whether a value is present or not.
      Returns:
      true if this data object has a value for the given property, false otherwise.

    • hasValue

      public boolean hasValue(String aPropertyName)
      Description copied from interface: ILcdDataObject
      Indicates whether this data object has a value for the given property.
      See ILcdDataObject.hasValue(TLcdDataProperty) for more information.
      Specified by:
      hasValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property for which to return whether a value is present or not.
      Returns:
      true if this data object has a value for the property with the given name, false otherwise.