lsst.pex.config.configChoiceField.ConfigInstanceDict Class Reference

Inheritance diagram for lsst.pex.config.configChoiceField.ConfigInstanceDict:

Public Member Functions
	__init__ (self, Config config, ConfigChoiceField field)
	types (self)
	__contains__ (self, k)
	__len__ (self)
	__iter__ (self)
	__getitem__ (self, k, at=None, label="default")
	__setitem__ (self, k, value, at=None, label="assignment")
	__setattr__ (self, attr, value, at=None, label="assignment")
	freeze (self)
	__reduce__ (self)

Public Attributes
	types

Protected Member Functions
ConfigInstanceDict	_copy (self, Config config)
	_setSelection (self, value, at=None, label="assignment")
	_getNames (self)
	_setNames (self, value)
	_delNames (self)
	_getName (self)
	_setName (self, value)
	_delName (self)
	_getActive (self)
	_rename (self, fullname)

Protected Attributes
dict	_dict = {}
	_selection = None
	_config = config
	_field = field
	_history = config._history.setdefault(field.name, [])
	_typemap = None

Properties
	names = property(_getNames, _setNames, _delNames)
	name = property(_getName, _setName, _delName)
	active = property(_getActive)

Detailed Description

Dictionary of instantiated configs, used to populate a
`~lsst.pex.config.ConfigChoiceField`.

Parameters
----------
config : `lsst.pex.config.Config`
    A configuration instance.
field : `lsst.pex.config.Field`-type
    A configuration field. Note that the `lsst.pex.config.Field.fieldmap`
    attribute must provide key-based access to configuration classes,
    (that is, ``typemap[name]``).

Member Function Documentation

freeze()

lsst.pex.config.configChoiceField.ConfigInstanceDict.freeze

(

self

)

Freeze the config.

Invoking this freeze method will create a local copy of the field
attribute's typemap. This decouples this instance dict from the
underlying objects type map ensuring that and subsequent changes to the
typemap will not be reflected in this instance (i.e imports adding
additional registry entries).

---

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

• python/lsst/pex/config/configChoiceField.py