AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::LocationService::Model::CalculateRouteRequest Class Reference

#include <CalculateRouteRequest.h>

+ Inheritance diagram for Aws::LocationService::Model::CalculateRouteRequest:

Public Member Functions

 CalculateRouteRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetCalculatorName () const
 
bool CalculatorNameHasBeenSet () const
 
void SetCalculatorName (const Aws::String &value)
 
void SetCalculatorName (Aws::String &&value)
 
void SetCalculatorName (const char *value)
 
CalculateRouteRequestWithCalculatorName (const Aws::String &value)
 
CalculateRouteRequestWithCalculatorName (Aws::String &&value)
 
CalculateRouteRequestWithCalculatorName (const char *value)
 
const CalculateRouteCarModeOptionsGetCarModeOptions () const
 
bool CarModeOptionsHasBeenSet () const
 
void SetCarModeOptions (const CalculateRouteCarModeOptions &value)
 
void SetCarModeOptions (CalculateRouteCarModeOptions &&value)
 
CalculateRouteRequestWithCarModeOptions (const CalculateRouteCarModeOptions &value)
 
CalculateRouteRequestWithCarModeOptions (CalculateRouteCarModeOptions &&value)
 
bool GetDepartNow () const
 
bool DepartNowHasBeenSet () const
 
void SetDepartNow (bool value)
 
CalculateRouteRequestWithDepartNow (bool value)
 
const Aws::Vector< double > & GetDeparturePosition () const
 
bool DeparturePositionHasBeenSet () const
 
void SetDeparturePosition (const Aws::Vector< double > &value)
 
void SetDeparturePosition (Aws::Vector< double > &&value)
 
CalculateRouteRequestWithDeparturePosition (const Aws::Vector< double > &value)
 
CalculateRouteRequestWithDeparturePosition (Aws::Vector< double > &&value)
 
CalculateRouteRequestAddDeparturePosition (double value)
 
const Aws::Utils::DateTimeGetDepartureTime () const
 
bool DepartureTimeHasBeenSet () const
 
void SetDepartureTime (const Aws::Utils::DateTime &value)
 
void SetDepartureTime (Aws::Utils::DateTime &&value)
 
CalculateRouteRequestWithDepartureTime (const Aws::Utils::DateTime &value)
 
CalculateRouteRequestWithDepartureTime (Aws::Utils::DateTime &&value)
 
const Aws::Vector< double > & GetDestinationPosition () const
 
bool DestinationPositionHasBeenSet () const
 
void SetDestinationPosition (const Aws::Vector< double > &value)
 
void SetDestinationPosition (Aws::Vector< double > &&value)
 
CalculateRouteRequestWithDestinationPosition (const Aws::Vector< double > &value)
 
CalculateRouteRequestWithDestinationPosition (Aws::Vector< double > &&value)
 
CalculateRouteRequestAddDestinationPosition (double value)
 
const DistanceUnitGetDistanceUnit () const
 
bool DistanceUnitHasBeenSet () const
 
void SetDistanceUnit (const DistanceUnit &value)
 
void SetDistanceUnit (DistanceUnit &&value)
 
CalculateRouteRequestWithDistanceUnit (const DistanceUnit &value)
 
CalculateRouteRequestWithDistanceUnit (DistanceUnit &&value)
 
bool GetIncludeLegGeometry () const
 
bool IncludeLegGeometryHasBeenSet () const
 
void SetIncludeLegGeometry (bool value)
 
CalculateRouteRequestWithIncludeLegGeometry (bool value)
 
const TravelModeGetTravelMode () const
 
bool TravelModeHasBeenSet () const
 
void SetTravelMode (const TravelMode &value)
 
void SetTravelMode (TravelMode &&value)
 
CalculateRouteRequestWithTravelMode (const TravelMode &value)
 
CalculateRouteRequestWithTravelMode (TravelMode &&value)
 
const CalculateRouteTruckModeOptionsGetTruckModeOptions () const
 
bool TruckModeOptionsHasBeenSet () const
 
void SetTruckModeOptions (const CalculateRouteTruckModeOptions &value)
 
void SetTruckModeOptions (CalculateRouteTruckModeOptions &&value)
 
CalculateRouteRequestWithTruckModeOptions (const CalculateRouteTruckModeOptions &value)
 
CalculateRouteRequestWithTruckModeOptions (CalculateRouteTruckModeOptions &&value)
 
const Aws::Vector< Aws::Vector< double > > & GetWaypointPositions () const
 
bool WaypointPositionsHasBeenSet () const
 
void SetWaypointPositions (const Aws::Vector< Aws::Vector< double >> &value)
 
void SetWaypointPositions (Aws::Vector< Aws::Vector< double >> &&value)
 
CalculateRouteRequestWithWaypointPositions (const Aws::Vector< Aws::Vector< double >> &value)
 
CalculateRouteRequestWithWaypointPositions (Aws::Vector< Aws::Vector< double >> &&value)
 
CalculateRouteRequestAddWaypointPositions (const Aws::Vector< double > &value)
 
CalculateRouteRequestAddWaypointPositions (Aws::Vector< double > &&value)
 
- Public Member Functions inherited from Aws::LocationService::LocationServiceRequest
virtual ~LocationServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::LocationService::LocationServiceRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file CalculateRouteRequest.h.

Constructor & Destructor Documentation

◆ CalculateRouteRequest()

Aws::LocationService::Model::CalculateRouteRequest::CalculateRouteRequest ( )

Member Function Documentation

◆ AddDeparturePosition()

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::AddDeparturePosition ( double  value)
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 252 of file CalculateRouteRequest.h.

◆ AddDestinationPosition()

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::AddDestinationPosition ( double  value)
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 410 of file CalculateRouteRequest.h.

◆ AddWaypointPositions() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::AddWaypointPositions ( Aws::Vector< double > &&  value)
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 713 of file CalculateRouteRequest.h.

◆ AddWaypointPositions() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::AddWaypointPositions ( const Aws::Vector< double > &  value)
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 698 of file CalculateRouteRequest.h.

◆ CalculatorNameHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::CalculatorNameHasBeenSet ( ) const
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 51 of file CalculateRouteRequest.h.

◆ CarModeOptionsHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::CarModeOptionsHasBeenSet ( ) const
inline

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Definition at line 102 of file CalculateRouteRequest.h.

◆ DepartNowHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::DepartNowHasBeenSet ( ) const
inline

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Definition at line 149 of file CalculateRouteRequest.h.

◆ DeparturePositionHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::DeparturePositionHasBeenSet ( ) const
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 192 of file CalculateRouteRequest.h.

◆ DepartureTimeHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::DepartureTimeHasBeenSet ( ) const
inline

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Definition at line 277 of file CalculateRouteRequest.h.

◆ DestinationPositionHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::DestinationPositionHasBeenSet ( ) const
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 350 of file CalculateRouteRequest.h.

◆ DistanceUnitHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::DistanceUnitHasBeenSet ( ) const
inline

Set the unit system to specify the distance.

Default Value: Kilometers

Definition at line 423 of file CalculateRouteRequest.h.

◆ GetCalculatorName()

const Aws::String& Aws::LocationService::Model::CalculateRouteRequest::GetCalculatorName ( ) const
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 45 of file CalculateRouteRequest.h.

◆ GetCarModeOptions()

const CalculateRouteCarModeOptions& Aws::LocationService::Model::CalculateRouteRequest::GetCarModeOptions ( ) const
inline

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Definition at line 95 of file CalculateRouteRequest.h.

◆ GetDepartNow()

bool Aws::LocationService::Model::CalculateRouteRequest::GetDepartNow ( ) const
inline

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Definition at line 140 of file CalculateRouteRequest.h.

◆ GetDeparturePosition()

const Aws::Vector<double>& Aws::LocationService::Model::CalculateRouteRequest::GetDeparturePosition ( ) const
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 180 of file CalculateRouteRequest.h.

◆ GetDepartureTime()

const Aws::Utils::DateTime& Aws::LocationService::Model::CalculateRouteRequest::GetDepartureTime ( ) const
inline

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Definition at line 265 of file CalculateRouteRequest.h.

◆ GetDestinationPosition()

const Aws::Vector<double>& Aws::LocationService::Model::CalculateRouteRequest::GetDestinationPosition ( ) const
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 338 of file CalculateRouteRequest.h.

◆ GetDistanceUnit()

const DistanceUnit& Aws::LocationService::Model::CalculateRouteRequest::GetDistanceUnit ( ) const
inline

Set the unit system to specify the distance.

Default Value: Kilometers

Definition at line 417 of file CalculateRouteRequest.h.

◆ GetIncludeLegGeometry()

bool Aws::LocationService::Model::CalculateRouteRequest::GetIncludeLegGeometry ( ) const
inline

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Definition at line 455 of file CalculateRouteRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::LocationService::Model::CalculateRouteRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CalculateRouteRequest.h.

◆ GetTravelMode()

const TravelMode& Aws::LocationService::Model::CalculateRouteRequest::GetTravelMode ( ) const
inline

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Definition at line 488 of file CalculateRouteRequest.h.

◆ GetTruckModeOptions()

const CalculateRouteTruckModeOptions& Aws::LocationService::Model::CalculateRouteRequest::GetTruckModeOptions ( ) const
inline

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Definition at line 552 of file CalculateRouteRequest.h.

◆ GetWaypointPositions()

const Aws::Vector<Aws::Vector<double> >& Aws::LocationService::Model::CalculateRouteRequest::GetWaypointPositions ( ) const
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 608 of file CalculateRouteRequest.h.

◆ IncludeLegGeometryHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::IncludeLegGeometryHasBeenSet ( ) const
inline

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Definition at line 462 of file CalculateRouteRequest.h.

◆ SerializePayload()

Aws::String Aws::LocationService::Model::CalculateRouteRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCalculatorName() [1/3]

void Aws::LocationService::Model::CalculateRouteRequest::SetCalculatorName ( Aws::String &&  value)
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 63 of file CalculateRouteRequest.h.

◆ SetCalculatorName() [2/3]

void Aws::LocationService::Model::CalculateRouteRequest::SetCalculatorName ( const Aws::String value)
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 57 of file CalculateRouteRequest.h.

◆ SetCalculatorName() [3/3]

void Aws::LocationService::Model::CalculateRouteRequest::SetCalculatorName ( const char *  value)
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 69 of file CalculateRouteRequest.h.

◆ SetCarModeOptions() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetCarModeOptions ( CalculateRouteCarModeOptions &&  value)
inline

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Definition at line 116 of file CalculateRouteRequest.h.

◆ SetCarModeOptions() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetCarModeOptions ( const CalculateRouteCarModeOptions value)
inline

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Definition at line 109 of file CalculateRouteRequest.h.

◆ SetDepartNow()

void Aws::LocationService::Model::CalculateRouteRequest::SetDepartNow ( bool  value)
inline

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Definition at line 158 of file CalculateRouteRequest.h.

◆ SetDeparturePosition() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDeparturePosition ( Aws::Vector< double > &&  value)
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 216 of file CalculateRouteRequest.h.

◆ SetDeparturePosition() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDeparturePosition ( const Aws::Vector< double > &  value)
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 204 of file CalculateRouteRequest.h.

◆ SetDepartureTime() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDepartureTime ( Aws::Utils::DateTime &&  value)
inline

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Definition at line 301 of file CalculateRouteRequest.h.

◆ SetDepartureTime() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDepartureTime ( const Aws::Utils::DateTime value)
inline

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Definition at line 289 of file CalculateRouteRequest.h.

◆ SetDestinationPosition() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDestinationPosition ( Aws::Vector< double > &&  value)
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 374 of file CalculateRouteRequest.h.

◆ SetDestinationPosition() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDestinationPosition ( const Aws::Vector< double > &  value)
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 362 of file CalculateRouteRequest.h.

◆ SetDistanceUnit() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDistanceUnit ( const DistanceUnit value)
inline

Set the unit system to specify the distance.

Default Value: Kilometers

Definition at line 429 of file CalculateRouteRequest.h.

◆ SetDistanceUnit() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetDistanceUnit ( DistanceUnit &&  value)
inline

Set the unit system to specify the distance.

Default Value: Kilometers

Definition at line 435 of file CalculateRouteRequest.h.

◆ SetIncludeLegGeometry()

void Aws::LocationService::Model::CalculateRouteRequest::SetIncludeLegGeometry ( bool  value)
inline

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Definition at line 469 of file CalculateRouteRequest.h.

◆ SetTravelMode() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetTravelMode ( const TravelMode value)
inline

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Definition at line 510 of file CalculateRouteRequest.h.

◆ SetTravelMode() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetTravelMode ( TravelMode &&  value)
inline

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Definition at line 521 of file CalculateRouteRequest.h.

◆ SetTruckModeOptions() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetTruckModeOptions ( CalculateRouteTruckModeOptions &&  value)
inline

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Definition at line 576 of file CalculateRouteRequest.h.

◆ SetTruckModeOptions() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetTruckModeOptions ( const CalculateRouteTruckModeOptions value)
inline

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Definition at line 568 of file CalculateRouteRequest.h.

◆ SetWaypointPositions() [1/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetWaypointPositions ( Aws::Vector< Aws::Vector< double >> &&  value)
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 653 of file CalculateRouteRequest.h.

◆ SetWaypointPositions() [2/2]

void Aws::LocationService::Model::CalculateRouteRequest::SetWaypointPositions ( const Aws::Vector< Aws::Vector< double >> &  value)
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 638 of file CalculateRouteRequest.h.

◆ TravelModeHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::TravelModeHasBeenSet ( ) const
inline

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Definition at line 499 of file CalculateRouteRequest.h.

◆ TruckModeOptionsHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::TruckModeOptionsHasBeenSet ( ) const
inline

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Definition at line 560 of file CalculateRouteRequest.h.

◆ WaypointPositionsHasBeenSet()

bool Aws::LocationService::Model::CalculateRouteRequest::WaypointPositionsHasBeenSet ( ) const
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 623 of file CalculateRouteRequest.h.

◆ WithCalculatorName() [1/3]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithCalculatorName ( Aws::String &&  value)
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 81 of file CalculateRouteRequest.h.

◆ WithCalculatorName() [2/3]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithCalculatorName ( const Aws::String value)
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 75 of file CalculateRouteRequest.h.

◆ WithCalculatorName() [3/3]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithCalculatorName ( const char *  value)
inline

The name of the route calculator resource that you want to use to calculate a route.

Definition at line 87 of file CalculateRouteRequest.h.

◆ WithCarModeOptions() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithCarModeOptions ( CalculateRouteCarModeOptions &&  value)
inline

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Definition at line 130 of file CalculateRouteRequest.h.

◆ WithCarModeOptions() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithCarModeOptions ( const CalculateRouteCarModeOptions value)
inline

Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.

Requirements: TravelMode must be specified as Car.

Definition at line 123 of file CalculateRouteRequest.h.

◆ WithDepartNow()

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDepartNow ( bool  value)
inline

Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Default Value: false

Valid Values: false | true

Definition at line 167 of file CalculateRouteRequest.h.

◆ WithDeparturePosition() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDeparturePosition ( Aws::Vector< double > &&  value)
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 240 of file CalculateRouteRequest.h.

◆ WithDeparturePosition() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDeparturePosition ( const Aws::Vector< double > &  value)
inline

The start position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-123.115, 49.285]

If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 228 of file CalculateRouteRequest.h.

◆ WithDepartureTime() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDepartureTime ( Aws::Utils::DateTime &&  value)
inline

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Definition at line 325 of file CalculateRouteRequest.h.

◆ WithDepartureTime() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDepartureTime ( const Aws::Utils::DateTime value)
inline

Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.

Setting a departure time in the past returns a 400 ValidationException error.

  • In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00

Definition at line 313 of file CalculateRouteRequest.h.

◆ WithDestinationPosition() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDestinationPosition ( Aws::Vector< double > &&  value)
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 398 of file CalculateRouteRequest.h.

◆ WithDestinationPosition() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDestinationPosition ( const Aws::Vector< double > &  value)
inline

The finish position for the route. Defined in WGS 84 format: [longitude, latitude].

  • For example, [-122.339, 47.615]

If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 386 of file CalculateRouteRequest.h.

◆ WithDistanceUnit() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDistanceUnit ( const DistanceUnit value)
inline

Set the unit system to specify the distance.

Default Value: Kilometers

Definition at line 441 of file CalculateRouteRequest.h.

◆ WithDistanceUnit() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithDistanceUnit ( DistanceUnit &&  value)
inline

Set the unit system to specify the distance.

Default Value: Kilometers

Definition at line 447 of file CalculateRouteRequest.h.

◆ WithIncludeLegGeometry()

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithIncludeLegGeometry ( bool  value)
inline

Set to include the geometry details in the result for each path between a pair of positions.

Default Value: false

Valid Values: false | true

Definition at line 476 of file CalculateRouteRequest.h.

◆ WithTravelMode() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithTravelMode ( const TravelMode value)
inline

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Definition at line 532 of file CalculateRouteRequest.h.

◆ WithTravelMode() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithTravelMode ( TravelMode &&  value)
inline

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

The TravelMode you specify determines how you specify route preferences:

  • If traveling by Car use the CarModeOptions parameter.

  • If traveling by Truck use the TruckModeOptions parameter.

Default Value: Car

Definition at line 543 of file CalculateRouteRequest.h.

◆ WithTruckModeOptions() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithTruckModeOptions ( CalculateRouteTruckModeOptions &&  value)
inline

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Definition at line 592 of file CalculateRouteRequest.h.

◆ WithTruckModeOptions() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithTruckModeOptions ( const CalculateRouteTruckModeOptions value)
inline

Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.

Requirements: TravelMode must be specified as Truck.

Definition at line 584 of file CalculateRouteRequest.h.

◆ WithWaypointPositions() [1/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithWaypointPositions ( Aws::Vector< Aws::Vector< double >> &&  value)
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 683 of file CalculateRouteRequest.h.

◆ WithWaypointPositions() [2/2]

CalculateRouteRequest& Aws::LocationService::Model::CalculateRouteRequest::WithWaypointPositions ( const Aws::Vector< Aws::Vector< double >> &  value)
inline

Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

  • For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]

If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.

Specifying more than 23 waypoints returns a 400 ValidationException error.

Valid Values: [-180 to 180,-90 to 90]

Definition at line 668 of file CalculateRouteRequest.h.


The documentation for this class was generated from the following file: