|
lsst.daf.base
22.0.1-5-g15c806e+57f5c03693
|
Classes | |
| class | ReturnStyle |
| class | PropertySet |
| class | PropertyList |
Functions | |
| def | getPropertySetState (container, asLists=False) |
| def | getPropertyListState (container, asLists=False) |
| def | setPropertySetState (container, state) |
| def | setPropertyListState (container, state) |
| def lsst.daf.base.propertyContainer.propertyContainerContinued.getPropertyListState | ( | container, | |
asLists = False |
|||
| ) |
Get the state of a PropertyList in a form that can be pickled.
Parameters
----------
container : `PropertyList`
The property container.
asLists : `bool`, optional
If False, the default, `tuple` will be used for the contents. If true
a `list` will be used.
Returns
-------
state : `list` of `tuple` or `list` of `list`
The state, as a list of tuples (or lists), each of which contains
the following 4 items:
name (a `str`):
the name of the item
elementTypeName (a `str`):
the suffix of a ``setX`` method name
which is appropriate for the data type. For example integer
data has ``elementTypeName="Int"` which corresponds to
the ``setInt`` method.
value
the data for the item, in a form compatible
with the set method named by ``elementTypeName``
comment (a `str`): the comment. This item is only present
if ``container`` is a PropertyList.
Definition at line 75 of file propertyContainerContinued.py.
| def lsst.daf.base.propertyContainer.propertyContainerContinued.getPropertySetState | ( | container, | |
asLists = False |
|||
| ) |
Get the state of a PropertySet in a form that can be pickled.
Parameters
----------
container : `PropertySet`
The property container.
asLists : `bool`, optional
If False, the default, `tuple` will be used for the contents. If true
a `list` will be used.
Returns
-------
state : `list` of `tuple` or `list` of `list`
The state, as a list of tuples (or lists), each of which contains
the following 3 items:
name (a `str`)
the name of the item
elementTypeName (a `str`)
the suffix of a ``setX`` method name
which is appropriate for the data type. For example integer
data has ``elementTypeName="Int"` which corresponds to
the ``setInt`` method.
value
the data for the item, in a form compatible
with the set method named by ``elementTypeName``
Definition at line 40 of file propertyContainerContinued.py.
| def lsst.daf.base.propertyContainer.propertyContainerContinued.setPropertyListState | ( | container, | |
| state | |||
| ) |
Restore the state of a PropertyList, in place.
Parameters
----------
container : `PropertyList`
The property container whose state is to be restored.
It should be empty to start with and is updated in place.
state : `list`
The state, as returned by ``getPropertyListState``
Definition at line 130 of file propertyContainerContinued.py.
| def lsst.daf.base.propertyContainer.propertyContainerContinued.setPropertySetState | ( | container, | |
| state | |||
| ) |
Restore the state of a PropertySet, in place.
Parameters
----------
container : `PropertySet`
The property container whose state is to be restored.
It should be empty to start with and is updated in place.
state : `list`
The state, as returned by `getPropertySetState`
Definition at line 112 of file propertyContainerContinued.py.