lsst.pex.config.rangeField.RangeField Class Reference

Inheritance diagram for lsst.pex.config.rangeField.RangeField:

Public Member Functions
def	__init__

Public Attributes
	min
	max
	rangeString
	maxCheck
	minCheck

Static Public Attributes
tuple	supportedTypes = (int, float)

Private Member Functions
def	_validateValue

Detailed Description

Defines a Config Field which allows only a range of values.
The range is defined by providing min and/or max values.
If min or max is None, the range will be open in that direction
If inclusive[Min|Max] is True the range will include the [min|max] value

Definition at line 29 of file rangeField.py.

Constructor & Destructor Documentation

def lsst.pex.config.rangeField.RangeField.__init__	(		self,
			doc,
			dtype,
			default = None,
			optional = False,
			min = None,
			max = None,
			inclusiveMin = True,
			inclusiveMax = False
	)

Definition at line 41 of file rangeField.py.

            min=None, max=None, inclusiveMin=True, inclusiveMax=False):
        if dtype not in self.supportedTypes:
            raise ValueError("Unsupported RangeField dtype %s"%(_typeStr(dtype)))
        source = traceback.extract_stack(limit=2)[0]
        if min is None and max is None:
            raise ValueError("min and max cannot both be None")

        if min is not None and max is not None and min > max:
            swap(min, max)
        self.min = min
        self.max = max

        self.rangeString =  "%s%s,%s%s" % \
                (("[" if inclusiveMin else "("),
                ("-inf" if self.min is None else self.min),
                ("inf" if self.max is None else self.max),
                ("]" if inclusiveMax else ")"))
        doc += "\n\tValid Range = " + self.rangeString
        if inclusiveMax:
            self.maxCheck = lambda x, y: True if y is None else x <= y
        else:
            self.maxCheck = lambda x, y: True if y is None else x < y
        if inclusiveMin:
            self.minCheck = lambda x, y: True if y is None else x >= y
        else:
            self.minCheck = lambda x, y: True if y is None else x > y
        self._setup( doc, dtype=dtype, default=default, check=None, optional=optional, source=source)