|
| def | get (self, name) |
| |
| def | getArray (self, name) |
| |
| def | getScalar (self, name) |
| |
| def | set (self, name, value, comment=None) |
| |
| def | add (self, name, value, comment=None) |
| |
| def | setComment (self, name, comment) |
| |
| def | toList (self) |
| |
| def | toOrderedDict (self) |
| |
| def | __eq__ (self, other) |
| |
| def | __copy__ (self) |
| |
| def | __deepcopy__ (self, memo) |
| |
| def | __iter__ (self) |
| |
| def | __setitem__ (self, name, value) |
| |
| def | __reduce__ (self) |
| |
◆ __copy__()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__copy__ |
( |
|
self | ) |
|
◆ __deepcopy__()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__deepcopy__ |
( |
|
self, |
|
|
|
memo |
|
) |
| |
◆ __eq__()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__eq__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
◆ __iter__()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__iter__ |
( |
|
self | ) |
|
◆ __reduce__()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__reduce__ |
( |
|
self | ) |
|
◆ __setitem__()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.__setitem__ |
( |
|
self, |
|
|
|
name, |
|
|
|
value |
|
) |
| |
◆ add()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.add |
( |
|
self, |
|
|
|
name, |
|
|
|
value, |
|
|
|
comment = None |
|
) |
| |
Append one or more values to a given item, which need not exist
If the item exists then the new value(s) are appended;
otherwise it is like calling `set`
Parameters
----------
name : `str`
Name of item
value : any supported type
Value of item; may be a scalar or array
Notes
-----
If `value` is an `lsst.daf.base.PropertySet` items are added
using dotted names (e.g. if name="a" and value contains
an item "b" which is another PropertySet and contains an
item "c" which is numeric or string, then the value of "c"
is added as "a.b.c", appended to the existing values of
"a.b.c" if any (in which case the types must be compatible).
Raises
------
lsst::pex::exceptions::TypeError
If the type of `value` is incompatible with the existing value
of the item.
Definition at line 619 of file propertyContainerContinued.py.
◆ get()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.get |
( |
|
self, |
|
|
|
name |
|
) |
| |
Return an item as a scalar or array
Return an array if the item has more than one value,
otherwise return a scalar.
.. deprecated:: 20180-06
`get` is superseded by `getArray` or `getScalar`
Parameters
----------
name : `str`
Name of item
Raises
------
KeyError
If the item does not exist.
Definition at line 547 of file propertyContainerContinued.py.
◆ getArray()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.getArray |
( |
|
self, |
|
|
|
name |
|
) |
| |
Return an item as an array
Parameters
----------
name : `str`
Name of item
Raises
------
KeyError
If the item does not exist.
Definition at line 569 of file propertyContainerContinued.py.
◆ getScalar()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.getScalar |
( |
|
self, |
|
|
|
name |
|
) |
| |
Return an item as a scalar
If the item has more than one value then the last value is returned
Parameters
----------
name : `str`
Name of item
Raises
------
KeyError
If the item does not exist.
Definition at line 584 of file propertyContainerContinued.py.
◆ set()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.set |
( |
|
self, |
|
|
|
name, |
|
|
|
value, |
|
|
|
comment = None |
|
) |
| |
Set the value of an item
If the item already exists it is silently replaced; the types
need not match.
Parameters
----------
name : `str`
Name of item
value : any supported type
Value of item; may be a scalar or array
Definition at line 601 of file propertyContainerContinued.py.
◆ setComment()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.setComment |
( |
|
self, |
|
|
|
name, |
|
|
|
comment |
|
) |
| |
Set the comment for an existing entry.
Parameters
----------
name : `str`
Name of the key to receive updated comment.
comment : `comment`
New comment string.
Definition at line 652 of file propertyContainerContinued.py.
◆ toList()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.toList |
( |
|
self | ) |
|
Return a list of tuples of name, value, comment for each property
in the order that they were inserted.
Returns
-------
ret : `list` of `tuple`
Tuples of name, value, comment for each property in the order
in which they were inserted.
Definition at line 671 of file propertyContainerContinued.py.
◆ toOrderedDict()
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.toOrderedDict |
( |
|
self | ) |
|
Return an ordered dictionary with all properties in the order that
they were inserted.
Returns
-------
d : `dict`
Ordered dictionary with all properties in the order that they
were inserted. Comments are not included.
Notes
-----
As of Python 3.6 dicts retain their insertion order.
Definition at line 693 of file propertyContainerContinued.py.
◆ COMMENTSUFFIX
| string lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.COMMENTSUFFIX = "#COMMENT" |
|
static |
◆ toDict
| def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.toDict = toOrderedDict |
|
static |
The documentation for this class was generated from the following file:
