lsst.pex.config gcc712456e1+124095ede6
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, deprecated=None)
 
- Public Member Functions inherited from lsst.pex.config.config.Field
def __init__ (self, doc, dtype, default=None, check=None, optional=False, deprecated=None)
 
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
 
 maxCheck
 
 minCheck
 
 rangeString
 
- Public Attributes inherited from lsst.pex.config.config.Field
 dtype
 
 doc
 
 deprecated
 
 default
 
 check
 
 optional
 
 source
 

Static Public Attributes

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

Detailed Description

A configuration field (`lsst.pex.config.Field` subclass) that requires
the value to be in a specific numeric range.

Parameters
----------
doc : `str`
    A description of the field.
dtype : {`int`-type, `float`-type}
    The field's data type: either the `int` or `float` type.
default : `int` or `float`, optional
    Default value for the field.
optional : `bool`, optional
    When `False`, `lsst.pex.config.Config.validate` will fail if the
    field's value is `None`.
min : int, float, or `None`, optional
    Minimum value accepted in the range. If `None`, the range has no
    lower bound (equivalent to negative infinity).
max : `int`, `float`, or None, optional
    Maximum value accepted in the range. If `None`, the range has no
    upper bound (equivalent to positive infinity).
inclusiveMin : `bool`, optional
    If `True`, the ``min`` value is included in the allowed range.
inclusiveMax : `bool`, optional
    If `True`, the ``max`` value is included in the allowed range.
deprecated : None or `str`, optional
    A description of why this Field is deprecated, including removal date.
    If not None, the string is appended to the docstring for this Field.

See also
--------
ChoiceField
ConfigChoiceField
ConfigDictField
ConfigField
ConfigurableField
DictField
Field
ListField
RegistryField

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,
  deprecated = None 
)

Reimplemented from lsst.pex.config.config.Field.


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