delivery_solver.py 2.49 KB
Newer Older
1 2 3 4 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 32
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2009 Nexedi SARL and Contributors. All Rights Reserved.
#                    Łukasz Nowak <luke@nexedi.com>
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility 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
# guarantees and support are strongly advised 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.
#
##############################################################################

from zope.interface import Interface

class IDeliverySolver(Interface):
33
  """Delivery Solver interface specification
34

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
  This interface must be implemented by all delivery solvers
  which are used to solve quantity related divergences in ERP5 simulation. 
  Delivery solvers are usually built by SolverTool and invoked by target solvers.

  Delivery solvers are initialised with a list of simulation movements
  and provide methods (setQuantity, getQuantity) to manipulate the total
  quantity of movements.
  """
  
  def __init__(movement_list):
    """
    Initialises the delivery solver.

    movement_list -- a list of simulation movement on which delivery solver operates
    """

  def getTotalQuantity():
    """
    Return the total quantity by summing the quantity of each simulation
    movement.
    """

  def setTotalQuantity(quantity):
    """
    Sets the total quantity of simulation movements by increasing or reducing
    the quantity and ratio of each simulation movement. This method
    implements the solver specific algorith (ex. FIFO, LIFO, average, least cost)

    NOTE: is this the right place to update delivery ratio ?
    """