TLcdAIXM51UnplannedHoldingTimeSlice (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.format.gml32.model.TLcdGML32AbstractGML
  - - com.luciad.format.gml32.model.TLcdGML32AbstractTimeSlice
    - - com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMTimeSliceBase
      - com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMTimeSlice
        
        com.luciad.format.aixm51.model.features.holding.TLcdAIXM51UnplannedHoldingTimeSlice

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdShape, ILcdShapeList, ILcdTimeBounded, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable
```
public class TLcdAIXM51UnplannedHoldingTimeSlice
extends TLcdAIXM51AbstractAIXMTimeSlice
```
First time a point is established in Enroute environment at a navaid, all radials are checked for holding; 360 deg. (A circle is used for assessment) If the point is a designated point, holding along the course guidance radial is checked. If no restrictions are found, holding on any radial (unplanned) is approved. If restrictions are found, holding restrictions may be noted or holding may be restricted to defined holding patterns.

Since:

10.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`ALTITUDE_REFERENCE_PROPERTY` Data property that maps to the `altitudeReference` element.
`static TLcdDataProperty`	`ANNOTATION_PROPERTY` Data property that maps to the `annotation` element.
`static TLcdDataProperty`	`AUTHORIZED_ALTITUDE_PROPERTY` Data property that maps to the `authorizedAltitude` element.
`static TLcdDataProperty`	`CONTROLLED_AIRSPACE_PROPERTY` Data property that maps to the `controlledAirspace` element.
`static TLcdDataProperty`	`CORRECTION_NUMBER_PROPERTY` Data property that maps to the `correctionNumber` element.
`static TLcdDataProperty`	`EXTENSION_PROPERTY` Data property that maps to the `extension` element.
`static TLcdDataProperty`	`FEATURE_LIFETIME_PROPERTY` Data property that maps to the `featureLifetime` element.
`static TLcdDataProperty`	`HOLDING_POINT_PROPERTY` Data property that maps to the `holdingPoint` element.
`static TLcdDataProperty`	`INTERPRETATION_PROPERTY` Data property that maps to the `interpretation` element.
`static TLcdDataProperty`	`SEQUENCE_NUMBER_PROPERTY` Data property that maps to the `sequenceNumber` element.
`static TLcdDataProperty`	`TIME_SLICE_METADATA_PROPERTY` Data property that maps to the `timeSliceMetadata` element.
`static TLcdDataProperty`	`UNPLANNED_HOLDING_PROPERTY` Data property that maps to the `unplannedHolding` element.

Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimeSlice
DATA_SOURCE_PROPERTY, VALID_TIME_PROPERTY

Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML
DESCRIPTION_PROPERTY, DESCRIPTION_REFERENCE_PROPERTY, ID_PROPERTY, IDENTIFIER_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY

Constructor Summary

Constructors
Constructor and Description

TLcdAIXM51UnplannedHoldingTimeSlice()

TLcdAIXM51UnplannedHoldingTimeSlice(TLcdDataType aType)

Constructors
Constructor and Description
`TLcdAIXM51UnplannedHoldingTimeSlice()`
`TLcdAIXM51UnplannedHoldingTimeSlice(TLcdDataType aType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TLcdAIXM51CodeVerticalReference`	`getAltitudeReference()` Returns the role value contained in the value of the `ALTITUDE_REFERENCE_PROPERTY` property.
`List<TLcdAIXM51Note>`	`getAnnotation()` Gets the value of the `ANNOTATION_PROPERTY` property adapted to a list of `TLcdAIXM51Note` instances.
`TLcdAIXM51ValDistanceVertical`	`getAuthorizedAltitude()` Returns the value of the property that maps to the `authorizedAltitude` element.
`TLcdAIXM51CodeYesNo`	`getControlledAirspace()` Returns the role value contained in the value of the `CONTROLLED_AIRSPACE_PROPERTY` property.
`long`	`getCorrectionNumber()` Returns the value of the property that maps to the `correctionNumber` element.
`List<TLcdAIXM51AbstractExtension>`	`getExtension()` Gets the value of the `EXTENSION_PROPERTY` property adapted to a list of `TLcdAIXM51AbstractExtension` instances.
`TLcdGML32AbstractTimePrimitive`	`getFeatureLifetime()` Returns the value of the property that maps to the `featureLifetime` element.
`TLcdAIXM51AbstractSegmentPoint`	`getHoldingPoint()` Returns the role value contained in the value of the `HOLDING_POINT_PROPERTY` property.
`ELcdAIXM51Interpretation`	`getInterpretation()` Returns the value of the property that maps to the `interpretation` element.
`long`	`getSequenceNumber()` Returns the value of the property that maps to the `sequenceNumber` element.
`TLcdAIXM51FeatureTimeSliceMetadataProperty`	`getTimeSliceMetadata()` Returns the value of the property that maps to the `timeSliceMetadata` element.
`TLcdAIXM51CodeApproval`	`getUnplannedHolding()` Returns the role value contained in the value of the `UNPLANNED_HOLDING_PROPERTY` property.
`void`	`setAltitudeReference(TLcdAIXM51CodeVerticalReference aValue)` Sets the value of the property that maps to the `altitudeReference` element.
`void`	`setAuthorizedAltitude(TLcdAIXM51ValDistanceVertical aValue)` Sets the value of the property that maps to the `authorizedAltitude` element.
`void`	`setControlledAirspace(TLcdAIXM51CodeYesNo aValue)` Sets the value of the property that maps to the `controlledAirspace` element.
`void`	`setCorrectionNumber(long aValue)` Sets the value of the property that maps to the `correctionNumber` element.
`void`	`setFeatureLifetime(TLcdGML32AbstractTimePrimitive aValue)` Sets the value of the property that maps to the `featureLifetime` element.
`void`	`setHoldingPoint(TLcdAIXM51AbstractSegmentPoint aValue)` Sets the value of the property that maps to the `holdingPoint` element.
`void`	`setInterpretation(ELcdAIXM51Interpretation aValue)` Sets the value of the property that maps to the `interpretation` element.
`void`	`setSequenceNumber(long aValue)` Sets the value of the property that maps to the `sequenceNumber` element.
`void`	`setTimeSliceMetadata(TLcdAIXM51FeatureTimeSliceMetadataProperty aValue)` Sets the value of the property that maps to the `timeSliceMetadata` element.
`void`	`setUnplannedHolding(TLcdAIXM51CodeApproval aValue)` Sets the value of the property that maps to the `unplannedHolding` element.

Methods inherited from class com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMTimeSlice
clone, clone, collectShapes, contains2D, contains2D, contains3D, contains3D, getBeginValidTime, getBounds, getEndValidTime, getFocusPoint, getShape, getShapeCount, getTimeBounds, invalidateObject, setValue

Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimeSlice
getDataSource, getValidTime, setDataSource, setValidTime

Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML
getDescription, getDescriptionReference, getId, getIdentifier, getMetaDataProperty, getName, setDescription, setDescriptionReference, setId, setIdentifier

Methods inherited from class com.luciad.datamodel.TLcdDataObject
getDataType, getValue, getValue, hasValue, hasValue, setValue, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - UNPLANNED_HOLDING_PROPERTY
```
public static final TLcdDataProperty UNPLANNED_HOLDING_PROPERTY
```
    Data property that maps to the unplannedHolding element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeApproval>.
  - AUTHORIZED_ALTITUDE_PROPERTY
```
public static final TLcdDataProperty AUTHORIZED_ALTITUDE_PROPERTY
```
    Data property that maps to the authorizedAltitude element. The possible values for this property are instances of TLcdAIXM51ValDistanceVertical.
  - ALTITUDE_REFERENCE_PROPERTY
```
public static final TLcdDataProperty ALTITUDE_REFERENCE_PROPERTY
```
    Data property that maps to the altitudeReference element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeVerticalReference>.
  - CONTROLLED_AIRSPACE_PROPERTY
```
public static final TLcdDataProperty CONTROLLED_AIRSPACE_PROPERTY
```
    Data property that maps to the controlledAirspace element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeYesNo>.
  - HOLDING_POINT_PROPERTY
```
public static final TLcdDataProperty HOLDING_POINT_PROPERTY
```
    Data property that maps to the holdingPoint element. The possible values for this property are instances of TLcdAIXM51Property<TLcdAIXM51AbstractSegmentPoint>.
  - 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>>.
  - 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>>.
  - INTERPRETATION_PROPERTY
```
public static final TLcdDataProperty INTERPRETATION_PROPERTY
```
    Data property that maps to the interpretation element. The possible values for this property are instances of ELcdAIXM51Interpretation.
  - SEQUENCE_NUMBER_PROPERTY
```
public static final TLcdDataProperty SEQUENCE_NUMBER_PROPERTY
```
    Data property that maps to the sequenceNumber element. The possible values for this property are instances of long.
  - CORRECTION_NUMBER_PROPERTY
```
public static final TLcdDataProperty CORRECTION_NUMBER_PROPERTY
```
    Data property that maps to the correctionNumber element. The possible values for this property are instances of long.
  - TIME_SLICE_METADATA_PROPERTY
```
public static final TLcdDataProperty TIME_SLICE_METADATA_PROPERTY
```
    Data property that maps to the timeSliceMetadata element. The possible values for this property are instances of TLcdAIXM51FeatureTimeSliceMetadataProperty.
  - FEATURE_LIFETIME_PROPERTY
```
public static final TLcdDataProperty FEATURE_LIFETIME_PROPERTY
```
    Data property that maps to the featureLifetime element. The possible values for this property are instances of TLcdGML32TimePrimitiveProperty.
- Constructor Detail
  - TLcdAIXM51UnplannedHoldingTimeSlice
```
public TLcdAIXM51UnplannedHoldingTimeSlice()
```
  - TLcdAIXM51UnplannedHoldingTimeSlice
```
public TLcdAIXM51UnplannedHoldingTimeSlice(TLcdDataType aType)
```
- Method Detail
  - getUnplannedHolding
```
public TLcdAIXM51CodeApproval getUnplannedHolding()
```
    Returns the role value contained in the value of the UNPLANNED_HOLDING_PROPERTY property. Returns null if the value of the UNPLANNED_HOLDING_PROPERTY property is null.
    Indicates if the holding pattern is used as an unplanned holding. Note: Enroute use only.
    
    Returns:
    
    the role value of the UNPLANNED_HOLDING_PROPERTY property.
    
    See Also:
    
    TLcdAIXM51Optional
  - setUnplannedHolding
```
public void setUnplannedHolding(TLcdAIXM51CodeApproval aValue)
```
    Sets the value of the property that maps to the unplannedHolding 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 UNPLANNED_HOLDING_PROPERTY property is set to null.
    Indicates if the holding pattern is used as an unplanned holding. Note: Enroute use only.
    
    Parameters:
    
    aValue - the role value to set for the UNPLANNED_HOLDING_PROPERTY property.
  - getAuthorizedAltitude
```
public TLcdAIXM51ValDistanceVertical getAuthorizedAltitude()
```
    Returns the value of the property that maps to the authorizedAltitude element.
    value of the altitude approved based on unplanned holding assessment.
    
    Returns:
    
    the value of the AUTHORIZED_ALTITUDE_PROPERTY property.
  - setAuthorizedAltitude
```
public void setAuthorizedAltitude(TLcdAIXM51ValDistanceVertical aValue)
```
    Sets the value of the property that maps to the authorizedAltitude element.
    value of the altitude approved based on unplanned holding assessment.
    
    Parameters:
    
    aValue - the value to set for the AUTHORIZED_ALTITUDE_PROPERTY property.
  - getAltitudeReference
```
public TLcdAIXM51CodeVerticalReference getAltitudeReference()
```
    Returns the role value contained in the value of the ALTITUDE_REFERENCE_PROPERTY property. Returns null if the value of the ALTITUDE_REFERENCE_PROPERTY property is null.
    Indicates: "HEI" = The distance measured from the ground,(AGL) "ALT" = The distance measured from mean sea level (MSL)
    
    Returns:
    
    the role value of the ALTITUDE_REFERENCE_PROPERTY property.
    
    See Also:
    
    TLcdAIXM51Optional
  - setAltitudeReference
```
public void setAltitudeReference(TLcdAIXM51CodeVerticalReference aValue)
```
    Sets the value of the property that maps to the altitudeReference 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 ALTITUDE_REFERENCE_PROPERTY property is set to null.
    Indicates: "HEI" = The distance measured from the ground,(AGL) "ALT" = The distance measured from mean sea level (MSL)
    
    Parameters:
    
    aValue - the role value to set for the ALTITUDE_REFERENCE_PROPERTY property.
  - getControlledAirspace
```
public TLcdAIXM51CodeYesNo getControlledAirspace()
```
    Returns the role value contained in the value of the CONTROLLED_AIRSPACE_PROPERTY property. Returns null if the value of the CONTROLLED_AIRSPACE_PROPERTY property is null.
    Indicates unplanned holding is completely contained within controlled airspace.
    
    Returns:
    
    the role value of the CONTROLLED_AIRSPACE_PROPERTY property.
    
    See Also:
    
    TLcdAIXM51Optional
  - setControlledAirspace
```
public void setControlledAirspace(TLcdAIXM51CodeYesNo aValue)
```
    Sets the value of the property that maps to the controlledAirspace 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 CONTROLLED_AIRSPACE_PROPERTY property is set to null.
    Indicates unplanned holding is completely contained within controlled airspace.
    
    Parameters:
    
    aValue - the role value to set for the CONTROLLED_AIRSPACE_PROPERTY property.
  - getHoldingPoint
```
public TLcdAIXM51AbstractSegmentPoint getHoldingPoint()
```
    Returns the role value contained in the value of the HOLDING_POINT_PROPERTY property. Returns null if the value of the HOLDING_POINT_PROPERTY property is null.
    Point used to evaluate safe holding.
    
    Returns:
    
    the role value of the HOLDING_POINT_PROPERTY property.
    
    See Also:
    
    TLcdAIXM51Property
  - setHoldingPoint
```
public void setHoldingPoint(TLcdAIXM51AbstractSegmentPoint aValue)
```
    Sets the value of the property that maps to the holdingPoint element. to a new instance of the association class TLcdAIXM51Property initialized with the given role value. In case the given role value is null, the HOLDING_POINT_PROPERTY property is set to null.
    Point used to evaluate safe holding.
    
    Parameters:
    
    aValue - the role value to set for the HOLDING_POINT_PROPERTY property.
  - getAnnotation
```
public List<TLcdAIXM51Note> getAnnotation()
```
    Gets the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
    
    Returns:
    
    the value of the ANNOTATION_PROPERTY property adapted to a list of TLcdAIXM51Note instances.
    
    See Also:
    
    TLcdAIXM51Property
  - 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:
    
    TLcdAIXM51Link
  - getInterpretation
```
public ELcdAIXM51Interpretation getInterpretation()
```
    Returns the value of the property that maps to the interpretation element.
    Property indicating how the timeslice is to be interpreted. See the AIXM Temporality model for details.
    
    Returns:
    
    the value of the INTERPRETATION_PROPERTY property.
  - setInterpretation
```
public void setInterpretation(ELcdAIXM51Interpretation aValue)
```
    Sets the value of the property that maps to the interpretation element.
    Property indicating how the timeslice is to be interpreted. See the AIXM Temporality model for details.
    
    Parameters:
    
    aValue - the value to set for the INTERPRETATION_PROPERTY property.
  - getSequenceNumber
```
public long getSequenceNumber()
```
    Returns the value of the property that maps to the sequenceNumber element.
    Used for the identification of the Time Slice concerned. See the AIXM Temporality model for details.
    
    Returns:
    
    the value of the SEQUENCE_NUMBER_PROPERTY property.
  - setSequenceNumber
```
public void setSequenceNumber(long aValue)
```
    Sets the value of the property that maps to the sequenceNumber element.
    Used for the identification of the Time Slice concerned. See the AIXM Temporality model for details.
    
    Parameters:
    
    aValue - the value to set for the SEQUENCE_NUMBER_PROPERTY property.
  - getCorrectionNumber
```
public long getCorrectionNumber()
```
    Returns the value of the property that maps to the correctionNumber element.
    Used for indicating the order of the corrections of a Time Slice. See the AIXM Temporality model for details.
    
    Returns:
    
    the value of the CORRECTION_NUMBER_PROPERTY property.
  - setCorrectionNumber
```
public void setCorrectionNumber(long aValue)
```
    Sets the value of the property that maps to the correctionNumber element.
    Used for indicating the order of the corrections of a Time Slice. See the AIXM Temporality model for details.
    
    Parameters:
    
    aValue - the value to set for the CORRECTION_NUMBER_PROPERTY property.
  - getTimeSliceMetadata
```
public TLcdAIXM51FeatureTimeSliceMetadataProperty getTimeSliceMetadata()
```
    Returns the value of the property that maps to the timeSliceMetadata element.
    
    Returns:
    
    the value of the TIME_SLICE_METADATA_PROPERTY property.
  - setTimeSliceMetadata
```
public void setTimeSliceMetadata(TLcdAIXM51FeatureTimeSliceMetadataProperty aValue)
```
    Sets the value of the property that maps to the timeSliceMetadata element.
    
    Parameters:
    
    aValue - the value to set for the TIME_SLICE_METADATA_PROPERTY property.
  - getFeatureLifetime
```
public TLcdGML32AbstractTimePrimitive getFeatureLifetime()
```
    Returns the value of the property that maps to the featureLifetime element.
    The start and end of life of the feature. See the AIXM Temporality model for details.
    
    Returns:
    
    the value of the FEATURE_LIFETIME_PROPERTY property.
    
    See Also:
    
    TLcdGML32TimePrimitiveProperty
  - setFeatureLifetime
```
public void setFeatureLifetime(TLcdGML32AbstractTimePrimitive aValue)
```
    Sets the value of the property that maps to the featureLifetime element.
    The start and end of life of the feature. See the AIXM Temporality model for details.
    
    Parameters:
    
    aValue - the value to set for the FEATURE_LIFETIME_PROPERTY property.

Aviation StandardsClass TLcdAIXM51UnplannedHoldingTimeSlice

Field Summary

Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimeSlice

Fields inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML

Constructor Summary

Method Summary

Methods inherited from class com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMTimeSlice

Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractTimeSlice

Methods inherited from class com.luciad.format.gml32.model.TLcdGML32AbstractGML

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

UNPLANNED_HOLDING_PROPERTY

AUTHORIZED_ALTITUDE_PROPERTY

ALTITUDE_REFERENCE_PROPERTY

CONTROLLED_AIRSPACE_PROPERTY

HOLDING_POINT_PROPERTY

ANNOTATION_PROPERTY

EXTENSION_PROPERTY

INTERPRETATION_PROPERTY

SEQUENCE_NUMBER_PROPERTY

CORRECTION_NUMBER_PROPERTY

TIME_SLICE_METADATA_PROPERTY

FEATURE_LIFETIME_PROPERTY

Constructor Detail

TLcdAIXM51UnplannedHoldingTimeSlice

TLcdAIXM51UnplannedHoldingTimeSlice

Method Detail

getUnplannedHolding

setUnplannedHolding

getAuthorizedAltitude

setAuthorizedAltitude

getAltitudeReference

setAltitudeReference

getControlledAirspace

setControlledAirspace

getHoldingPoint

setHoldingPoint

getAnnotation

getExtension

getInterpretation

setInterpretation

getSequenceNumber

setSequenceNumber

getCorrectionNumber

setCorrectionNumber

getTimeSliceMetadata

setTimeSliceMetadata

getFeatureLifetime

setFeatureLifetime