lsst.daf.base  16.0-4-g50d071e
Classes | Functions
lsst.daf.base.propertyContainer.propertyContainerContinued Namespace Reference

Classes

class  PropertyList
 
class  PropertySet
 
class  ReturnStyle
 

Functions

def getPropertySetState (container)
 
def getPropertyListState (container)
 
def setPropertySetState (container, state)
 
def setPropertyListState (container, state)
 

Function Documentation

◆ getPropertyListState()

def lsst.daf.base.propertyContainer.propertyContainerContinued.getPropertyListState (   container)
Get the state of a PropertyList in a form that can be pickled.

Parameters
----------
container : `PropertyList`
    The property container.

Returns
-------
state : `list`
    The state, as a list of tuples, 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 65 of file propertyContainerContinued.py.

◆ getPropertySetState()

def lsst.daf.base.propertyContainer.propertyContainerContinued.getPropertySetState (   container)
Get the state of a PropertySet in a form that can be pickled.

Parameters
----------
container : `PropertySet`\
    The property container.

Returns
-------
state : `list`
    The state, as a list of tuples, 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 39 of file propertyContainerContinued.py.

◆ setPropertyListState()

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 109 of file propertyContainerContinued.py.

◆ setPropertySetState()

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 94 of file propertyContainerContinued.py.