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

Public Member Functions

def __init__ (self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None)
 
def rename (self, instance)
 
def validate (self, instance)
 
def toDict (self, instance)
 
def save (self, outfile, instance)
 
def freeze (self, instance)
 
- Public Member Functions inherited from lsst.pex.config.dictField.DictField
def __init__ (self, doc, keytype, itemtype, default=None, optional=False, dictCheck=None, itemCheck=None)
 
def validate (self, instance)
 
def __set__ (self, instance, value, at=None, label="assignment")
 
def toDict (self, instance)
 
- 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

 keytype
 
 itemtype
 
 dictCheck
 
 itemCheck
 
- Public Attributes inherited from lsst.pex.config.dictField.DictField
 keytype
 
 itemtype
 
 dictCheck
 
 itemCheck
 
- Public Attributes inherited from lsst.pex.config.config.Field
 dtype
 
 doc
 
 default
 
 check
 
 optional
 
 source
 

Static Public Attributes

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

Detailed Description

Defines a field which is a mapping between a POD and a config class.

This behaves exactly like a DictField with the slight difference that
    itemtype must be an subclass of Config.

This allows config writters to create name-to-config mappings. One use case
is for configuring mappings for dataset types in a butler. In this case,
the dataset type names are arbitrary and user-selected; the mapping
configurations are known and fixed.

Definition at line 88 of file configDictField.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pex.config.configDictField.ConfigDictField.__init__ (   self,
  doc,
  keytype,
  itemtype,
  default = None,
  optional = False,
  dictCheck = None,
  itemCheck = None 
)

Definition at line 103 of file configDictField.py.

Member Function Documentation

◆ freeze()

def lsst.pex.config.configDictField.ConfigDictField.freeze (   self,
  instance 
)

Definition at line 164 of file configDictField.py.

◆ rename()

def lsst.pex.config.configDictField.ConfigDictField.rename (   self,
  instance 
)

Definition at line 123 of file configDictField.py.

◆ save()

def lsst.pex.config.configDictField.ConfigDictField.save (   self,
  outfile,
  instance 
)

Definition at line 152 of file configDictField.py.

◆ toDict()

def lsst.pex.config.configDictField.ConfigDictField.toDict (   self,
  instance 
)

Definition at line 141 of file configDictField.py.

◆ validate()

def lsst.pex.config.configDictField.ConfigDictField.validate (   self,
  instance 
)

Definition at line 130 of file configDictField.py.

Member Data Documentation

◆ dictCheck

lsst.pex.config.configDictField.ConfigDictField.dictCheck

Definition at line 120 of file configDictField.py.

◆ DictClass

lsst.pex.config.configDictField.ConfigDictField.DictClass = ConfigDict
static

Definition at line 101 of file configDictField.py.

◆ itemCheck

lsst.pex.config.configDictField.ConfigDictField.itemCheck

Definition at line 121 of file configDictField.py.

◆ itemtype

lsst.pex.config.configDictField.ConfigDictField.itemtype

Definition at line 119 of file configDictField.py.

◆ keytype

lsst.pex.config.configDictField.ConfigDictField.keytype

Definition at line 118 of file configDictField.py.


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