ElectronicHorizonPath (API Reference)
Class ElectronicHorizonPath
Represents a single electronic horizon path.
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
Field Summary
FieldsModifier and TypeFieldDescriptionintThe level of this path.The index of the parent path.The index of the parent segment in the parent path.doubleThe probability of this electronic horizon path, where a value of 1 represents the most-preferred path and a value of 0 represents an unlikely path.The ordered list of segments in this path. -
Constructor Summary
ConstructorsConstructorDescriptionElectronicHorizonPath(List<ElectronicHorizonSegment> segments, double probability, int level) Creates a new instance. -
Method Summary
-
Field Details
-
parentPathIndex
The index of the parent path. Index 0 marks the most-preferred path.
-
parentSegmentIndex
The index of the parent segment in the parent path. This value is
nullif the path is the most-preferred path. -
segments
The ordered list of segments in this path. The list can be empty when no segments are available for the current path.
-
probability
public double probabilityThe probability of this electronic horizon path, where a value of 1 represents the most-preferred path and a value of 0 represents an unlikely path.
-
level
public int levelThe level of this path. A value of 0 represents the most-preferred path.
-
-
Constructor Details
-
ElectronicHorizonPath
public ElectronicHorizonPath(@NonNull List<ElectronicHorizonSegment> segments, double probability, int level) Creates a new instance.
Offline availability: This property is available online and offline.
- Parameters:
segments-The ordered list of segments in this path. The list can be empty when no segments are available for the current path.
probability-The probability of this electronic horizon path, where a value of 1 represents the most-preferred path and a value of 0 represents an unlikely path.
level-The level of this path. A value of 0 represents the most-preferred path.
-
-
Method Details