lsst.pex.config  13.0-4-gbcd7061+3
 All Classes Namespaces Files Functions Variables Properties Macros Pages
Public Member Functions | Public Attributes | List of all members
lsst.pex.config.listField.ListField Class Reference
Inheritance diagram for lsst.pex.config.listField.ListField:

Public Member Functions

def __init__
 
def validate
 
def __set__
 
def toDict
 

Public Attributes

 listCheck
 
 itemCheck
 
 itemtype
 
 length
 
 minLength
 
 maxLength
 

Detailed Description

Defines a field which is a container of values of type dtype

If length is not None, then instances of this field must match this length
exactly.
If minLength is not None, then instances of the field must be no shorter
then minLength
If maxLength is not None, then instances of the field must be no longer
than maxLength

Additionally users can provide two check functions:
listCheck - used to validate the list as a whole, and
itemCheck - used to validate each item individually

Definition at line 154 of file listField.py.

Constructor & Destructor Documentation

def lsst.pex.config.listField.ListField.__init__ (   self,
  doc,
  dtype,
  default = None,
  optional = False,
  listCheck = None,
  itemCheck = None,
  length = None,
  minLength = None,
  maxLength = None 
)

Definition at line 171 of file listField.py.

Member Function Documentation

def lsst.pex.config.listField.ListField.__set__ (   self,
  instance,
  value,
  at = None,
  label = "assignment" 
)

Definition at line 225 of file listField.py.

def lsst.pex.config.listField.ListField.toDict (   self,
  instance 
)

Definition at line 240 of file listField.py.

def lsst.pex.config.listField.ListField.validate (   self,
  instance 
)
ListField validation ensures that non-optional fields are not None,
    and that non-None values comply with length requirements and
    that the list passes listCheck if supplied by the user.
Individual Item checks are applied at set time and are not re-checked.

Definition at line 201 of file listField.py.

Member Data Documentation

lsst.pex.config.listField.ListField.itemCheck

Definition at line 195 of file listField.py.

lsst.pex.config.listField.ListField.itemtype

Definition at line 196 of file listField.py.

lsst.pex.config.listField.ListField.length

Definition at line 197 of file listField.py.

lsst.pex.config.listField.ListField.listCheck

Definition at line 194 of file listField.py.

lsst.pex.config.listField.ListField.maxLength

Definition at line 199 of file listField.py.

lsst.pex.config.listField.ListField.minLength

Definition at line 198 of file listField.py.


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