lsst.pex.config  13.0-2-g483026c+2
 All Classes Namespaces Files Functions Variables Properties Macros Pages
Public Member Functions | List of all members
lsst.pex.config.configField.ConfigField Class Reference
Inheritance diagram for lsst.pex.config.configField.ConfigField:

Public Member Functions

def __init__
 
def __get__
 
def __set__
 
def rename
 
def save
 
def freeze
 
def toDict
 
def validate
 

Detailed Description

Defines a field which is itself a Config.

The behavior of this type of field is much like that of the base Field type.

Note that dtype must be a subclass of Config.

If default=None, the field will default to a default-constructed
instance of dtype.

Additionally, to allow for fewer deep-copies, assigning an instance of
ConfigField to dtype itself, is considered equivalent to assigning a
default-constructed sub-config. This means that the argument default can be
dtype, as well as an instance of dtype.

Assigning to ConfigField will update all of the fields in the config.

Definition at line 31 of file configField.py.

Constructor & Destructor Documentation

def lsst.pex.config.configField.ConfigField.__init__ (   self,
  doc,
  dtype,
  default = None,
  check = None 
)

Definition at line 50 of file configField.py.

Member Function Documentation

def lsst.pex.config.configField.ConfigField.__get__ (   self,
  instance,
  owner = None 
)

Definition at line 60 of file configField.py.

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

Definition at line 71 of file configField.py.

def lsst.pex.config.configField.ConfigField.freeze (   self,
  instance 
)

Definition at line 107 of file configField.py.

def lsst.pex.config.configField.ConfigField.rename (   self,
  instance 
)

Definition at line 99 of file configField.py.

def lsst.pex.config.configField.ConfigField.save (   self,
  outfile,
  instance 
)

Definition at line 103 of file configField.py.

def lsst.pex.config.configField.ConfigField.toDict (   self,
  instance 
)

Definition at line 111 of file configField.py.

def lsst.pex.config.configField.ConfigField.validate (   self,
  instance 
)

Definition at line 115 of file configField.py.


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