com.luciad.ais.model.vfr

Aviation StandardsClass TLcdVFRRoute

java.lang.Object

com.luciad.ais.shape.TLcdAISPolyline

com.luciad.ais.model.vfr.TLcdVFRRoute

All Implemented Interfaces:

ILcdEditableVFRRoute, ILcdVFRRoute, ILcdDataObject, ILcdBounded, ILcdCurve, ILcdPointList, ILcdPolyline, ILcdShape, ILcd2DEditablePointList, ILcd2DEditablePolyline, ILcd2DEditableShape, ILcd3DEditablePointList, ILcd3DEditablePolyline, ILcd3DEditableShape, ILcdCache, ILcdCloneable, Serializable, Cloneable

Direct Known Subclasses:

TLcdFeaturedVFRRoute, TLcdVFROffsetRoute

public class TLcdVFRRoute
extends TLcdAISPolyline
implements ILcdEditableVFRRoute

The default implementation of a VFR route without features. Note that this class extends TLcdAISPolyline, and so it is required to set a delegate polyline implementation using the set3DEditablePolyline() method before using the VFR route object.

See Also:

TLcdAISPolyline, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TLcdDataProperty	ROUTE_POINT_PROPERTY The RoutePoint property of the VFR route type.

Fields inherited from interface com.luciad.shape.ILcdCurve

INTERPOLATION_CIRCLE_BY_3POINTS, INTERPOLATION_CIRCLE_BY_CENTERPOINT, INTERPOLATION_CIRCULARARC_BY_3POINTS, INTERPOLATION_CIRCULARARC_BY_BULGE, INTERPOLATION_CIRCULARARC_BY_CENTERPOINT, INTERPOLATION_ELLIPTICAL, INTERPOLATION_GEODESIC, INTERPOLATION_LINEAR, INTERPOLATION_MIXED, INTERPOLATION_RHUMB

Constructor Summary

Constructors

Constructor and Description
TLcdVFRRoute() Deprecated. Use TLcdVFRRoute(TLcdDataType)
TLcdVFRRoute(TLcdDataType aDataType) Creates a new instance for the given type.
TLcdVFRRoute(TLcdVFRRoute aVFRRoute) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	addRoutePoint(ILcdVFRRoutePoint aRoutePoint) Adds an ILcdVFRRoutePoint object at the end of the VFR route.
TLcdDataType	getDataType() Returns the type of this data object.
ILcdPoint	getPoint(int aIndex) Returns the ILcdPoint at a given index.
Object	getValue(String aPropertyName) Convenience method that returns the value of the property with the given name.
Object	getValue(TLcdDataProperty aProperty) Returns the value of the given property.
boolean	hasValue(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.
boolean	isOffset() Returns a boolean indicating whether the route is an offset route or not.
static boolean	isTraceOn() Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	removeRoutePoint(int aIndex) Removes the ILcdVFRRoutePoint object at the given index.
void	setOffset(boolean aIsOffset) A boolean indicating whether this route is an offset route or not.
static void	setTraceOn(boolean aClassTraceOn) Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
void	setValue(String aPropertyName, Object aValue) Convenience method that sets the value of the property with the given name.
void	setValue(TLcdDataProperty aProperty, Object aValue) Sets the value of the given property for this data object.

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

clearCache, clone, computePointSFCT, contains2D, contains2D, contains3D, contains3D, equals, getBounds, getCachedObject, getEndPoint, getEndTangent2D, getFocusPoint, getInterpolation, getLength2D, getLineSegmentIntersectionCount, getPointCount, getStartPoint, getStartTangent2D, getTangent2D, hashCode, insert2DPoint, insert3DPoint, insertIntoCache, move2D, move2D, move2DPoint, move3D, move3D, move3DPoint, removeCachedObject, removePointAt, set3DEditablePolyline, translate2D, translate2DPoint, translate3D, translate3DPoint

Methods inherited from class java.lang.Object

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

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

move3D, move3D, translate3D

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

move2D, move2D, translate2D

Methods inherited from interface com.luciad.shape.ILcdShape

contains2D, contains2D, contains3D, contains3D, getFocusPoint

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.shape3D.ILcd3DEditablePointList

insert3DPoint, move3DPoint, removePointAt, translate3D, translate3DPoint

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

append2DPoint, insert2DPoint, move2DPoint, translate2D, translate2DPoint

Methods inherited from interface com.luciad.shape.ILcdPointList

getPointCount, getPointSFCT, getX, getY, getZ

Field Detail

ROUTE_POINT_PROPERTY

public static final TLcdDataProperty ROUTE_POINT_PROPERTY

The RoutePoint property of the VFR route type. Values of this property are lists of objects of type ILcdVFRRoutePoint.

Constructor Detail

TLcdVFRRoute

@Deprecated
public TLcdVFRRoute()

Deprecated. Use TLcdVFRRoute(TLcdDataType)

Constructs a new TLcdVFRRoute object.

TLcdVFRRoute

public TLcdVFRRoute(TLcdVFRRoute aVFRRoute)

Copy constructor.

Parameters:

aVFRRoute - the TLcdVFRRoute object to be copied into a new object

TLcdVFRRoute

public TLcdVFRRoute(TLcdDataType aDataType)

Creates a new instance for the given type.

Parameters:

aDataType - the data type of the returned instance

Throws:

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

Since:

10.1

Method Detail

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:

TLcdDataType.getProperty(String)

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:

TLcdDataType.getProperty(String)

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

isOffset

public boolean isOffset()

Description copied from interface: ILcdVFRRoute

Returns a boolean indicating whether the route is an offset route or not.

This is a required attribute.

Specified by:

isOffset in interface ILcdVFRRoute

Returns:

a boolean indicating whether the route is an offset route or not

addRoutePoint

public void addRoutePoint(ILcdVFRRoutePoint aRoutePoint)

Description copied from interface: ILcdEditableVFRRoute

Adds an ILcdVFRRoutePoint object at the end of the VFR route.

Specified by:

addRoutePoint in interface ILcdEditableVFRRoute

Parameters:

aRoutePoint - the point to be added

removeRoutePoint

public void removeRoutePoint(int aIndex)

Description copied from interface: ILcdEditableVFRRoute

Removes the ILcdVFRRoutePoint object at the given index.

Specified by:

removeRoutePoint in interface ILcdEditableVFRRoute

Parameters:

aIndex - the index of the point to be removed

setOffset

public void setOffset(boolean aIsOffset)

Description copied from interface: ILcdEditableVFRRoute

A boolean indicating whether this route is an offset route or not.

This is a required attribute.

Specified by:

setOffset in interface ILcdEditableVFRRoute

Parameters:

aIsOffset - a boolean indicating whether this route is an offset route or not

getPoint

public ILcdPoint getPoint(int aIndex)
                   throws IndexOutOfBoundsException

Description copied from interface: ILcdPointList

Returns the ILcdPoint at a given index.

Specified by:

getPoint in interface ILcdPointList

Overrides:

getPoint in class TLcdAISPolyline

Parameters:

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

Returns:

the ILcdPoint at the given index.

Throws:

IndexOutOfBoundsException - if the given index is out of bounds.

isTraceOn

public static boolean isTraceOn()

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Returns true if tracing is enabled for this class.

Returns:

true if tracing is enabled for this class, false otherwise.

setTraceOn

public static void setTraceOn(boolean aClassTraceOn)

Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.

Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

Parameters:

aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

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.