lsst.pex.config  13.0-2-g483026c+3
 All Classes Namespaces Files Functions Variables Properties Macros Pages
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:

Public Member Functions

def __init__
 
def rename
 
def validate
 
def toDict
 
def save
 
def freeze
 

Public Attributes

 keytype
 
 itemtype
 
 dictCheck
 
 itemCheck
 

Static Public Attributes

 DictClass = ConfigDict
 

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

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

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

Definition at line 164 of file configDictField.py.

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

Definition at line 123 of file configDictField.py.

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

Definition at line 152 of file configDictField.py.

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

Definition at line 141 of file configDictField.py.

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

Definition at line 130 of file configDictField.py.

Member Data Documentation

lsst.pex.config.configDictField.ConfigDictField.dictCheck

Definition at line 120 of file configDictField.py.

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

Definition at line 101 of file configDictField.py.

lsst.pex.config.configDictField.ConfigDictField.itemCheck

Definition at line 121 of file configDictField.py.

lsst.pex.config.configDictField.ConfigDictField.itemtype

Definition at line 119 of file configDictField.py.

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: