lsst.pipe.tasks  21.0.0-111-gf06e6c5c+fee76ed8f6
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField Class Reference
Inheritance diagram for lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField:
lsst::pex::config::config::Field

Public Member Functions

def __init__ (self, str doc, Optional[Mapping[str, ConfigurableAction]] default=None, bool optional=False, deprecated=None)
 
def __set__ (self, Config instance, Union[None, Mapping[str, ConfigurableAction], ConfigurableActionStruct] value, Iterable[StackFrame] at=None, str label='assigment')
 
Union[None, T, ConfigurableActionStruct__get__ (T self, Config instance, None owner=None, Iterable[StackFrame] at=None, str label="default")
 
def rename (self, Config instance)
 
def validate (self, instance)
 
def toDict (self, instance)
 
def save (self, outfile, instance)
 
def freeze (self, instance)
 
def rename (self, instance)
 
def validate (self, instance)
 
def freeze (self, instance)
 
def save (self, outfile, instance)
 
def toDict (self, instance)
 
def __get__ (self, instance, owner=None, at=None, label="default")
 
def __set__ (self, instance, value, at=None, label='assignment')
 
def __delete__ (self, instance, at=None, label='deletion')
 

Static Public Attributes

 StructClass = ConfigurableActionStruct
 

Detailed Description

`ConfigurableActionStructField` is a `~lsst.pex.config.Field` subclass
that allows `ConfigurableAction`\ s to be organized in a
`~lsst.pex.config.Config` class in a manor similar to how a
`~lsst.pipe.base.Struct` works.

This class implements a `ConfigurableActionStruct` as an intermediary
object to organize the `ConfigurableActions`. See it's documentation for
futher information.

Definition at line 190 of file _configurableActionStructField.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__init__ (   self,
str  doc,
Optional[Mapping[str, ConfigurableAction]]   default = None,
bool   optional = False,
  deprecated = None 
)

Definition at line 209 of file _configurableActionStructField.py.

Member Function Documentation

◆ __get__()

Union[None, T, ConfigurableActionStruct] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__ ( T  self,
Config  instance,
None   owner = None,
Iterable[StackFrame]   at = None,
str   label = "default" 
)

Definition at line 238 of file _configurableActionStructField.py.

◆ __set__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__set__ (   self,
Config  instance,
Union[None, Mapping[str, ConfigurableAction], ConfigurableActionStruct value,
Iterable[StackFrame]   at = None,
str   label = 'assigment' 
)

Definition at line 216 of file _configurableActionStructField.py.

◆ freeze()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.freeze (   self,
  instance 
)

Definition at line 281 of file _configurableActionStructField.py.

◆ rename()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.rename (   self,
Config  instance 
)

Definition at line 247 of file _configurableActionStructField.py.

◆ save()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.save (   self,
  outfile,
  instance 
)

Definition at line 269 of file _configurableActionStructField.py.

◆ toDict()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.toDict (   self,
  instance 
)

Definition at line 260 of file _configurableActionStructField.py.

◆ validate()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.validate (   self,
  instance 
)

Definition at line 254 of file _configurableActionStructField.py.

Member Data Documentation

◆ StructClass

lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.StructClass = ConfigurableActionStruct
static

Definition at line 202 of file _configurableActionStructField.py.


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