ConfigurableProfile

java.lang.Object
- agi.foundation.routedesign.advanced.ConfigurableProfile

Direct Known Subclasses:

StaticRouteProfile.StaticConfigurableProfile
```
public abstract class ConfigurableProfile
extends Object
```
A configurable profile is used by the RoutePropagator to ensure that the route heights and speeds are continuous from one segment to the next.

Constructor Summary

Constructors
Modifier Constructor and Description

protected ConfigurableProfile()
Initializes a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`ConfigurableProfile()` Initializes a new instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract ProfileConfigurationResult`	`configureProfiles(ConfigurableProfile previous, ConfigurableProfile next, ITrackCalculationProgress tracker)` Configure this profile in relation to the previous and next profile to make sure than they each connect continuously.
`abstract void`	`freezeFinalConditions()` Called by the `RoutePropagator` to indicate to the profile that it should not let other profiles update its final boundary conditions.
`abstract void`	`freezeInitialConditions()` Called by the `RoutePropagator` to indicate to the profile that it should not let other profiles update its initial boundary conditions.
`abstract boolean`	`getAllowModificationOfFinalHeight()` Gets a value indicating whether to allow other profiles to modify the final height of this profile in order to ensure continuity.
`abstract boolean`	`getAllowModificationOfFinalHeightRate()` Gets a value indicating whether to allow other profiles to modify the final height rate of this profile in order to ensure continuity.
`abstract boolean`	`getAllowModificationOfFinalSpeed()` Gets a value indicating whether to allow other profiles to modify the final speed of this profile in order to ensure continuity.
`abstract boolean`	`getAllowModificationOfInitialHeight()` Gets a value indicating whether to allow other profiles to modify the initial height of this profile in order to ensure continuity.
`abstract boolean`	`getAllowModificationOfInitialHeightRate()` Gets a value indicating whether to allow other profiles to modify the initial height rate of this profile in order to ensure continuity.
`abstract boolean`	`getAllowModificationOfInitialSpeed()` Gets a value indicating whether to allow other profiles to modify the initial speed of this profile in order to ensure continuity.
`abstract double`	`getFinalHeight()` Gets the final height of this profile above the reference surface.
`abstract double`	`getFinalHeightRate()` Gets the final height rate for this profile.
`abstract ProfileSpeed`	`getFinalSpeed()` Gets the final speed for this profile.
`abstract TerrainProvider`	`getHeightReferenceSurface()` Gets the reference terrain surface from which the height is measured.
`abstract double`	`getInitialHeight()` Gets the initial height of this profile above the reference surface.
`abstract double`	`getInitialHeightRate()` Gets the initial height rate for this profile.
`abstract ProfileSpeed`	`getInitialSpeed()` Gets the initial speed for this profile.
`double`	`getProfileComputationalWeight()` Gets a scalar value indicating how expensive the configuration of this profile is.
`abstract ProfileSegment`	`getProfileSegment()` Get the time dynamic geometry of the profile after configuration.
`abstract double`	`getTargetFinalHeight()` Gets the final height that this profile will attempt to target.
`abstract double`	`getTargetFinalHeightRate()` Gets the final height rate that this profile will attempt to target.
`abstract ProfileSpeed`	`getTargetFinalSpeed()` Gets the final speed that this profile will attempt to target.
`abstract double`	`getTargetInitialHeight()` Gets the initial height that this profile will attempt to target.
`abstract double`	`getTargetInitialHeightRate()` Gets the initial height rate that this profile will attempt to target.
`abstract ProfileSpeed`	`getTargetInitialSpeed()` Gets the initial speed that this profile will attempt to target.
`abstract void`	`setFinalHeight(double value)` Sets the final height of this profile above the reference surface.
`abstract void`	`setFinalHeightRate(double value)` Sets the final height rate for this profile.
`abstract void`	`setFinalSpeed(ProfileSpeed value)` Sets the final speed for this profile.
`abstract void`	`setInitialHeight(double value)` Sets the initial height of this profile above the reference surface.
`abstract void`	`setInitialHeightRate(double value)` Sets the initial height rate for this profile.
`abstract void`	`setInitialSpeed(ProfileSpeed value)` Sets the initial speed for this profile.

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

- Constructor Detail
  - ConfigurableProfile
```
protected ConfigurableProfile()
```
    Initializes a new instance.
- Method Detail
  - getProfileSegment
```
public abstract ProfileSegment getProfileSegment()
```
    Get the time dynamic geometry of the profile after configuration.
    
    Returns:
    
    The time dynamic geometry of the profile.
  - configureProfiles
```
@Nonnull
public abstract ProfileConfigurationResult configureProfiles(@Nullable
                                                                       ConfigurableProfile previous,
                                                                       @Nullable
                                                                       ConfigurableProfile next,
                                                                       @Nullable
                                                                       ITrackCalculationProgress tracker)
```
    Configure this profile in relation to the previous and next profile to make sure than they each connect continuously. Specify the result of the configuration in the output.
    
    Parameters:
    
    previous - The previous profile to configure.
    
    next - The next profile to configure.
    
    tracker - A progress tracker to track the progress of the route configuration, or null.
    
    Returns:
    
    An object indicating the status and diagnostic result from the configuration.
  - getInitialHeight
```
public abstract double getInitialHeight()
```
    Gets the initial height of this profile above the reference surface.
  - setInitialHeight
```
public abstract void setInitialHeight(double value)
```
    Sets the initial height of this profile above the reference surface.
  - getFinalHeight
```
public abstract double getFinalHeight()
```
    Gets the final height of this profile above the reference surface.
  - setFinalHeight
```
public abstract void setFinalHeight(double value)
```
    Sets the final height of this profile above the reference surface.
  - getTargetInitialHeight
```
public abstract double getTargetInitialHeight()
```
    Gets the initial height that this profile will attempt to target. If the parameters for platform dynamics or the geometry specified for this profile are insufficient to satisfy the given target, the profile will get as close as it can and then the surrounding connections will attempt to make up the difference.
  - getTargetFinalHeight
```
public abstract double getTargetFinalHeight()
```
    Gets the final height that this profile will attempt to target. If the parameters for platform dynamics or the geometry specified for this profile are insufficient to satisfy the given target, the profile will get as close as it can and then the surrounding connections will attempt to make up the difference.
  - getHeightReferenceSurface
```
public abstract TerrainProvider getHeightReferenceSurface()
```
    Gets the reference terrain surface from which the height is measured.
  - getAllowModificationOfInitialHeight
```
public abstract boolean getAllowModificationOfInitialHeight()
```
    Gets a value indicating whether to allow other profiles to modify the initial height of this profile in order to ensure continuity.
  - getAllowModificationOfFinalHeight
```
public abstract boolean getAllowModificationOfFinalHeight()
```
    Gets a value indicating whether to allow other profiles to modify the final height of this profile in order to ensure continuity.
  - getInitialSpeed
```
public abstract ProfileSpeed getInitialSpeed()
```
    Gets the initial speed for this profile.
  - setInitialSpeed
```
public abstract void setInitialSpeed(ProfileSpeed value)
```
    Sets the initial speed for this profile.
  - getFinalSpeed
```
public abstract ProfileSpeed getFinalSpeed()
```
    Gets the final speed for this profile.
  - setFinalSpeed
```
public abstract void setFinalSpeed(ProfileSpeed value)
```
    Sets the final speed for this profile.
  - getTargetInitialSpeed
```
public abstract ProfileSpeed getTargetInitialSpeed()
```
    Gets the initial speed that this profile will attempt to target. If the parameters for platform dynamics or the geometry specified for this profile are insufficient to satisfy the given target, the profile will get as close as it can and then the surrounding connections will attempt to make up the difference.
  - getTargetFinalSpeed
```
public abstract ProfileSpeed getTargetFinalSpeed()
```
    Gets the final speed that this profile will attempt to target. If the parameters for platform dynamics or the geometry specified for this profile are insufficient to satisfy the given target, the profile will get as close as it can and then the surrounding connections will attempt to make up the difference.
  - getAllowModificationOfInitialSpeed
```
public abstract boolean getAllowModificationOfInitialSpeed()
```
    Gets a value indicating whether to allow other profiles to modify the initial speed of this profile in order to ensure continuity.
  - getAllowModificationOfFinalSpeed
```
public abstract boolean getAllowModificationOfFinalSpeed()
```
    Gets a value indicating whether to allow other profiles to modify the final speed of this profile in order to ensure continuity.
  - getInitialHeightRate
```
public abstract double getInitialHeightRate()
```
    Gets the initial height rate for this profile.
  - setInitialHeightRate
```
public abstract void setInitialHeightRate(double value)
```
    Sets the initial height rate for this profile.
  - getFinalHeightRate
```
public abstract double getFinalHeightRate()
```
    Gets the final height rate for this profile.
  - setFinalHeightRate
```
public abstract void setFinalHeightRate(double value)
```
    Sets the final height rate for this profile.
  - getTargetInitialHeightRate
```
public abstract double getTargetInitialHeightRate()
```
    Gets the initial height rate that this profile will attempt to target. If the parameters for platform dynamics or the geometry specified for this profile are insufficient to satisfy the given target, the profile will get as close as it can and then the surrounding connections will attempt to make up the difference.
  - getTargetFinalHeightRate
```
public abstract double getTargetFinalHeightRate()
```
    Gets the final height rate that this profile will attempt to target. If the parameters for platform dynamics or the geometry specified for this profile are insufficient to satisfy the given target, the profile will get as close as it can and then the surrounding connections will attempt to make up the difference.
  - getAllowModificationOfInitialHeightRate
```
public abstract boolean getAllowModificationOfInitialHeightRate()
```
    Gets a value indicating whether to allow other profiles to modify the initial height rate of this profile in order to ensure continuity.
  - getAllowModificationOfFinalHeightRate
```
public abstract boolean getAllowModificationOfFinalHeightRate()
```
    Gets a value indicating whether to allow other profiles to modify the final height rate of this profile in order to ensure continuity.
  - getProfileComputationalWeight
```
public double getProfileComputationalWeight()
```
    Gets a scalar value indicating how expensive the configuration of this profile is. This is used to indicate to the ITrackCalculationProgress instance fed to the RoutePropagator that certain profiles will take longer than others (larger computational weight).
  - freezeInitialConditions
```
public abstract void freezeInitialConditions()
```
    Called by the RoutePropagator to indicate to the profile that it should not let other profiles update its initial boundary conditions.
  - freezeFinalConditions
```
public abstract void freezeFinalConditions()
```
    Called by the RoutePropagator to indicate to the profile that it should not let other profiles update its final boundary conditions.

Class ConfigurableProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getProfileSegment

configureProfiles

getInitialHeight

setInitialHeight

getFinalHeight

setFinalHeight

getTargetInitialHeight

getTargetFinalHeight

getHeightReferenceSurface

getAllowModificationOfInitialHeight

getAllowModificationOfFinalHeight

getInitialSpeed

setInitialSpeed

getFinalSpeed

setFinalSpeed

getTargetInitialSpeed

getTargetFinalSpeed

getAllowModificationOfInitialSpeed

getAllowModificationOfFinalSpeed

getInitialHeightRate

setInitialHeightRate

getFinalHeightRate

setFinalHeightRate

getTargetInitialHeightRate

getTargetFinalHeightRate

getAllowModificationOfInitialHeightRate

getAllowModificationOfFinalHeightRate

getProfileComputationalWeight

freezeInitialConditions

freezeFinalConditions