OptimizationQualityEnum

Passed

Push — v1 ( b4dcfa...110339 )

by Maksim

created 2017-08-24 20:45 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	13
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	13
ccs	4
cts	4
cp	1
wmc	0

# -*- coding: utf-8 -*-

from enum import Enum


class AlgorithmTypeEnum(Enum):
	"""
	The algorithm type to be used.
	"""

	TSP = 1
	"""
	TSP

	.. todo::
		add clear and understandable description
	"""

	VRP = 2
	"""
	VRP

	.. todo::
		add clear and understandable description
	"""

	CVRP_TW_SD = 3
	"""
	CVRP_TW_SD

	.. todo::
		add clear and understandable description
	"""

	CVRP_TW_MD = 4
	"""
	CVRP_TW_MD

	.. todo::
		add clear and understandable description
	"""

	TSP_TW = 5
	"""
	TSP_TW

	.. todo::
		add clear and understandable description
	"""

	TSP_TW_CR = 6
	"""
	TSP_TW_CR

	.. todo::
		add clear and understandable description
	"""

	BBCVRP = 7
	"""
	BBCVRP

	.. todo::
		add clear and understandable description
	"""

	ALG_LEGACY_DISTRIBUTED = 101
	"""
	ALG_LEGACY_DISTRIBUTED

	.. todo::
		add clear and understandable description
	"""

	ALG_NONE = 100
	"""
	ALG_NONE

	.. todo::
		add clear and understandable description
	"""


class OptimizationFactorEnum(Enum):
	"""
	The driving directions can be generated biased for this selection. This
	has no impact on route sequencing.

	.. note::

		In Route4Me API this enum also known as ``optimize``

	"""

	#: Optimize by distance
	DISTANCE = 'Distance'

	#: Optimize by time
	TIME = 'Time'

	#: Optimize by time and traffic
	TIME_TRAFFIC = 'timeWithTraffic'


class DistanceUnitEnum(Enum):
	"""
	:class:`~.Optimization` problem can be at one state at any given time
	"""

	#: Miles
	MILE = 'mi'

	#: Kilometers
	KILOMETER = 'km'


class OptimizationStateEnum(Enum):
	"""
	The distance measurement unit
	"""

	#: Initial
	INITIAL = 1

	#: Matrix Processing
	MATRIX_PROCESSING = 2

	#: Optimizing
	OPTIMIZING = 3

	#: Optimized
	OPTIMIZED = 4

	#: Error
	ERROR = 5

	#: Computing Directions
	COMPUTING_DIRECTIONS = 6


class OptimizationQualityEnum(Enum):
	"""
	Optimization Quality
	"""

	#: Generate Optimized Routes As Quickly as Possible
	FAST = 1

	#: Generate Routes That Look Better On A Map
	MEDIUM = 2

	#: Generate The Shortest And Quickest Possible Routes
	BEST = 3


class DeviceTypeEnum(Enum):
	"""
	Device Type

	The type of the device that is creating this route
	"""

	#: Web
	WEB = "web"

	#: IPhone
	IPHONE = "iphone"

	#: IPad
	IPAD = "ipad"

	#: Android phone
	ANDROID_PHONE = "android_phone"

	#: Android tablet
	ANDROID_TABLET = "android_tablet"


class TravelModeEnum(Enum):
	"""
	Travel Mode

	The mode of travel that the directions should be optimized for
	"""

	#: Driving
	DRIVING = 'Driving'

	#: Walking
	WALKING = 'Walking'

	#: Trucking
	TRUCKING = 'Trucking'

	#: Cycling
	CYCLING = 'Cycling'

	#: Transit
	TRANSIT = 'Transit'


class RouteMetricEnum(Enum):
	"""
	Metric
	"""

	#: Euclidean
	EUCLIDEAN = 1

	#: Manhattan
	MANHATTAN = 2

	#: Geodesic
	GEODESIC = 3

	#: Matrix
	MATRIX = 4

	#: Exact 2d
	EXACT2D = 5


# TYPE_OF_MATRIX = enum(R4M_PROPRIETARY_ROUTING=1,
#                       R4M_TRAFFIC_ENGINE=3,
#                       TRUCKING=6)

# DIRECTIONS_METHOD = enum(R4M_PROPRIETARY_INTERNAL_NAVIGATION_SYSTEM=1,
#                          TRUCKING=3)

# AVOID = enum(HIGHWAYS='Highways',
#              TOLLS='Tolls',
#              MINIMIZE_HIGHWAYS='minimizeHighways',
#              MINIMIZE_TOLLS='minimizeTolls',
#              NONE='')


# FORMAT = enum(CSV='csv',
#               SERIALIZED='serialized',
#               XML='xml',
#               JSON='json')


# ROUTE_PATH_OUTPUT = enum(NONE='None',
#                          POINTS='Points')

# UTURN = auto_enum('UTURN_DEPART_SHORTEST',
#                   'UTURN_DEPART_TO_RIGHT')

# LEFT_TURN = auto_enum('LEFTTURN_ALLOW',
#                       'LEFTTURN_FORBID',
#                       'LEFTTURN_MULTIAPPROACH')

# TRUCK_HAZARDOUS_GOODS = enum(NONE='',
#                              EXPLOSIVE='explosive',
#                              GAS='gas',
#                              FLAMMABLE='flammable',
#                              COMBUSTIBLE='combustible',
#                              ORGANIC='organic',
#                              POISON='poison',
#                              RADIOACTIVE='radioActive',
#                              CORROSIVE='corrosive',
#                              POISONOUSINHALATION='poisonousInhalation',
#                              HARMFULTOWATER='harmfulToWater',
#                              OTHER='other',
#                              ALLHAZARDOUSGOODS='allHazardousGoods')

# TERRITORY_TYPE = enum(CIRCLE='circle',
#                       POLY='poly',
#                       RECT='rect', )


1		# -- coding: utf-8 --
2
3	1	from enum import Enum
4
5
6	1	class AlgorithmTypeEnum(Enum):
7		"""
8		The algorithm type to be used.
9		"""
10
11	1	TSP = 1
12		"""
13		TSP
14
15		.. todo::
16		add clear and understandable description
17		"""
18
19	1	VRP = 2
20		"""
21		VRP
22
23		.. todo::
24		add clear and understandable description
25		"""
26
27	1	CVRP_TW_SD = 3
28		"""
29		CVRP_TW_SD
30
31		.. todo::
32		add clear and understandable description
33		"""
34
35	1	CVRP_TW_MD = 4
36		"""
37		CVRP_TW_MD
38
39		.. todo::
40		add clear and understandable description
41		"""
42
43	1	TSP_TW = 5
44		"""
45		TSP_TW
46
47		.. todo::
48		add clear and understandable description
49		"""
50
51	1	TSP_TW_CR = 6
52		"""
53		TSP_TW_CR
54
55		.. todo::
56		add clear and understandable description
57		"""
58
59	1	BBCVRP = 7
60		"""
61		BBCVRP
62
63		.. todo::
64		add clear and understandable description
65		"""
66
67	1	ALG_LEGACY_DISTRIBUTED = 101
68		"""
69		ALG_LEGACY_DISTRIBUTED
70
71		.. todo::
72		add clear and understandable description
73		"""
74
75	1	ALG_NONE = 100
76	1	"""
77		ALG_NONE
78
79		.. todo::
80		add clear and understandable description
81		"""
82
83
84	1	class OptimizationFactorEnum(Enum):
85		"""
86		The driving directions can be generated biased for this selection. This
87		has no impact on route sequencing.
88
89		.. note::
90
91		In Route4Me API this enum also known as ``optimize``
92
93		"""
94
95		#: Optimize by distance
96	1	DISTANCE = 'Distance'
97
98		#: Optimize by time
99	1	TIME = 'Time'
100
101		#: Optimize by time and traffic
102	1	TIME_TRAFFIC = 'timeWithTraffic'
103
104
105	1	class DistanceUnitEnum(Enum):
106		"""
107		:class:`~.Optimization` problem can be at one state at any given time
108		"""
109
110		#: Miles
111	1	MILE = 'mi'
112
113		#: Kilometers
114	1	KILOMETER = 'km'
115
116
117	1	class OptimizationStateEnum(Enum):
118		"""
119		The distance measurement unit
120		"""
121
122		#: Initial
123	1	INITIAL = 1
124
125		#: Matrix Processing
126	1	MATRIX_PROCESSING = 2
127
128		#: Optimizing
129	1	OPTIMIZING = 3
130
131		#: Optimized
132	1	OPTIMIZED = 4
133
134		#: Error
135	1	ERROR = 5
136
137		#: Computing Directions
138	1	COMPUTING_DIRECTIONS = 6
139
140
141	1	class OptimizationQualityEnum(Enum):
142		"""
143		Optimization Quality
144		"""
145
146		#: Generate Optimized Routes As Quickly as Possible
147	1	FAST = 1
148
149		#: Generate Routes That Look Better On A Map
150	1	MEDIUM = 2
151
152		#: Generate The Shortest And Quickest Possible Routes
153	1	BEST = 3
154
155
156	1	class DeviceTypeEnum(Enum):
157		"""
158		Device Type
159
160		The type of the device that is creating this route
161		"""
162
163		#: Web
164	1	WEB = "web"
165
166		#: IPhone
167	1	IPHONE = "iphone"
168
169		#: IPad
170	1	IPAD = "ipad"
171
172		#: Android phone
173	1	ANDROID_PHONE = "android_phone"
174
175		#: Android tablet
176	1	ANDROID_TABLET = "android_tablet"
177
178
179	1	class TravelModeEnum(Enum):
180		"""
181		Travel Mode
182
183		The mode of travel that the directions should be optimized for
184		"""
185
186		#: Driving
187	1	DRIVING = 'Driving'
188
189		#: Walking
190	1	WALKING = 'Walking'
191
192		#: Trucking
193	1	TRUCKING = 'Trucking'
194
195		#: Cycling
196	1	CYCLING = 'Cycling'
197
198		#: Transit
199	1	TRANSIT = 'Transit'
200
201
202	1	class RouteMetricEnum(Enum):
203		"""
204		Metric
205		"""
206
207		#: Euclidean
208	1	EUCLIDEAN = 1
209
210		#: Manhattan
211	1	MANHATTAN = 2
212
213		#: Geodesic
214	1	GEODESIC = 3
215
216		#: Matrix
217	1	MATRIX = 4
218
219		#: Exact 2d
220	1	EXACT2D = 5
221
222
223		# TYPE_OF_MATRIX = enum(R4M_PROPRIETARY_ROUTING=1,
224		# R4M_TRAFFIC_ENGINE=3,
225		# TRUCKING=6)
226
227		# DIRECTIONS_METHOD = enum(R4M_PROPRIETARY_INTERNAL_NAVIGATION_SYSTEM=1,
228		# TRUCKING=3)
229
230		# AVOID = enum(HIGHWAYS='Highways',
231		# TOLLS='Tolls',
232		# MINIMIZE_HIGHWAYS='minimizeHighways',
233		# MINIMIZE_TOLLS='minimizeTolls',
234		# NONE='')
235
236
237		# FORMAT = enum(CSV='csv',
238		# SERIALIZED='serialized',
239		# XML='xml',
240		# JSON='json')
241
242
243		# ROUTE_PATH_OUTPUT = enum(NONE='None',
244		# POINTS='Points')
245
246		# UTURN = auto_enum('UTURN_DEPART_SHORTEST',
247		# 'UTURN_DEPART_TO_RIGHT')
248
249		# LEFT_TURN = auto_enum('LEFTTURN_ALLOW',
250		# 'LEFTTURN_FORBID',
251		# 'LEFTTURN_MULTIAPPROACH')
252
253		# TRUCK_HAZARDOUS_GOODS = enum(NONE='',
254		# EXPLOSIVE='explosive',
255		# GAS='gas',
256		# FLAMMABLE='flammable',
257		# COMBUSTIBLE='combustible',
258		# ORGANIC='organic',
259		# POISON='poison',
260		# RADIOACTIVE='radioActive',
261		# CORROSIVE='corrosive',
262		# POISONOUSINHALATION='poisonousInhalation',
263		# HARMFULTOWATER='harmfulToWater',
264		# OTHER='other',
265		# ALLHAZARDOUSGOODS='allHazardousGoods')
266
267		# TERRITORY_TYPE = enum(CIRCLE='circle',
268		# POLY='poly',
269		# RECT='rect', )
270

route4me / route4me-python-sdk

GitHub Access Token became invalid

Push — v1 ( b4dcfa...110339 )

OptimizationQualityEnum

Complexity

Size/Duplication

Test Coverage

Importance

Duplication Side-by-Side

Filter issues like