Merge pull request #601 from CapnBry/reloadscene

[cura.git] / Cura / util / validators.py

diff --git a/Cura/util/validators.py b/Cura/util/validators.py
index 4decec0b55ab8bae019eea2f6604ff20d4795d5c..c1052d6ad0f2d81f44740e3844e07692c291fa0e 100644 (file)
--- a/Cura/util/validators.py
+++ b/Cura/util/validators.py
@@ -1,5 +1,14 @@
-from __future__ import absolute_import
+"""
+Setting validators.
+These are the validators for various profile settings, each validator can be attached to a setting.
+The validators can be queried to see if the setting is valid.
+There are 3 possible outcomes:
+       Valid   - No problems found
+       Warning - The value is valid, but not recommended
+       Error   - The value is not a proper number, out of range, or some other way wrong.
+"""
 from __future__ import division
+__copyright__ = "Copyright (C) 2013 David Braam - Released under terms of the AGPLv3 License"
 
 import types
 import math
@@ -9,6 +18,11 @@ WARNING = 1
 ERROR   = 2
 
 class validFloat(object):
+       """
+       Checks if the given value in the setting is a valid float. An invalid float is an error condition.
+       And supports a minimum and/or maximum value. The min/max values are error conditions.
+       If the value == min or max then this is also an error.
+       """
        def __init__(self, setting, minValue = None, maxValue = None):
                self.setting = setting
                self.setting._validators.append(self)
@@ -27,6 +41,11 @@ class validFloat(object):
                        return ERROR, '"' + str(self.setting.getValue()) + '" is not a valid number or expression'
 
 class validInt(object):
+       """
+       Checks if the given value in the setting is a valid integer. An invalid integer is an error condition.
+       And supports a minimum and/or maximum value. The min/max values are error conditions.
+       If the value == min or max then this is also an error.
+       """
        def __init__(self, setting, minValue = None, maxValue = None):
                self.setting = setting
                self.setting._validators.append(self)
@@ -45,6 +64,9 @@ class validInt(object):
                        return ERROR, '"' + str(self.setting.getValue()) + '" is not a valid whole number or expression'
 
 class warningAbove(object):
+       """
+       A validator to give off a warning if a value is equal or above a certain value.
+       """
        def __init__(self, setting, minValueForWarning, warningMessage):
                self.setting = setting
                self.setting._validators.append(self)
@@ -65,7 +87,36 @@ class warningAbove(object):
                        #We already have an error by the int/float validator in this case.
                        return SUCCESS, ''
 
+class warningBelow(object):
+       """
+       A validator to give off a warning if a value is equal or below a certain value.
+       """
+       def __init__(self, setting, minValueForWarning, warningMessage):
+               self.setting = setting
+               self.setting._validators.append(self)
+               self.minValueForWarning = minValueForWarning
+               self.warningMessage = warningMessage
+
+       def validate(self):
+               try:
+                       f = float(eval(self.setting.getValue().replace(',','.'), {}, {}))
+                       if isinstance(self.minValueForWarning, types.FunctionType):
+                               if f <= self.minValueForWarning():
+                                       return WARNING, self.warningMessage % (self.minValueForWarning())
+                       else:
+                               if f <= self.minValueForWarning:
+                                       return WARNING, self.warningMessage
+                       return SUCCESS, ''
+               except (ValueError, SyntaxError, TypeError):
+                       #We already have an error by the int/float validator in this case.
+                       return SUCCESS, ''
+
 class wallThicknessValidator(object):
+       """
+       Special wall-thickness validator. The wall thickness is used to calculate the amount of shells and the thickness of the shells.
+       But, on certain conditions the resulting wall-thickness is not really suitable for printing. The range in which this can happen is small.
+       But better warn for it.
+       """
        def __init__(self, setting):
                self.setting = setting
                self.setting._validators.append(self)
@@ -75,12 +126,16 @@ class wallThicknessValidator(object):
                try:
                        wallThickness = profile.getProfileSettingFloat('wall_thickness')
                        nozzleSize = profile.getProfileSettingFloat('nozzle_size')
+                       if wallThickness < 0.01:
+                               return SUCCESS, ''
                        if wallThickness <= nozzleSize * 0.5:
                                return ERROR, 'Trying to print walls thinner then the half of your nozzle size, this will not produce anything usable'
                        if wallThickness <= nozzleSize * 0.85:
                                return WARNING, 'Trying to print walls thinner then the 0.8 * nozzle size. Small chance that this will produce usable results'
                        if wallThickness < nozzleSize:
                                return SUCCESS, ''
+                       if nozzleSize <= 0:
+                               return ERROR, 'Incorrect nozzle size'
                        
                        lineCount = int(wallThickness / nozzleSize)
                        lineWidth = wallThickness / lineCount
@@ -93,6 +148,11 @@ class wallThicknessValidator(object):
                        return SUCCESS, ''
 
 class printSpeedValidator(object):
+       """
+       Validate the printing speed by checking for a certain amount of volume per second.
+       This is based on the fact that you can push 10mm3 per second trough an UM-Origonal nozzle.
+       TODO: Update this code so it works better for different machine times with other feeders.
+       """
        def __init__(self, setting):
                self.setting = setting
                self.setting._validators.append(self)
@@ -116,4 +176,3 @@ class printSpeedValidator(object):
                except ValueError:
                        #We already have an error by the int/float validator in this case.
                        return SUCCESS, ''
-