com.luciad.ais.model.aerodrome

Aviation StandardsClass TLcdHelipad

java.lang.Object

com.luciad.ais.model.aerodrome.TLcdHelipad

All Implemented Interfaces:

ILcdEditableHelipad, ILcdHelipad, ILcdEditableGeoPath, ILcdGeoPath, ILcdDataObject, ILcdBounded, ILcdPointList, ILcdPolygon, ILcdShape, ILcdCloneable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

TLcdFeaturedHelipad

public class TLcdHelipad
extends java.lang.Object
implements ILcdEditableHelipad

An implementation of ILcdHelipad.

This implementation performs a discretization of the helipad in geodetic coordinates.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdDataProperty	GEOMETRY_PROPERTY The geometry property of the helipad type.
static TLcdDataProperty	HELIPAD_TYPE_PROPERTY The HelipadType property of the helipad type.
static TLcdDataProperty	LENGTH_PROPERTY The Length property of the helipad type.
static TLcdDataProperty	WIDTH_PROPERTY The Width property of the helipad type.

Fields inherited from interface com.luciad.shape.ILcdPolygon

CLOCKWISE, COUNTERCLOCKWISE, INVALID_ORIENTATION

Constructor Summary

Constructors

Constructor and Description
TLcdHelipad() Deprecated. Use TLcdHelipad(TLcdDataType)
TLcdHelipad(TLcdDataType aDataType) Creates a new instance for the given type.
TLcdHelipad(TLcdHelipad aHelipad) Construct a new TLcdHelipad object based on an existing one.

Method Summary

Modifier and Type	Method and Description
void	addLeg(ILcdGeoPathLeg aLeg) Adds the specified leg to the end of this GeoPath.
java.lang.Object	clone() Returns a clone of this TLcdHelipad object.
boolean	contains2D(double v, double v1) Checks whether this ILcdShape contains the given point in the 2D space.
boolean	contains2D(ILcdPoint aPoint) Checks whether this ILcdShape contains the given ILcdPoint in the 2D space.
boolean	contains3D(double v, double v1, double v2) Checks whether this ILcdShape contains the given point in the 3D space.
boolean	contains3D(ILcdPoint aPoint) Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
ILcdBounds	getBounds() Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
TLcdDataType	getDataType() Returns the type of this data object.
ILcdPoint	getFocusPoint() Returns the focus point of this ILcdShape.
TLcdHelipadType	getHelipadType() Returns the type of this helipad.
ILcdGeoPathLeg	getLeg(int aIndex) Returns the ILcdGeoPathLeg at the given index.
int	getLegCount() Returns the number of legs in this ILcdGeoPath.
double	getLength() Returns the length of this helipad.
int	getOrientation() Returns the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE.
ILcdPoint	getPoint(int aIndex) Returns the ILcdPoint at a given index.
int	getPointCount() Returns the number of ILcdPoint objects in the list.
java.lang.Object	getValue(java.lang.String aPropertyName) Convenience method that returns the value of the property with the given name.
java.lang.Object	getValue(TLcdDataProperty aProperty) Returns the value of the given property.
double	getWidth() Returns the width of this helipad.
boolean	hasValue(java.lang.String aPropertyName) Indicates whether this data object has a value for the given property.
boolean	hasValue(TLcdDataProperty aProperty) Indicates whether this data object has a value for the given property.
void	insertLegAt(ILcdGeoPathLeg aLeg, int anIndex) Adds a ILcdGeoPathLeg object to the ILcdEditableGeoPath on the specified index.
void	invalidate() Discards the geometry cached with this helipad and recalculates it.
void	removeLegAt(int anIndex) Removes the ILcdGeoPathLeg object on the specified index from the from ILcdEditableGeoPath.
void	setHelipadType(TLcdHelipadType aHelipadType) Specifies the type of this helipad.
void	setLength(double aLength) Specifies the length of this helipad.
void	setValue(java.lang.String aPropertyName, java.lang.Object aValue) Convenience method that sets the value of the property with the given name.
void	setValue(TLcdDataProperty aProperty, java.lang.Object aValue) Sets the value of the given property for this data object.
void	setWidth(double aWidth) Specifies the width of this helipad.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.shape.ILcdPointList

getPointSFCT, getX, getY, getZ

Field Detail

HELIPAD_TYPE_PROPERTY

public static final TLcdDataProperty HELIPAD_TYPE_PROPERTY

The HelipadType property of the helipad type. Values of this property are of type TLcdHelipadType.

WIDTH_PROPERTY

public static final TLcdDataProperty WIDTH_PROPERTY

The Width property of the helipad type. Values of this property are of type Double.

LENGTH_PROPERTY

public static final TLcdDataProperty LENGTH_PROPERTY

The Length property of the helipad type. Values of this property are of type Double.

GEOMETRY_PROPERTY

public static final TLcdDataProperty GEOMETRY_PROPERTY

The geometry property of the helipad type. Values of this property are of type ILcdGeoPath.

Constructor Detail

TLcdHelipad

@Deprecated
public TLcdHelipad()

Deprecated. Use TLcdHelipad(TLcdDataType)

Constructs a new TLcdHelipad object.

TLcdHelipad

public TLcdHelipad(TLcdHelipad aHelipad)

Construct a new TLcdHelipad object based on an existing one.

Parameters:

aHelipad - The helipad to copy.

TLcdHelipad

public TLcdHelipad(TLcdDataType aDataType)

Creates a new instance for the given type.

Parameters:

aDataType - the data type of the returned instance

Throws:

java.lang.IllegalArgumentException - if TLcdAISDataTypes.Helipad is not assignable from the given data type

Since:

10.1

See Also:

TLcdAISDataTypes.Helipad

Method Detail

getHelipadType

public TLcdHelipadType getHelipadType()

Description copied from interface: ILcdHelipad

Returns the type of this helipad.

Specified by:

getHelipadType in interface ILcdHelipad

Returns:

the type

getWidth

public double getWidth()

Description copied from interface: ILcdHelipad

Returns the width of this helipad.

Specified by:

getWidth in interface ILcdHelipad

Returns:

the width

getLength

public double getLength()

Description copied from interface: ILcdHelipad

Returns the length of this helipad.

Specified by:

getLength in interface ILcdHelipad

Returns:

the length

setHelipadType

public void setHelipadType(TLcdHelipadType aHelipadType)

Description copied from interface: ILcdEditableHelipad

Specifies the type of this helipad.

Specified by:

setHelipadType in interface ILcdEditableHelipad

Parameters:

aHelipadType - a value for the type

setWidth

public void setWidth(double aWidth)

Description copied from interface: ILcdEditableHelipad

Specifies the width of this helipad.

Specified by:

setWidth in interface ILcdEditableHelipad

Parameters:

aWidth - a value for the width

setLength

public void setLength(double aLength)

Description copied from interface: ILcdEditableHelipad

Specifies the length of this helipad.

Specified by:

setLength in interface ILcdEditableHelipad

Parameters:

aLength - a value for the length

getLegCount

public int getLegCount()

Description copied from interface: ILcdGeoPath

Returns the number of legs in this ILcdGeoPath.

Specified by:

getLegCount in interface ILcdGeoPath

Returns:

The number of legs in this ILcdGeoPath.

getLeg

public ILcdGeoPathLeg getLeg(int aIndex)

Description copied from interface: ILcdGeoPath

Returns the ILcdGeoPathLeg at the given index.

Specified by:

getLeg in interface ILcdGeoPath

Parameters:

aIndex - an index.

Returns:

The ILcdGeoPathLeg at the given index.

addLeg

public void addLeg(ILcdGeoPathLeg aLeg)

Description copied from interface: ILcdEditableGeoPath

Adds the specified leg to the end of this GeoPath.

Specified by:

addLeg in interface ILcdEditableGeoPath

Parameters:

aLeg - an ILcdGeoPathLeg

insertLegAt

public void insertLegAt(ILcdGeoPathLeg aLeg,
                        int anIndex)

Description copied from interface: ILcdEditableGeoPath

Adds a ILcdGeoPathLeg object to the ILcdEditableGeoPath on the specified index.

Specified by:

insertLegAt in interface ILcdEditableGeoPath

Parameters:

aLeg - the ILcdGeoPathLeg object to be added to the ILcdEditableGeoPath.

anIndex - the index in the ILcdEditableAirspace where the ILcdAirspaceSegment object must be added.

removeLegAt

public void removeLegAt(int anIndex)

Description copied from interface: ILcdEditableGeoPath

Removes the ILcdGeoPathLeg object on the specified index from the from ILcdEditableGeoPath.

Specified by:

removeLegAt in interface ILcdEditableGeoPath

Parameters:

anIndex - the index in the ILcdEditableGeoPath where the ILcdGeoPathLeg object must be removed.

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.

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:

ILcdShape.contains2D(double, double)

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:

ILcdShape.contains3D(double, double, double)

contains3D

public boolean contains3D(double v,
                          double v1,
                          double v2)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given point in the 3D space.

Specified by:

contains3D in interface ILcdShape

Parameters:

v - the x coordinate of the point.

v1 - the y coordinate of the point.

v2 - the z coordinate of the point.

Returns:

the boolean result of the containment test.

clone

public java.lang.Object clone()

Returns a clone of this TLcdHelipad object. Note: the features of the new object are a shallow clone of the features of this object.

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class java.lang.Object

Returns:

a clone of this TLcdHelipad object.

See Also:

Object.clone()

getOrientation

public int getOrientation()

Description copied from interface: ILcdPolygon

Returns the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE.

Specified by:

getOrientation in interface ILcdPolygon

Returns:

the orientation of this ILcdPolygon: ILcdPolygon.CLOCKWISE or ILcdPolygon.COUNTERCLOCKWISE. This method should not return INVALID_ORIENTATION, which is only to be used for resetting the orientation so that it can be recalculated.

getPointCount

public int getPointCount()

Description copied from interface: ILcdPointList

Returns the number of ILcdPoint objects in the list.

Specified by:

getPointCount in interface ILcdPointList

Returns:

the number of ILcdPoint objects in the list.

getPoint

public ILcdPoint getPoint(int aIndex)
                   throws java.lang.IndexOutOfBoundsException

Description copied from interface: ILcdPointList

Returns the ILcdPoint at a given index.

Specified by:

getPoint in interface ILcdPointList

Parameters:

aIndex - a valid index in the list of ILcdPoint objects.

Returns:

the ILcdPoint at the given index.

Throws:

java.lang.IndexOutOfBoundsException - if the given index is out of bounds.

invalidate

public void invalidate()

Discards the geometry cached with this helipad and recalculates it. Whenever this is done, the ILcdModel containing this helipad should be notified by means of a call to elementChanged()!

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 java.lang.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 java.lang.Object getValue(java.lang.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:

TLcdDataType.getProperty(String)

setValue

public void setValue(TLcdDataProperty aProperty,
                     java.lang.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:

TLcdDataType.getProperty(String)

setValue

public void setValue(java.lang.String aPropertyName,
                     java.lang.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

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(java.lang.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.