agi.foundation.routedesign.advanced

Class StaticRouteProfile.StaticConfigurableProfile

java.lang.Object

agi.foundation.routedesign.advanced.ConfigurableProfile

agi.foundation.routedesign.advanced.StaticRouteProfile.StaticConfigurableProfile

Enclosing class:

StaticRouteProfile

public static class StaticRouteProfile.StaticConfigurableProfile
extends ConfigurableProfile

A helper class which takes a ProfileSegment and a SurfaceSegment which correspond to each other and indicates to the route design system to disallow any modification of the user's geometry.

Constructor Summary

Constructors

Constructor and Description
StaticConfigurableProfile(ProfileSegment segment, SurfaceSegment path) Create a new instance based on the specified predefined geometry.

Method Summary

Modifier and Type	Method and Description
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.
void	freezeFinalConditions() Called by the RoutePropagator to indicate to the profile that it should not let other profiles update its final boundary conditions.
void	freezeInitialConditions() Called by the RoutePropagator to indicate to the profile that it should not let other profiles update its initial boundary conditions.
boolean	getAllowModificationOfFinalHeight() Gets a value indicating whether to allow other profiles to modify the final height of this profile in order to ensure continuity.
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.
boolean	getAllowModificationOfFinalSpeed() Gets a value indicating whether to allow other profiles to modify the final speed of this profile in order to ensure continuity.
boolean	getAllowModificationOfInitialHeight() Gets a value indicating whether to allow other profiles to modify the initial height of this profile in order to ensure continuity.
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.
boolean	getAllowModificationOfInitialSpeed() Gets a value indicating whether to allow other profiles to modify the initial speed of this profile in order to ensure continuity.
double	getFinalHeight() Gets the final height of this profile above the reference surface.
double	getFinalHeightRate() Gets the final height rate for this profile.
ProfileSpeed	getFinalSpeed() Gets the final speed for this profile.
TerrainProvider	getHeightReferenceSurface() Gets the reference terrain surface from which the height is measured.
double	getInitialHeight() Gets the initial height of this profile above the reference surface.
double	getInitialHeightRate() Gets the initial height rate for this profile.
ProfileSpeed	getInitialSpeed() Gets the initial speed for this profile.
ProfileSegment	getProfileSegment() Get the time dynamic geometry of the profile after configuration.
double	getTargetFinalHeight() Gets the final height that this profile will attempt to target.
double	getTargetFinalHeightRate() Gets the final height rate that this profile will attempt to target.
ProfileSpeed	getTargetFinalSpeed() Gets the final speed that this profile will attempt to target.
double	getTargetInitialHeight() Gets the initial height that this profile will attempt to target.
double	getTargetInitialHeightRate() Gets the initial height rate that this profile will attempt to target.
ProfileSpeed	getTargetInitialSpeed() Gets the initial speed that this profile will attempt to target.
void	setFinalHeight(double value) Sets the final height of this profile above the reference surface.
void	setFinalHeightRate(double value) Sets the final height rate for this profile.
void	setFinalSpeed(ProfileSpeed value) Sets the final speed for this profile.
void	setInitialHeight(double value) Sets the initial height of this profile above the reference surface.
void	setInitialHeightRate(double value) Sets the initial height rate for this profile.
void	setInitialSpeed(ProfileSpeed value) Sets the initial speed for this profile.

Methods inherited from class agi.foundation.routedesign.advanced.ConfigurableProfile

getProfileComputationalWeight

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticConfigurableProfile

public StaticConfigurableProfile(ProfileSegment segment,
                                 SurfaceSegment path)

Create a new instance based on the specified predefined geometry.

Parameters:

segment - The profile geometry.

path - The surface path geometry

Method Detail

getProfileSegment

public ProfileSegment getProfileSegment()

Get the time dynamic geometry of the profile after configuration.

Specified by:

getProfileSegment in class ConfigurableProfile

Returns:

The time dynamic geometry of the profile.

configureProfiles

public 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. Specify the result of the configuration in the output.

Specified by:

configureProfiles in class ConfigurableProfile

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 double getInitialHeight()

Gets the initial height of this profile above the reference surface.

Specified by:

getInitialHeight in class ConfigurableProfile

setInitialHeight

public void setInitialHeight(double value)

Sets the initial height of this profile above the reference surface.

Specified by:

setInitialHeight in class ConfigurableProfile

getFinalHeight

public double getFinalHeight()

Gets the final height of this profile above the reference surface.

Specified by:

getFinalHeight in class ConfigurableProfile

setFinalHeight

public void setFinalHeight(double value)

Sets the final height of this profile above the reference surface.

Specified by:

setFinalHeight in class ConfigurableProfile

getTargetInitialHeight

public 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.

Specified by:

getTargetInitialHeight in class ConfigurableProfile

getTargetFinalHeight

public 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.

Specified by:

getTargetFinalHeight in class ConfigurableProfile

getHeightReferenceSurface

public TerrainProvider getHeightReferenceSurface()

Gets the reference terrain surface from which the height is measured.

Specified by:

getHeightReferenceSurface in class ConfigurableProfile

getAllowModificationOfInitialHeight

public boolean getAllowModificationOfInitialHeight()

Gets a value indicating whether to allow other profiles to modify the initial height of this profile in order to ensure continuity.

Specified by:

getAllowModificationOfInitialHeight in class ConfigurableProfile

getAllowModificationOfFinalHeight

public boolean getAllowModificationOfFinalHeight()

Gets a value indicating whether to allow other profiles to modify the final height of this profile in order to ensure continuity.

Specified by:

getAllowModificationOfFinalHeight in class ConfigurableProfile

getInitialSpeed

public ProfileSpeed getInitialSpeed()

Gets the initial speed for this profile.

Specified by:

getInitialSpeed in class ConfigurableProfile

setInitialSpeed

public void setInitialSpeed(ProfileSpeed value)

Sets the initial speed for this profile.

Specified by:

setInitialSpeed in class ConfigurableProfile

getFinalSpeed

public ProfileSpeed getFinalSpeed()

Gets the final speed for this profile.

Specified by:

getFinalSpeed in class ConfigurableProfile

setFinalSpeed

public void setFinalSpeed(ProfileSpeed value)

Sets the final speed for this profile.

Specified by:

setFinalSpeed in class ConfigurableProfile

getTargetInitialSpeed

public 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.

Specified by:

getTargetInitialSpeed in class ConfigurableProfile

getTargetFinalSpeed

public 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.

Specified by:

getTargetFinalSpeed in class ConfigurableProfile

getAllowModificationOfInitialSpeed

public boolean getAllowModificationOfInitialSpeed()

Gets a value indicating whether to allow other profiles to modify the initial speed of this profile in order to ensure continuity.

Specified by:

getAllowModificationOfInitialSpeed in class ConfigurableProfile

getAllowModificationOfFinalSpeed

public boolean getAllowModificationOfFinalSpeed()

Gets a value indicating whether to allow other profiles to modify the final speed of this profile in order to ensure continuity.

Specified by:

getAllowModificationOfFinalSpeed in class ConfigurableProfile

getInitialHeightRate

public double getInitialHeightRate()

Gets the initial height rate for this profile.

Specified by:

getInitialHeightRate in class ConfigurableProfile

setInitialHeightRate

public void setInitialHeightRate(double value)

Sets the initial height rate for this profile.

Specified by:

setInitialHeightRate in class ConfigurableProfile

getFinalHeightRate

public double getFinalHeightRate()

Gets the final height rate for this profile.

Specified by:

getFinalHeightRate in class ConfigurableProfile

setFinalHeightRate

public void setFinalHeightRate(double value)

Sets the final height rate for this profile.

Specified by:

setFinalHeightRate in class ConfigurableProfile

getTargetInitialHeightRate

public 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.

Specified by:

getTargetInitialHeightRate in class ConfigurableProfile

getTargetFinalHeightRate

public 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.

Specified by:

getTargetFinalHeightRate in class ConfigurableProfile

getAllowModificationOfInitialHeightRate

public 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.

Specified by:

getAllowModificationOfInitialHeightRate in class ConfigurableProfile

getAllowModificationOfFinalHeightRate

public 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.

Specified by:

getAllowModificationOfFinalHeightRate in class ConfigurableProfile

freezeInitialConditions

public void freezeInitialConditions()

Called by the RoutePropagator to indicate to the profile that it should not let other profiles update its initial boundary conditions.

Specified by:

freezeInitialConditions in class ConfigurableProfile

freezeFinalConditions

public void freezeFinalConditions()

Called by the RoutePropagator to indicate to the profile that it should not let other profiles update its final boundary conditions.

Specified by:

freezeFinalConditions in class ConfigurableProfile