lsst.pex.config  16.0-13-g118c103+3
Public Member Functions | List of all members
lsst.pex.config.configChoiceField.SelectionSet Class Reference
Inheritance diagram for lsst.pex.config.configChoiceField.SelectionSet:

Public Member Functions

def __init__ (self, dict_, value, at=None, label="assignment", setHistory=True)
 
def add (self, value, at=None)
 
def discard (self, value, at=None)
 
def __len__ (self)
 
def __iter__ (self)
 
def __contains__ (self, value)
 
def __repr__ (self)
 
def __str__ (self)
 

Detailed Description

A mutable set class that tracks the selection of multi-select
`~lsst.pex.config.ConfigChoiceField` objects.

Parameters
----------
dict_ : `ConfigInstanceDict`
    The dictionary of instantiated configs.
value
    The selected key.
at : `lsst.pex.config.callStack.StackFrame`, optional
    The call stack when the selection was made.
label : `str`, optional
    Label for history tracking.
setHistory : `bool`, optional
    Add this even to the history, if `True`.

Notes
-----
This class allows a user of a multi-select
`~lsst.pex.config.ConfigChoiceField` to add or discard items from the set
of active configs. Each change to the selection is tracked in the field's
history.

Definition at line 33 of file configChoiceField.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pex.config.configChoiceField.SelectionSet.__init__ (   self,
  dict_,
  value,
  at = None,
  label = "assignment",
  setHistory = True 
)

Definition at line 58 of file configChoiceField.py.

Member Function Documentation

◆ __contains__()

def lsst.pex.config.configChoiceField.SelectionSet.__contains__ (   self,
  value 
)

Definition at line 120 of file configChoiceField.py.

◆ __iter__()

def lsst.pex.config.configChoiceField.SelectionSet.__iter__ (   self)

Definition at line 117 of file configChoiceField.py.

◆ __len__()

def lsst.pex.config.configChoiceField.SelectionSet.__len__ (   self)

Definition at line 114 of file configChoiceField.py.

◆ __repr__()

def lsst.pex.config.configChoiceField.SelectionSet.__repr__ (   self)

Definition at line 123 of file configChoiceField.py.

◆ __str__()

def lsst.pex.config.configChoiceField.SelectionSet.__str__ (   self)

Definition at line 126 of file configChoiceField.py.

◆ add()

def lsst.pex.config.configChoiceField.SelectionSet.add (   self,
  value,
  at = None 
)
Add a value to the selected set.

Definition at line 81 of file configChoiceField.py.

◆ discard()

def lsst.pex.config.configChoiceField.SelectionSet.discard (   self,
  value,
  at = None 
)
Discard a value from the selected set.

Definition at line 98 of file configChoiceField.py.


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