lsst.pex.config  13.0-3-g520d906+6
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pex.config.rangeField.RangeField Class Reference
Inheritance diagram for lsst.pex.config.rangeField.RangeField:
lsst.pex.config.config.Field

Public Member Functions

def __init__ (self, doc, dtype, default=None, optional=False, min=None, max=None, inclusiveMin=True, inclusiveMax=False)
 
- Public Member Functions inherited from lsst.pex.config.config.Field
def __init__ (self, doc, dtype, default=None, check=None, optional=False)
 
def rename (self, instance)
 
def validate (self, instance)
 
def freeze (self, instance)
 
def save (self, outfile, instance)
 
def toDict (self, instance)
 
def __get__ (self, instance, owner=None, at=None, label="default")
 
def __set__ (self, instance, value, at=None, label='assignment')
 
def __delete__ (self, instance, at=None, label='deletion')
 

Public Attributes

 min
 
 max
 
 rangeString
 
 maxCheck
 
 minCheck
 
- Public Attributes inherited from lsst.pex.config.config.Field
 dtype
 
 doc
 
 default
 
 check
 
 optional
 
 source
 

Static Public Attributes

 supportedTypes = set((int, float))
 
- Static Public Attributes inherited from lsst.pex.config.config.Field
 supportedTypes = set((str, unicode, basestring, oldStringType, bool, float, int, complex))
 

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

◆ __init__()

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.

Member Data Documentation

◆ max

lsst.pex.config.rangeField.RangeField.max

Definition at line 55 of file rangeField.py.

◆ maxCheck

lsst.pex.config.rangeField.RangeField.maxCheck

Definition at line 64 of file rangeField.py.

◆ min

lsst.pex.config.rangeField.RangeField.min

Definition at line 54 of file rangeField.py.

◆ minCheck

lsst.pex.config.rangeField.RangeField.minCheck

Definition at line 68 of file rangeField.py.

◆ rangeString

lsst.pex.config.rangeField.RangeField.rangeString

Definition at line 57 of file rangeField.py.

◆ supportedTypes

lsst.pex.config.rangeField.RangeField.supportedTypes = set((int, float))
static

Definition at line 38 of file rangeField.py.


The documentation for this class was generated from the following file: