lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField Class Reference

Inheritance diagram for lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField:

Public Member Functions
def	__init__ (self, str doc, Optional[Mapping[str, ConfigurableAction]] default=None, bool optional=False, deprecated=None)
def	__class_getitem__ (cls, params)
def	__set__ (self, Config instance, Union[None, Mapping[str, ConfigurableAction], SimpleNamespace, Struct, ConfigurableActionStruct, ConfigurableActionStructField, Type[ConfigurableActionStructField]] value, Iterable[StackFrame] at=None, str label='assigment')
ConfigurableActionStruct[ActionTypeVar]	__get__ (self, None instance, Any owner=None, Any at=None, str label='default')
ConfigurableActionStruct[ActionTypeVar]	__get__ (self, Config instance, Any owner=None, Any at=None, str label='default')
def	__get__ (self, instance, owner=None, at=None, label='default')
def	rename (self, Config instance)
def	validate (self, Config 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")
None	__set__ (self, "Config" instance, Optional[FieldTypeVar] value, Any at=None, str label="assignment")
def	__delete__ (self, instance, at=None, label="deletion")

Public Attributes
	default

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 manner 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 230 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 249 of file _configurableActionStructField.py.

Member Function Documentation

__class_getitem__()

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__class_getitem__	(		cls,
			params
	)

Definition at line 256 of file _configurableActionStructField.py.

__get__() [1/3]

ConfigurableActionStruct[ActionTypeVar] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(		self,
		Config	instance,
		Any	owner = None,
		Any	at = None,
		str	label = 'default'
	)

Definition at line 313 of file _configurableActionStructField.py.

__get__() [2/3]

def lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(		self,
			instance,
			owner = None,
			at = None,
			label = 'default'
	)

Definition at line 322 of file _configurableActionStructField.py.

__get__() [3/3]

ConfigurableActionStruct[ActionTypeVar] lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.__get__	(		self,
		None	instance,
		Any	owner = None,
		Any	at = None,
		str	label = 'default'
	)

Definition at line 303 of file _configurableActionStructField.py.

__set__()

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

Definition at line 259 of file _configurableActionStructField.py.

freeze()

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

Definition at line 372 of file _configurableActionStructField.py.

rename()

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

Definition at line 335 of file _configurableActionStructField.py.

save()

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

Definition at line 358 of file _configurableActionStructField.py.

toDict()

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

Definition at line 349 of file _configurableActionStructField.py.

validate()

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

Definition at line 343 of file _configurableActionStructField.py.

Member Data Documentation

default

lsst.pipe.tasks.configurableActions._configurableActionStructField.ConfigurableActionStructField.default

Definition at line 275 of file _configurableActionStructField.py.

StructClass

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

static

Definition at line 242 of file _configurableActionStructField.py.

---

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

• python/lsst/pipe/tasks/configurableActions/_configurableActionStructField.py