Documentation
¶
Index ¶
- func NewGoogleOptimizationClient(ctx context.Context, retryOpts helper.RetryOptions, ...) (contract.GoogleRouteOptimization, error)
- type Client
- type ClientOption
- type ClientOptions
- type DefaultTool
- type Dependencies
- type Loaded
- type OptimizeToursOption
- func WithOptimizeToursConsiderTraffic(x bool) OptimizeToursOption
- func WithOptimizeToursDestinations(x []destination.Destination) OptimizeToursOption
- func WithOptimizeToursFrom(x date.Date) OptimizeToursOption
- func WithOptimizeToursPopulatePolylines(x bool) OptimizeToursOption
- func WithOptimizeToursRoundToNearest(x time.Duration) OptimizeToursOption
- func WithOptimizeToursRouteID(x contract.ID) OptimizeToursOption
- func WithOptimizeToursStartEarly(x bool) OptimizeToursOption
- func WithOptimizeToursStartPlaceID(x string) OptimizeToursOption
- func WithOptimizeToursTo(x date.Date) OptimizeToursOption
- func WithOptimizeToursUseGeodesicDistances(x bool) OptimizeToursOption
- func WithOptimizeToursVehicleStartTimeWindowInMinutes(x time.Duration) OptimizeToursOption
- func WithOptimizeToursVehicles(x []vehicle.Vehicle) OptimizeToursOption
- type OptimizeToursOptions
- type RouteOptimizationClientOptions
- type RouteOptimizationOperator
- type Tool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewGoogleOptimizationClient ¶
func NewGoogleOptimizationClient(ctx context.Context, retryOpts helper.RetryOptions, opts RouteOptimizationClientOptions) (contract.GoogleRouteOptimization, error)
Types ¶
type Client ¶
type Client interface {
contract.CloserWithCtx
RouteOptimizationOperator
}
func NewClient ¶
func NewClient(d Dependencies, opts ClientOptions) (Client, error)
func NewNoopClient ¶ added in v0.1.859
func NewNoopClient() Client
type ClientOption ¶
type ClientOption = contract.Opt[ClientOptions]
func WithLoaded ¶ added in v0.1.781
func WithLoaded(x Loaded) ClientOption
type ClientOptions ¶
type ClientOptions struct {
Loaded
}
func ApplyClientOptions ¶
func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
type DefaultTool ¶ added in v0.1.781
func NewTool ¶ added in v0.1.781
func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
func (*DefaultTool) Close ¶ added in v0.1.781
func (d *DefaultTool) Close(ctx context.Context) error
Close closes the underlying client.
func (*DefaultTool) OptimizeTours ¶ added in v0.1.781
func (d *DefaultTool) OptimizeTours(ctx context.Context, opts OptimizeToursOptions) (*itinerary.Itinerary, error)
OptimizeTours computes an optimized multi-stop itinerary for the given inputs.
type Dependencies ¶
type Dependencies struct {
C contract.GoogleRouteOptimization
G contract.Geocoder
}
type OptimizeToursOption ¶ added in v0.1.781
type OptimizeToursOption = contract.Opt[OptimizeToursOptions]
func WithOptimizeToursConsiderTraffic ¶ added in v0.1.781
func WithOptimizeToursConsiderTraffic(x bool) OptimizeToursOption
func WithOptimizeToursDestinations ¶ added in v0.1.781
func WithOptimizeToursDestinations(x []destination.Destination) OptimizeToursOption
func WithOptimizeToursFrom ¶ added in v0.1.781
func WithOptimizeToursFrom(x date.Date) OptimizeToursOption
func WithOptimizeToursPopulatePolylines ¶ added in v0.1.781
func WithOptimizeToursPopulatePolylines(x bool) OptimizeToursOption
func WithOptimizeToursRoundToNearest ¶ added in v0.1.781
func WithOptimizeToursRoundToNearest(x time.Duration) OptimizeToursOption
func WithOptimizeToursRouteID ¶ added in v0.1.781
func WithOptimizeToursRouteID(x contract.ID) OptimizeToursOption
func WithOptimizeToursStartEarly ¶ added in v0.1.781
func WithOptimizeToursStartEarly(x bool) OptimizeToursOption
func WithOptimizeToursStartPlaceID ¶ added in v0.1.781
func WithOptimizeToursStartPlaceID(x string) OptimizeToursOption
func WithOptimizeToursTo ¶ added in v0.1.781
func WithOptimizeToursTo(x date.Date) OptimizeToursOption
func WithOptimizeToursUseGeodesicDistances ¶ added in v0.1.781
func WithOptimizeToursUseGeodesicDistances(x bool) OptimizeToursOption
func WithOptimizeToursVehicleStartTimeWindowInMinutes ¶ added in v0.1.781
func WithOptimizeToursVehicleStartTimeWindowInMinutes(x time.Duration) OptimizeToursOption
func WithOptimizeToursVehicles ¶ added in v0.1.781
func WithOptimizeToursVehicles(x []vehicle.Vehicle) OptimizeToursOption
type OptimizeToursOptions ¶ added in v0.1.781
type OptimizeToursOptions struct {
RouteID contract.ID
StartPlaceID string
From date.Date
To date.Date
VehiclesStartTimeWindowInMinutes time.Duration
RoundToNearest time.Duration
Vehicles []vehicle.Vehicle
Destinations []destination.Destination
ConsiderTraffic bool
StartEarly bool
PopulatePolylines bool
UseGeodesicDistances bool
}
func ApplyOptimizeToursOptions ¶ added in v0.1.781
func ApplyOptimizeToursOptions(opts *OptimizeToursOptions, modifiers ...OptimizeToursOption) OptimizeToursOptions
func (*OptimizeToursOptions) Validate ¶ added in v0.1.781
func (o *OptimizeToursOptions) Validate() error
type RouteOptimizationClientOptions ¶
type RouteOptimizationClientOptions struct {
Loaded
}
type RouteOptimizationOperator ¶ added in v0.1.781
Click to show internal directories.
Click to hide internal directories.