|
Maps SDK for C++ 1.0.0
|
Defines an order that was visited. More...


Public Member Functions | |
| RouteOrder (const Customer &customer) | |
| Constructs a RouteOrder object initialized with Customer information. | |
| RouteOrder (const RouteOrder &)=default | |
| Default copy constructor. | |
| RouteOrder (RouteOrder &&) noexcept=default | |
| Default move constructor noexcept is deduced. | |
| RouteOrder & | operator= (const RouteOrder &)=default |
| Default copy assignment operator. | |
| RouteOrder & | operator= (RouteOrder &&) noexcept=default |
| Default move assignment operator. | |
| bool | operator== (RouteOrder const &order) const |
| Compares two RouteOrder objects for equality. | |
| bool | operator!= (RouteOrder const &order) const |
| Compares two RouteOrder objects for equality. | |
| const CoordinatesRef | getMatchedCoordinates () const noexcept |
| Retrieves the matched coordinates of the route order. | |
| const CoordinatesRef | getActualCoordinates () const noexcept |
| Retrieves the actual coordinates of the driver. | |
| unsigned int | getIndexInRoute () const noexcept |
| Get the index of the order in the route's orders list (the visiting order). | |
| RouteOrder & | setIndexInRoute (unsigned int indexInRoute) noexcept |
| Set the index of the order in the route's orders list (the visiting order). | |
| unsigned int | getIndexInOptimization () const noexcept |
| Get the index of the order in the optimization orders list. | |
| const TimeRef | getArrivalTime () const noexcept |
| Get the vehicle arrival time at this order. | |
| unsigned int | getTimeToNextOrder () const noexcept |
| Get the duration (in seconds) between the current order and the next one. | |
| unsigned int | getWaitTime () const noexcept |
| Get the amount of time (in seconds) that the vehicle has to wait at the current order, in order to arrive at the next order between its time window. | |
| int | getNumberOfPackagesAtArrival () const noexcept |
| Get the total collected packages until this order. | |
| int | getCollectedNumberOfPackages () const noexcept |
| Get the number of packages collected at this order. | |
| int | getDeliveredNumberOfPackages () const noexcept |
| Get the number of packages delivered at this order. | |
| float | getWeightAtArrival () const noexcept |
| Get the total collected weight until this order. | |
| float | getCollectedWeight () const noexcept |
| Get the weight collected at this order. | |
| float | getDeliveredWeight () const noexcept |
| Get the weight delivered at this order. | |
| float | getCubeAtArrival () const noexcept |
| Get the total collected cube until this order. | |
| float | getCollectedCube () const noexcept |
| Get the cube collected at this order. | |
| float | getDeliveredCube () const noexcept |
| Get the cube delivered at this order. | |
| float | getTraveledDistance () const noexcept |
| Get the vehicle traveled distance until this order in the unit distance set in the ConfigurationParameters. | |
| float | getDistanceToNextOrder () const noexcept |
| Get the distance between this order and the next one in the unit distance set in the ConfigurationParameters. | |
| float | getRevenueAtArrival () const noexcept |
| Get the revenue collected until this order. | |
| const TimeRef | getVisitTime () const noexcept |
| Get the time when the order was visited. | |
| bool | operator== (Order const &order) const |
| Compares two Order objects for equality. | |
| bool | operator!= (Order const &order) const |
| Compares two Order objects for equality. | |
| LargeInteger | getId () const noexcept |
| Get the id of the order. | |
| const CoordinatesRef | getCoordinates () const noexcept |
| Retrieves the coordinates of the order. | |
| CoordinatesRef | getCoordinates () |
| Provides direct access to modify the coordinates of the order. | |
| Order & | setCoordinates (const Coordinates &coords) noexcept |
| Set the coordinates of the order. | |
| const StringRef | getAlias () const noexcept |
| Retrieves the alias of this order. | |
| Order & | setAlias (const String &alias) noexcept |
| Sets the alias for this order. | |
| const StringRef | getFirstName () const noexcept |
| Retrieves the first name of the owner of the order. | |
| Order & | setFirstName (const String &firstName) noexcept |
| Sets the fist name of the owner of the order. | |
| const StringRef | getLastName () const noexcept |
| Retrieves the last name of the owner of the order. | |
| Order & | setLastName (const String &lastName) noexcept |
| Sets the last name of the owner of the order. | |
| const AddressInfoRef | getAddress () const noexcept |
| Retrieves the address associated with the order. | |
| Order & | setAddress (const AddressInfo &address) noexcept |
| Sets the address for the order's location. | |
| const StringRef | getPhoneNumber () const noexcept |
| Retrieves the phone number of the owner of the order. | |
| Order & | setPhoneNumber (const String &phoneNumber) noexcept |
| Sets the phone number of the owner of the order, which the driver will use to contact him. | |
| const CustomDataListRef | getCustomData () const noexcept |
| Get the custom data of the order. | |
| Order & | setCustomData (const CustomDataList &list) noexcept |
| Set the order's custom data. | |
| unsigned int | getNumberOfPackages () const noexcept |
| Get the number of packages which has to be delivered at order or picked-up from the order depending on the order's type. | |
| Order & | setNumberOfPackages (unsigned int numberOfPackages) noexcept |
| Set the number of packages which has to be delivered at this order or picked-up from this order depending on the order's type. | |
| float | getWeight () const noexcept |
| Get the weight which has to be delivered at order or picked-up from the order depending on the order's type. | |
| Order & | setWeight (float weightKg) noexcept |
| Set the weight which has to be delivered at order or picked-up from the order depending on the order's type. | |
| float | getCube () const noexcept |
| Get the cube which has to be delivered at order or picked-up from the order depending on the order's type. | |
| Order & | setCube (float cube) noexcept |
| Set the cube which has to be delivered at order or picked-up from the order depending on the order's type. | |
| std::pair< int, int > | getTimeWindow () const noexcept |
| Get the time window within which the order must be visited. | |
| Order & | setTimeWindow (std::pair< int, int > timeWindowInMinutes) noexcept |
| Set the time window within which the order must be visited. | |
| unsigned int | getServiceTime () const noexcept |
| Get the amount of time (in seconds) that the vehicle has to stay at the current order (to load/unload the goods). | |
| Order & | setServiceTime (unsigned int serviceTimeSeconds) noexcept |
| Set the amount of time (in seconds) that the vehicle has to stay at the current order (to load/unload the goods). | |
| EOrderType | getType () const noexcept |
| Get the order’s type. | |
| Order & | setType (EOrderType orderType) noexcept |
| Set the order’s type. | |
| EOrderStatus | getStatus () const noexcept |
| Get the order’s status. | |
| EOrderState | getState () const noexcept |
| Get the order’s state. | |
| EOrderPriority | getPriority () const noexcept |
| Get the order’s priority. | |
| Order & | setPriority (EOrderPriority orderPriority) noexcept |
| Set the order’s priority. | |
| float | getRevenue () const noexcept |
| Get the revenue which has to be received from the order. | |
| Order & | setRevenue (float revenue) noexcept |
| Set the revenue which has to be received from the order. | |
| const TimeRef | getCreationTime () const noexcept |
| Get the date and time when the order was saved. | |
| const CustomerRef | getCustomer () const noexcept |
| Get the Customer of the order. | |
| Order & | setCustomer (const Customer &customer) noexcept |
| Set the Customer of the order. | |
| LargeInteger | getDepotId () const noexcept |
| Get the id of the depot(MiscLocation) where to which the order belongs. | |
| Order & | setDepotId (LargeInteger depotId) noexcept |
| Set the id of the depot where to which the order belongs. | |
Defines an order that was visited.
It is a part of a resulted route, after the optimization of the problem.
Defines a route order. Implements share-read / copy-on-write Api object over IRouteOrder.
|
inline |
Constructs a RouteOrder object initialized with Customer information.
| customer | A Customer object containing the initial values for the order's coordinates, alias, first name, last name, phone number and address. |
|
inlinenoexcept |
Retrieves the actual coordinates of the driver.
These coordinates represent the actual location of the order.
|
inlinenoexceptinherited |
Retrieves the address associated with the order.
This address provides a human-readable location for the order's location, complementing the coordinates.
|
inlinenoexceptinherited |
Retrieves the alias of this order.
|
inlinenoexcept |
|
inlinenoexcept |
Get the cube collected at this order.
|
inlinenoexcept |
Get the number of packages collected at this order.
|
inlinenoexcept |
Get the weight collected at this order.
|
inlineinherited |
Provides direct access to modify the coordinates of the order.
This allows for setting or updating the geographical location of the order.
|
inlinenoexceptinherited |
Retrieves the coordinates of the order.
These coordinates represent the geographical location of the order.
|
inlinenoexceptinherited |
Get the date and time when the order was saved.
|
inlinenoexceptinherited |
Get the cube which has to be delivered at order or picked-up from the order depending on the order's type.
|
inlinenoexcept |
Get the total collected cube until this order.
|
inlinenoexceptinherited |
Get the custom data of the order.
|
inlinenoexceptinherited |
|
inlinenoexcept |
Get the cube delivered at this order.
|
inlinenoexcept |
Get the number of packages delivered at this order.
|
inlinenoexcept |
Get the weight delivered at this order.
|
inlinenoexceptinherited |
Get the id of the depot(MiscLocation) where to which the order belongs.
|
inlinenoexcept |
Get the distance between this order and the next one in the unit distance set in the ConfigurationParameters.
|
inlinenoexceptinherited |
Retrieves the first name of the owner of the order.
|
inlinenoexceptinherited |
Get the id of the order.
It is a unique identifier of the order and it is used for update or delete.
|
inlinenoexcept |
Get the index of the order in the optimization orders list.
|
inlinenoexcept |
Get the index of the order in the route's orders list (the visiting order).
|
inlinenoexceptinherited |
Retrieves the last name of the owner of the order.
|
inlinenoexcept |
Retrieves the matched coordinates of the route order.
These coordinates represent the geographical matched location of the order.
|
inlinenoexceptinherited |
Get the number of packages which has to be delivered at order or picked-up from the order depending on the order's type.
The default value is 0.
|
inlinenoexcept |
Get the total collected packages until this order.
|
inlinenoexceptinherited |
Retrieves the phone number of the owner of the order.
|
inlinenoexceptinherited |
Get the order’s priority.
High priority orders will be the first to be visited if it is possible.
|
inlinenoexceptinherited |
Get the revenue which has to be received from the order.
|
inlinenoexcept |
Get the revenue collected until this order.
|
inlinenoexceptinherited |
Get the amount of time (in seconds) that the vehicle has to stay at the current order (to load/unload the goods).
|
inlinenoexceptinherited |
Get the order’s state.
|
inlinenoexceptinherited |
Get the order’s status.
|
inlinenoexcept |
Get the duration (in seconds) between the current order and the next one.
|
inlinenoexceptinherited |
Get the time window within which the order must be visited.
The unit is minutes since midnight, for example the pair (480, 660) means that the order can be visited between 7:00 AM and 11:00 AM
In case the time window lasts more than 24 hours, the end time is calculated in minutes from the first day. For example for the time window 6:00 PM - 10:00 AM next day we will set the pair (1080, 2040)
|
inlinenoexcept |
Get the vehicle traveled distance until this order in the unit distance set in the ConfigurationParameters.
|
inlinenoexceptinherited |
Get the order’s type.
|
inlinenoexcept |
Get the time when the order was visited.
|
inlinenoexcept |
Get the amount of time (in seconds) that the vehicle has to wait at the current order, in order to arrive at the next order between its time window.
|
inlinenoexceptinherited |
Get the weight which has to be delivered at order or picked-up from the order depending on the order's type.
|
inlinenoexcept |
Get the total collected weight until this order.
|
inlineinherited |
|
inline |
Compares two RouteOrder objects for equality.
| order | Another RouteOrder object to compare against. |
|
default |
Default copy assignment operator.
Replaces the contents of this object with a copy of another RouteOrder object.
|
defaultnoexcept |
Default move assignment operator.
Moves the contents of another RouteOrder object into this one.
|
inlineinherited |
|
inline |
Compares two RouteOrder objects for equality.
| order | Another RouteOrder object to compare against. |
|
inlinenoexceptinherited |
Sets the address for the order's location.
| address | The new address for the order. |
|
inlinenoexceptinherited |
Set the coordinates of the order.
The coordinates cannot be updated, only set at the creation of the order.
| coords | The new geographical coordinates for the order's location. |
|
inlinenoexceptinherited |
Set the cube which has to be delivered at order or picked-up from the order depending on the order's type.
By default it is 0.
| cube | The total cubic volume of the packages picked up/delivered from this order |
|
inlinenoexceptinherited |
Set the order's custom data.
Used to set other descriptive data; e.g.: regular customer
| list | The custom data as CustomDataList |
|
inlinenoexceptinherited |
Set the id of the depot where to which the order belongs.
| depotId | The id of the depot (from MiscLocation) |
|
inlinenoexcept |
Set the index of the order in the route's orders list (the visiting order).
This method is used when you want to add a order in a route at a certain position.
| indexInRoute | The index where the order should be added in route |
|
inlinenoexceptinherited |
Set the number of packages which has to be delivered at this order or picked-up from this order depending on the order's type.
By default it is 0.
| numberOfPackages | The number of packages to be pickup or delivered. |
|
inlinenoexceptinherited |
Set the order’s priority.
By default it is EOrderPriority::OP_Low.
| orderPriority | The order's priority as a EOrderPriority value |
|
inlinenoexceptinherited |
Set the revenue which has to be received from the order.
By default it is 0.
| revenue | The revenue collected from this order |
|
inlinenoexceptinherited |
Set the amount of time (in seconds) that the vehicle has to stay at the current order (to load/unload the goods).
By default it is 0.
| serviceTimeSeconds | The amount of time the vehicle spends at this order in seconds |
|
inlinenoexceptinherited |
Set the time window within which the order must be visited.
The unit is minutes since midnight, for example the pair (480, 660) means that the order can be visited between 7:00 AM and 11:00 AM
In case the time window lasts more than 24 hours, the end time is calculated in minutes from the first day. For example for the time window 6:00 PM - 10:00 AM next day we will set the pair (1080, 2040)
| timeWindowInMinutes | a pair of two ints: the first one is the start of the time window and the second one is the end of the time window |
|
inlinenoexceptinherited |
Set the order’s type.
By default it is EOrderType::OT_PickUp.
| orderType | The type of the order as a EOrderType value. |
|
inlinenoexceptinherited |
Set the weight which has to be delivered at order or picked-up from the order depending on the order's type.
By default it is 0. The unit is kg.
| weightKg | The total weight of the packages picked up/delivered from this order |