LSSTApplications  19.0.0-14-gb0260a2+2d714fc2ef,20.0.0+34a42eae2c,20.0.0+76f397ef0c,20.0.0+8558dd3f48,20.0.0+a6b6977b51,20.0.0+b2ea66fa67,20.0.0+cc669a8b45,20.0.0+d561663fb5,20.0.0+d778e99126,20.0.0+efe67588cf,20.0.0+f45b7d88f4,20.0.0+f7c597f720,20.0.0+fb43bee9b9,20.0.0+fb4d547e0d,20.0.0-1-g10df615+d8b88ec1b5,20.0.0-1-g253301a+a6b6977b51,20.0.0-1-g498fb60+ff88705a28,20.0.0-1-g4d801e7+ce0d01dabd,20.0.0-1-g5b95a8c+24eaf908b3,20.0.0-1-g8a53f90+2817c06967,20.0.0-1-gc96f8cb+fb4d547e0d,20.0.0-1-gd1c87d7+2817c06967,20.0.0-1-gdb27ee5+abab67204f,20.0.0-13-ge998c5c+9f8c516ffa,20.0.0-18-g08fba245+88079d2923,20.0.0-2-gec03fae+fb98bf9d97,20.0.0-3-gdd5c15c+a61313b210,20.0.0-34-gdb4d86a+b43b2c05ff,20.0.0-4-g4a2362f+f45b7d88f4,20.0.0-4-gfea843c+f45b7d88f4,20.0.0-5-gac0d578b1+a8c4e2ada3,20.0.0-5-gfcebe35+cfceff6a24,20.0.0-6-g01203fff+e332440eaf,20.0.0-8-gea2affd+48c001ce3c,20.0.0-9-gabd0d4c+abab67204f,20.0.0-9-gf3ab18e+fb4d547e0d,w.2020.33
LSSTDataManagementBasePackage
Public Member Functions | List of all members
pex.config.configChoiceField.SelectionSet Class Reference
Inheritance diagram for 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 38 of file configChoiceField.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 63 of file configChoiceField.py.

63  def __init__(self, dict_, value, at=None, label="assignment", setHistory=True):
64  if at is None:
65  at = getCallStack()
66  self._dict = dict_
67  self._field = self._dict._field
68  self._config = self._dict._config
69  self.__history = self._config._history.setdefault(self._field.name, [])
70  if value is not None:
71  try:
72  for v in value:
73  if v not in self._dict:
74  # invoke __getitem__ to ensure it's present
75  self._dict.__getitem__(v, at=at)
76  except TypeError:
77  msg = "Value %s is of incorrect type %s. Sequence type expected" % (value, _typeStr(value))
78  raise FieldValidationError(self._field, self._config, msg)
79  self._set = set(value)
80  else:
81  self._set = set()
82 
83  if setHistory:
84  self.__history.append(("Set selection to %s" % self, at, label))
85 

Member Function Documentation

◆ __contains__()

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

Definition at line 125 of file configChoiceField.py.

125  def __contains__(self, value):
126  return value in self._set
127 

◆ __iter__()

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

Definition at line 122 of file configChoiceField.py.

122  def __iter__(self):
123  return iter(self._set)
124 

◆ __len__()

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

Definition at line 119 of file configChoiceField.py.

119  def __len__(self):
120  return len(self._set)
121 

◆ __repr__()

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

Definition at line 128 of file configChoiceField.py.

128  def __repr__(self):
129  return repr(list(self._set))
130 

◆ __str__()

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

Definition at line 131 of file configChoiceField.py.

131  def __str__(self):
132  return str(list(self._set))
133 
134 

◆ add()

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

Definition at line 86 of file configChoiceField.py.

86  def add(self, value, at=None):
87  """Add a value to the selected set.
88  """
89  if self._config._frozen:
90  raise FieldValidationError(self._field, self._config,
91  "Cannot modify a frozen Config")
92 
93  if at is None:
94  at = getCallStack()
95 
96  if value not in self._dict:
97  # invoke __getitem__ to make sure it's present
98  self._dict.__getitem__(value, at=at)
99 
100  self.__history.append(("added %s to selection" % value, at, "selection"))
101  self._set.add(value)
102 

◆ discard()

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

Definition at line 103 of file configChoiceField.py.

103  def discard(self, value, at=None):
104  """Discard a value from the selected set.
105  """
106  if self._config._frozen:
107  raise FieldValidationError(self._field, self._config,
108  "Cannot modify a frozen Config")
109 
110  if value not in self._dict:
111  return
112 
113  if at is None:
114  at = getCallStack()
115 
116  self.__history.append(("removed %s from selection" % value, at, "selection"))
117  self._set.discard(value)
118 
The documentation for this class was generated from the following file:
ast::append
std::shared_ptr< FrameSet > append(FrameSet const &first, FrameSet const &second)
Construct a FrameSet that performs two transformations in series.
Definition: functional.cc:33
pex.config.callStack.getCallStack
def getCallStack(skip=0)
Definition: callStack.py:175
list
daf::base::PropertyList * list
Definition: fits.cc:913
set
daf::base::PropertySet * set
Definition: fits.cc:912
astshim.fitsChanContinued.iter
def iter(self)
Definition: fitsChanContinued.py:88
Generated on Fri Aug 21 2020 08:01:54 for LSSTApplications by   doxygen 1.8.18