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

Private Member Functions
def	_compare

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 141 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 158 of file listField.py.

            length=None, minLength=None, maxLength=None):
        if dtype not in Field.supportedTypes:
            raise ValueError("Unsupported dtype %s"%_typeStr(dtype))
        if length is not None:
            if length <= 0:
                raise ValueError("'length' (%d) must be positive"%length)
            minLength=None
            maxLength=None
        else:
            if maxLength is not None and maxLength <= 0:
                raise ValueError("'maxLength' (%d) must be positive"%maxLength)
            if minLength is not None and maxLength is not None \
                    and minLength > maxLength:
                raise ValueError("'maxLength' (%d) must be at least as large as 'minLength' (%d)"%(maxLength, minLength))
        
        if listCheck is not None and not hasattr(listCheck, "__call__"):
            raise ValueError("'listCheck' must be callable")
        if itemCheck is not None and not hasattr(itemCheck, "__call__"):
            raise ValueError("'itemCheck' must be callable")

        source = traceback.extract_stack(limit=2)[0]
        self._setup( doc=doc, dtype=List, default=default, check=None, optional=optional, source=source)
        self.listCheck = listCheck
        self.itemCheck = itemCheck
        self.itemtype = dtype
        self.length=length
        self.minLength=minLength
        self.maxLength=maxLength