DeliverySolver.py 2.24 KB
Newer Older
Łukasz Nowak's avatar
Łukasz Nowak committed
1
# -*- coding: utf-8 -*-
Jean-Paul Smets's avatar
Jean-Paul Smets committed
2 3
##############################################################################
#
Łukasz Nowak's avatar
Łukasz Nowak committed
4
# Copyright (c) 2002-2009 Nexedi SA and Contributors. All Rights Reserved.
Jean-Paul Smets's avatar
Jean-Paul Smets committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
#                    Jean-Paul Smets-Solanes <jp@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsability of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# garantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

class DeliverySolver:
  """
Łukasz Nowak's avatar
Łukasz Nowak committed
32 33 34 35 36 37 38 39 40 41 42
    Delivery solver is used to have control of how quantity property is
    accepted into simulation.

    Delivery solver is only used for quantity property.

    Delivery solver is working on movement's quantity and related simulation
    movements' quantities.

    Can be used to:

     * distribute
43
     * queue (FIFO, LIFO, ...)
Łukasz Nowak's avatar
Łukasz Nowak committed
44
     * etc
Jean-Paul Smets's avatar
Jean-Paul Smets committed
45 46
  """

47
  def __init__(self, simulation_tool=None, **kw):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
48
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
49
      Initialisation
Jean-Paul Smets's avatar
Jean-Paul Smets committed
50 51 52 53
    """
    self.simulation_tool = simulation_tool
    self.__dict__.update(kw)

Łukasz Nowak's avatar
Łukasz Nowak committed
54
  def solveMovement(self, movement):
Jean-Paul Smets's avatar
Jean-Paul Smets committed
55
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
56
      Solves a delivery movement
Jean-Paul Smets's avatar
Jean-Paul Smets committed
57
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
58
    raise NotImplementedError
Jean-Paul Smets's avatar
Jean-Paul Smets committed
59 60 61

  def solveDelivery(self, delivery):
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
62
      Solves the delivery itself
Jean-Paul Smets's avatar
Jean-Paul Smets committed
63
    """
Łukasz Nowak's avatar
Łukasz Nowak committed
64 65 66 67
    result_list = []
    for movement in delivery.getMovementList():
      result_list.append(self.solveMovement(movement))
    return result_list