ruby_ptv_api 0.1.0

data/lib/ruby_ptv_api/model/x_route/way_point.rb

@@ -0,0 +1,30 @@
+module RubyPtvApi
+  module Model
+    module XRoute
+      class WayPoint < RubyPtvApi::Model::Base
+        property 'accTime'
+        property 'accDist'
+        property 'iuCode'
+        property 'polyIdx'
+        property 'nodeIdx'
+        property 'segmentIdx'
+        property 'manoeuvreIdx'
+        property 'locationCoord'
+        property 'matchCoord'
+        property 'wayPointType', transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::WAY_POINT_TYPE, value)
+        end
+        property 'dynamicInfo'
+        property 'countryCode'
+        property 'emissions'
+        property 'cenEmissions'
+        property 'utcOffset'
+        
+        coerce_key :locationCoord, Point
+        coerce_key :matchCoord, Point
+        coerce_key :emissions, Emissions
+        coerce_key :cenEmissions, CENEmissionScenarios
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_route/waypoint_desc.rb

@@ -0,0 +1,28 @@
+module RubyPtvApi
+  module Model
+    module XRoute
+      class WaypointDesc < RubyPtvApi::Model::Base
+        property 'coords'
+        property 'linkType', transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::LINK_TYPE, value)
+        end
+        property 'nodeID'
+        property 'segmentID'
+        property 'fuzzyRadius'
+        property 'heading'
+        property 'street'
+        property 'routingOptions'
+        property 'vehicleOptions'
+        property 'viaType'
+        property 'combinedTransportID'
+
+        coerce_key :coords        , Array[Point]
+        coerce_key :nodeID        , UniqueGeoID
+        coerce_key :segmentID     , Array[UniqueGeoID]
+        coerce_key :routingOptions, Array[RoutingOption]
+        coerce_key :vehicleOptions, Array[VehicleOption]
+        coerce_key :viaType       , ViaType
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/abstract_costs.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class AbstractCosts < RubyPtvApi::Model::Base
+        property 'costsPerKm'
+        property 'fixedCosts'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/abstract_tour.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class AbstractTour < RubyPtvApi::Model::Base
+        property 'startTimeFixed'
+        property 'startTimeEarliest'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/abstract_tour_point.rb

@@ -0,0 +1,16 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class AbstractTourPoint < RubyPtvApi::Model::Base
+        property 'id'
+        property 'description'
+        property 'type', transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::TOUR_POINT_TYPE, value)
+        end
+        property 'result'
+
+        coerce_key :result, TourPointResult
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/abstract_tour_result.rb

@@ -0,0 +1,38 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class AbstractTourResult < RubyPtvApi::Model::Base
+        property 'period'
+        property 'drivingPeriod'
+        property 'distance'
+        property 'distanceFromFirstToLastTransportPoint'
+        property 'maxDistanceBetweenTransportPoints'
+        property 'servicePeriod'
+        property 'restPeriod'
+        property 'breakPeriod'
+        property 'earliness'
+        property 'waitingPeriod'
+        property 'transportPointCount'
+        property 'startTime'
+        property 'startTimeLatest'
+        property 'coDriverRequired'
+        property 'totalCosts'
+        property 'pickupQuantities'
+        property 'deliveryQuantities'
+        property 'maxQuantities'
+        property 'depotUploadingPeriod'
+        property 'depotUnloadingPeriod'
+        property 'depotAvailabilityForDeliveries'
+        property 'depotAvailabilityForPickups'
+        property 'tourChanged'
+        property 'violations'
+        property 'remainingPeriods'
+        
+        coerce_key :totalCosts, TotalCosts
+        coerce_key :pickupQuantities, Quantities
+        coerce_key :deliveryQuantities, Quantities
+        coerce_key :maxQuantities, Quantities
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/abstract_transport_order.rb

@@ -0,0 +1,11 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class AbstractTransportOrder < RubyPtvApi::Model::Base
+        property 'id', required: true
+        property 'priority'
+        property 'productId'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/abstract_vehicle.rb

@@ -0,0 +1,14 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class AbstractVehicle < RubyPtvApi::Model::Base
+        property 'depotIdStart', required: true
+        property 'depotIdEnd'  , required: true
+        property 'operatingIntervals'
+        
+        coerce_key :operatingIntervals, Array[Interval]        
+      end
+    end
+  end
+end
+        

data/lib/ruby_ptv_api/model/x_tour/base_vehicle.rb

@@ -0,0 +1,30 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class BaseVehicle < AbstractVehicle 
+        property 'drivingPeriodFactor'
+        property 'servicePeriodFactor'
+        property 'transportPointUploadingFunctionId'
+        property 'transportPointUnloadingFunctionId'
+        property 'depotUploadingFunctionId'
+        property 'depotUnloadingFunctionId'
+        property 'departureTimeFixed'
+        property 'isPreloaded'
+        property 'capacities'
+        property 'costs'
+        property 'dimaId'#, required: true #depot id
+        property 'ignoreTransportPointServicePeriod'
+        property 'coDriverStatus', transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::CO_DRIVER_STATUS, value)
+        end
+        property 'toursMustFitIntoSingleOperatingInterval'
+        property 'driverSettings'
+        
+        coerce_key :capacities, Capacities
+        coerce_key :costs, VehicleCosts
+        coerce_key :driverSettings, DriverSettings        
+      end
+    end
+  end
+end
+        

data/lib/ruby_ptv_api/model/x_tour/capacities.rb

@@ -0,0 +1,11 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Capacities < RubyPtvApi::Model::Base
+        property 'capacities'
+
+        coerce_key :capacities, Array[Quantities]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/chain.rb

@@ -0,0 +1,14 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Chain < RubyPtvApi::Model::Base
+        property 'vehicleId'
+        property 'tours'
+        property 'result'
+        
+        coerce_key :tours, Array[Tour]
+        coerce_key :result, ChainResult
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/chain_result.rb

@@ -0,0 +1,20 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class ChainResult < RubyPtvApi::Model::Base
+        property 'vehicleDescription'
+        property 'chainCosts'
+        property 'tourEvents'
+        property 'remainingPeriods'
+        property 'drivingPeriod'
+        property 'endTime'
+        property 'periodFromStartLocation'
+        property 'distanceFromStartLocation'
+        property 'periodToEndLocation'
+        property 'distanceToEndLocation'
+        
+        coerce_key :tourEvents, Array[TourEvent]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/costs.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Costs < AbstractCosts 
+        property 'costsPerHourDriverOnly'
+        property 'costsPerHourWithCoDriver'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/depot.rb

@@ -0,0 +1,8 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Depot < LogisticPoint
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/distance_matrix_by_road.rb

@@ -0,0 +1,12 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class DistanceMatrixByRoad < DistanceMatrixCalculation
+        property 'deleteBeforeUsage'
+        property 'deleteAfterUsage'
+        property 'profileName'
+        property 'referenceTime'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/distance_matrix_calculation.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class DistanceMatrixCalculation < RubyPtvApi::Model::Base
+        property 'dimaId'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/driver_settings.rb

@@ -0,0 +1,17 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class DriverSettings < RubyPtvApi::Model::Base
+        property 'regulationsId'
+        property 'breakRuleActive'
+        property 'dailyRestRuleActive'
+        property 'weeklyRestRuleActive'
+        property 'workingRuleActive'
+        property 'remainingPeriods'
+        property 'maximumTourPeriodRestriction'
+
+        coerce_key :maximumTourPeriodRestriction, MaximumTourPeriodRestriction
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/fleet.rb

@@ -0,0 +1,15 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Fleet < RubyPtvApi::Model::Base
+        property 'vehicles'
+        property 'trailers'
+        property 'trains'
+        
+        coerce_key :vehicles, Array[Vehicle]
+        coerce_key :trailers, Array[Trailer]
+        coerce_key :trains  , Array[Train]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/goal_importance.rb

@@ -0,0 +1,44 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class GoalImportance < RubyPtvApi::Model::Base
+        RANKING = {
+            standard: 0,
+            do_not_care: 1,
+            important: 2,
+            very_important: 3
+        }
+
+        property 'vehicleCountRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+        property 'tourCountRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+        property 'chainPeriodRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+        property 'tourPeriodRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+        property 'tourDrivingPeriodRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+        property 'tourDistanceRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+        property 'unplannedOrdersRank', transform_with: ->(value) do 
+          RubyPtvApi::Model::XTour::GoalImportance.validate(value)
+        end
+
+        def self.validate(value)
+          value = RANKING[value] if value.is_a? Symbol
+          unless RANKING.values.includes?(value)
+            raise WrongParameterFormat.new("#{value} is not a valid must be in #{RANKING}. Both Symbol and Fixnum are allowed")
+          end
+          value
+        end
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/interval.rb

@@ -0,0 +1,15 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      # A time window specified by start time and end time. The attributes must be specified in [sec] from a consistent reference point in time on (for example 0:00 next day or 0:00 1 January 1970).
+      # Attribute Name  Type  Description
+      # from            int   Start of the interval ([sec] from a reference point in time on, 0 <= from).
+      # till            int   End of the interval ([sec] from a reference point in time on, 0 < till and from <= till).
+      class Interval < RubyPtvApi::Model::Base
+        property 'from'
+        property 'till'
+        
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/loading_area.rb

@@ -0,0 +1,13 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class LoadingArea < AbstractTransportOrder
+        property 'length'
+        property 'width'
+        property 'height'
+        property 'weight'
+        
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/loading_function.rb

@@ -0,0 +1,16 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class LoadingFunction < RubyPtvApi::Model::Base
+        property 'id'
+        property 'quantityDependentPeriods'
+        property 'fixedPeriod'
+        property 'fixedSitePeriod'
+        property 'exponent'
+        property 'maxPeriod'
+
+        coerce_key :quantityDependentPeriods, QuantityDependentPeriods
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/logistic_point.rb

@@ -0,0 +1,19 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class LogisticPoint < RubyPtvApi::Model::Base
+        property 'id', required: true
+        property 'description'
+        property 'location', required: true
+        property 'openingIntervals'
+        property 'siteId'
+        property 'extraSitePeriod'
+        property 'uploadingFunctionId'
+        property 'unloadingFunctionId'
+
+        coerce_key :location, RubyPtvApi::Model::Point
+        coerce_key :openingIntervals, Array[Interval]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/maximum_tour_period_restriction.rb

@@ -0,0 +1,10 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class MaximumTourPeriodRestriction < RubyPtvApi::Model::Base
+        property 'maximumNetTourPeriod'
+        property 'maximumAllowableTourPeriod'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/plan.rb

@@ -0,0 +1,13 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Plan < RubyPtvApi::Model::Base
+        property 'chains'
+        property 'result'
+        
+        coerce_key :chains, Array[Chain]
+        coerce_key :result, PlanResult
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/plan_result.rb

@@ -0,0 +1,21 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class PlanResult < RubyPtvApi::Model::Base
+        property 'totalTourCount'
+        property 'totalTourPeriod'
+        property 'totalTourDrivingPeriod'
+        property 'totalTourDistance'
+        property 'totalTourCosts'
+        property 'totalChainCosts'
+        property 'scheduledOrderIds'
+        property 'unscheduledOrderIds'
+        property 'scheduledVehicleIds'
+        property 'unscheduledVehicleIds'
+        property 'unscheduledOrderAnalysisResults'
+
+        coerce_key :unscheduledOrderAnalysisResults, Array[UnscheduledOrderAnalysisResult]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/planning_params.rb

@@ -0,0 +1,23 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class PlanningParams < RubyPtvApi::Model::Base
+        property 'restrictions'
+        property 'loadingFunctions'
+        property 'distanceMatrixCalculation'
+        property 'directVelocity'
+        property 'directDistanceFactor'
+        property 'coDriverTransportPointLoadingFactor'
+        property 'coDriverTransportPointsInSeparateTours'
+        property 'regulations'
+        property 'productIncompatibilities'
+
+        coerce_key :restrictions, Restrictions
+        coerce_key :loadingFunctions,  Array[LoadingFunction]
+        coerce_key :distanceMatrixCalculation, Array[DistanceMatrixCalculation]
+        coerce_key :regulations, Array[DistanceMatrixCalculation]
+        coerce_key :productIncompatibilities, Array[ProductIncompatibility]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/product_incompatibility.rb

@@ -0,0 +1,11 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class ProductIncompatibility < RubyPtvApi::Model::Base
+        property 'productId1'
+        property 'productId2'
+        property 'incompatibilityType'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/quantities.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Quantities < RubyPtvApi::Model::Base
+        property 'quantities'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/quantity_dependent_periods.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class QuantityDependentPeriods < RubyPtvApi::Model::Base
+        property 'secondsPerQuantityUnit'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/regulations_base.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class RegulationsBase < RubyPtvApi::Model::Base
+        property 'id'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/restrictions.rb

@@ -0,0 +1,13 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class Restrictions < RubyPtvApi::Model::Base
+        property 'maxTourCount'
+        property 'maxTransportPointCountPerTour'
+        property 'tourRestrictions'
+        
+        coerce_key :restrictions, TourRestrictions
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/seconds_per_quantity_unit.rb

@@ -0,0 +1,9 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class QuantityDependentPeriods < RubyPtvApi::Model::Base
+        property 'secondsPerQuantityUnit'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_params.rb

@@ -0,0 +1,12 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingParams < PlanningParams
+        property 'fixedStartTransportPoints'
+        property 'fixedEndTransportPoints'
+        property 'availableMachineTime'
+        property 'maximumNumberOfUnscheduledOrdersToBeAnalyzed'
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_plan.rb

@@ -0,0 +1,13 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingPlan < RubyPtvApi::Model::Base
+        property 'tour'
+        property 'result'
+
+        coerce_key :tour, SequencingTour
+        coerce_key :result, SequencingPlanResult
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_plan_result.rb

@@ -0,0 +1,16 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingPlanResult < RubyPtvApi::Model::Base
+        property 'tourEvents'
+        property 'remainingPeriods'
+        property 'scheduledOrderIds'
+        property 'unscheduledOrderIds'
+        property 'unscheduledOrderAnalysisResults'
+
+        coerce_key :tourEvents, Array[TourEvent]
+        coerce_key :result, Array[UnscheduledOrderAnalysisResult]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_tour.rb

@@ -0,0 +1,13 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingTour < AbstractTour
+        property 'result'
+        property 'tourPoints'
+
+        coerce_key :result, SequencingTourResult
+        coerce_key :tourPoints, Array[SequencingTourPoint]
+      end
+    end
+  end
+end

data/lib/ruby_ptv_api/model/x_tour/sequencing_tour_point.rb

@@ -0,0 +1,16 @@
+module RubyPtvApi
+  module Model 
+    module XTour
+      class SequencingTourPoint < RubyPtvApi::Model::Base
+        property 'id'
+        property 'description'
+        property 'type', transform_with: ->(value) do 
+          RubyPtvApi::Constant.validate(RubyPtvApi::Constant::TOUR_POINT_TYPE, value)
+        end
+        property 'result'
+
+        coerce_key :result, TourPointResult
+      end
+    end
+  end
+end