Package com.cercalia.sdk.model.isochrone

Class IsochroneOptions

java.lang.Object

com.cercalia.sdk.model.isochrone.IsochroneOptions

public final class IsochroneOptions
extends Object

Options for isochrone calculation.

Example usage:

 IsochroneOptions options = IsochroneOptions.builder()
     .value(15)
     .weight(IsochroneWeight.TIME)
     .method(IsochroneMethod.CONCAVEHULL)
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IsochroneOptions.Builder	Builder for IsochroneOptions.

Method Summary

Modifier and Type	Method	Description
static @NotNull IsochroneOptions.Builder	builder()	Creates new IsochroneOptions builder.
static @NotNull IsochroneOptions	distance(int meters)	Creates options for distance-based isochrone.
@NotNull IsochroneMethod	getMethod()
int	getValue()
@NotNull IsochroneWeight	getWeight()
static @NotNull IsochroneOptions	time(int minutes)	Creates options for time-based isochrone.

Methods inherited from class java.lang.Object

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

Method Details

getValue

public int getValue()

Returns:

Value in minutes or meters.

getWeight

@NotNull
public @NotNull IsochroneWeight getWeight()

Returns:

Weight type. Defaults to IsochroneWeight.TIME.

getMethod

@NotNull
public @NotNull IsochroneMethod getMethod()

Returns:

Polygon calculation method. Defaults to IsochroneMethod.CONCAVEHULL.

time

@NotNull
public static @NotNull IsochroneOptions time(int minutes)

Creates options for time-based isochrone.

Parameters:

minutes - The time in minutes.

Returns:

A new IsochroneOptions instance.

distance

@NotNull
public static @NotNull IsochroneOptions distance(int meters)

Creates options for distance-based isochrone.

Parameters:

meters - The distance in meters.

Returns:

A new IsochroneOptions instance.

builder

@NotNull
public static @NotNull IsochroneOptions.Builder builder()

Creates new IsochroneOptions builder.

Returns:

A new builder instance.