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

Public Member Functions

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

Public Attributes

 target
 
 ConfigClass
 

Detailed Description

A variant of a ConfigField which has a known configurable target

Behaves just like a ConfigField except that it can be 'retargeted' to point
at a different configurable. Further you can 'apply' to construct a fully
configured configurable.

Definition at line 144 of file configurableField.py.

Constructor & Destructor Documentation

def lsst.pex.config.configurableField.ConfigurableField.__init__ (   self,
  doc,
  target,
  ConfigClass = None,
  default = None,
  check = None 
)
@param target is the configurable target. Must be callable, and the first
parameter will be the value of this field
@param ConfigClass is the class of Config object expected by the target.
If not provided by target.ConfigClass it must be provided explicitly in this argument

Definition at line 171 of file configurableField.py.

Member Function Documentation

def lsst.pex.config.configurableField.ConfigurableField.__deepcopy__ (   self,
  memo 
)
Customize deep-copying, because we always want a reference to the original typemap.

WARNING: this must be overridden by subclasses if they change the constructor signature!

Definition at line 265 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.__get__ (   self,
  instance,
  owner = None,
  at = None,
  label = "default" 
)

Definition at line 201 of file configurableField.py.

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

Definition at line 207 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.freeze (   self,
  instance 
)

Definition at line 249 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.rename (   self,
  instance 
)

Definition at line 227 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.save (   self,
  outfile,
  instance 
)

Definition at line 232 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.toDict (   self,
  instance 
)

Definition at line 253 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.validate (   self,
  instance 
)

Definition at line 257 of file configurableField.py.

def lsst.pex.config.configurableField.ConfigurableField.validateTarget (   self,
  target,
  ConfigClass 
)

Definition at line 155 of file configurableField.py.

Member Data Documentation

lsst.pex.config.configurableField.ConfigurableField.ConfigClass

Definition at line 190 of file configurableField.py.

lsst.pex.config.configurableField.ConfigurableField.target

Definition at line 189 of file configurableField.py.


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