Package com.luciad.ais.model.navaid

Class TLcdFeaturedWayPoint

java.lang.Object

com.luciad.ais.shape.TLcdAISPoint

com.luciad.ais.model.navaid.TLcdWayPoint

com.luciad.ais.model.navaid.TLcdFeaturedWayPoint

All Implemented Interfaces:

ILcdEditableWayPoint, ILcdWayPoint, ILcdDefaultDisplayNameSettable, ILcdDataObject, ILcdBounded, ILcdPoint, ILcdShape, ILcd2DEditablePoint, ILcd2DEditableShape, ILcd3DEditablePoint, ILcd3DEditableShape, ILcdCloneable, ILcdFeatured, Serializable, Cloneable

public class TLcdFeaturedWayPoint
extends TLcdWayPoint
implements ILcdDefaultDisplayNameSettable

The default implementation of a waypoint with features. Note that this class extends TLcdAISPoint, and so it is required to set a delegate point implementation using the setLocation() method before using the waypoint object.

See Also:

• TLcdAISPoint
• Serialized Form

Field Summary

Fields inherited from class com.luciad.ais.model.navaid.TLcdWayPoint

LOCATION_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdFeaturedWayPoint(int aNumberOfFeatures)	Deprecated. Use TLcdFeaturedWayPoint(TLcdDataType)
TLcdFeaturedWayPoint(TLcdFeaturedWayPoint aFeaturedWaypoint)	Copy constructor.
TLcdFeaturedWayPoint(TLcdDataType aDataType)	Creates a new instance for the given type.

Method Summary

Modifier and Type	Method	Description
boolean	canSetFeature(int aIndex)	Checks whether the specified feature is editable.
String	getDefaultDisplayName()	Returns the String to be used to display the ILcdDefaultDisplayNameSettable object.
int	getDefaultDisplayNameIndex()	Returns the current index of the feature to be uses in the display name.
Object	getFeature(int aIndex)	Returns the feature Object at the given index.
int	getFeatureCount()	Returns the number of features.
Object	getValue(TLcdDataProperty aProperty)	Returns the value of the given property.
void	setDefaultDisplayNameIndex(int aDefaultDisplayNameIndex)	Sets the index of the feature to be used in the display name.
void	setFeature(int aIndex, Object aObject)	Sets the feature Object at the given index.
void	setValue(TLcdDataProperty aProperty, Object aValue)	Sets the value of the given property for this data object.
String	toString()

Methods inherited from class com.luciad.ais.model.navaid.TLcdWayPoint

getDataType, getValue, hasValue, hasValue, setValue

Methods inherited from class com.luciad.ais.shape.TLcdAISPoint

clone, cloneAs2DEditablePoint, cloneAs3DEditablePoint, contains2D, contains2D, contains3D, contains3D, equals, getBounds, getCosX, getCosY, getFocusPoint, getSinX, getSinY, getTanX, getTanY, getX, getY, getZ, hashCode, move2D, move2D, move3D, move3D, setLocation, translate2D, translate3D

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.shape.shape2D.ILcd2DEditableShape

move2D, move2D, translate2D

Methods inherited from interface com.luciad.shape.shape3D.ILcd3DEditableShape

move3D, move3D, translate3D

Methods inherited from interface com.luciad.shape.ILcdBounded

getBounds

Methods inherited from interface com.luciad.util.ILcdCloneable

clone

Methods inherited from interface com.luciad.shape.ILcdPoint

cloneAs2DEditablePoint, cloneAs3DEditablePoint, equals, getCosX, getCosY, getSinX, getSinY, getTanX, getTanY, getX, getY, getZ

Methods inherited from interface com.luciad.shape.ILcdShape

contains2D, contains2D, contains3D, contains3D, getFocusPoint

Constructor Details

TLcdFeaturedWayPoint

@Deprecated
public TLcdFeaturedWayPoint(int aNumberOfFeatures)

Deprecated.

Use TLcdFeaturedWayPoint(TLcdDataType)

Constructs a new TLcdFeaturedWayPoint. The user has to pass on the number of features he wants to store in the new object.

Parameters:

aNumberOfFeatures - the number of features for the new object

TLcdFeaturedWayPoint

public TLcdFeaturedWayPoint(TLcdFeaturedWayPoint aFeaturedWaypoint)

Copy constructor.

Parameters:

aFeaturedWaypoint - the waypoint to be copied into a new object

TLcdFeaturedWayPoint

public TLcdFeaturedWayPoint(TLcdDataType aDataType)

Creates a new instance for the given type.

Parameters:

aDataType - the data type of the returned instance

Throws:

IllegalArgumentException - if TLcdAISDataTypes.WayPoint is not assignable from the given data type

Since:

10.1

See Also:

• TLcdAISDataTypes.WayPoint

Method Details

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

Overrides:

getValue in class TLcdWayPoint

Parameters:

aProperty - the property for which the value is to be returned

Returns:

the value of the given property for this data object

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 TLcdWayPoint

Parameters:

aProperty - the property for which the value is to be set

aValue - the value to set

See Also:

• TLcdDataType.getProperty(String)

getFeature

public Object getFeature(int aIndex)

Description copied from interface: ILcdFeatured

Returns the feature Object at the given index.

Specified by:

getFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

Returns:

the feature Object at the given index.

See Also:

• ILcdFeatured.setFeature(int, java.lang.Object)

setFeature

public void setFeature(int aIndex,
 Object aObject)

Description copied from interface: ILcdFeatured

Sets the feature Object at the given index.

Specified by:

setFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

aObject - the new feature Object.

See Also:

• ILcdFeatured.getFeature(int)
• ILcdFeatured.canSetFeature(int)

getFeatureCount

public int getFeatureCount()

Description copied from interface: ILcdFeatured

Returns the number of features.

Specified by:

getFeatureCount in interface ILcdFeatured

Returns:

the number of features.

canSetFeature

public boolean canSetFeature(int aIndex)

Description copied from interface: ILcdFeatured

Checks whether the specified feature is editable.

Specified by:

canSetFeature in interface ILcdFeatured

Parameters:

aIndex - a valid feature index.

Returns:

true if the feature can be set, false otherwise.

setDefaultDisplayNameIndex

public void setDefaultDisplayNameIndex(int aDefaultDisplayNameIndex)

Description copied from interface: ILcdDefaultDisplayNameSettable

Sets the index of the feature to be used in the display name. The default value is 0.

Specified by:

setDefaultDisplayNameIndex in interface ILcdDefaultDisplayNameSettable

Parameters:

aDefaultDisplayNameIndex - a valid index in the list of features

See Also:

• ILcdDefaultDisplayNameSettable.getDefaultDisplayNameIndex()

getDefaultDisplayNameIndex

public int getDefaultDisplayNameIndex()

Description copied from interface: ILcdDefaultDisplayNameSettable

Returns the current index of the feature to be uses in the display name.

Specified by:

getDefaultDisplayNameIndex in interface ILcdDefaultDisplayNameSettable

Returns:

the current index of the feature to use in the display name

See Also:

• ILcdDefaultDisplayNameSettable.setDefaultDisplayNameIndex(int)

getDefaultDisplayName

public String getDefaultDisplayName()

Description copied from interface: ILcdDefaultDisplayNameSettable

Returns the String to be used to display the ILcdDefaultDisplayNameSettable object.

Specified by:

getDefaultDisplayName in interface ILcdDefaultDisplayNameSettable

Returns:

the String to be used to display the ILcdDefaultDisplayNameSettable object

toString

public String toString()

Overrides:

toString in class Object