lsst.daf.base  16.0-3-g099ede0
Public Member Functions | List of all members
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList Class Reference

Public Member Functions

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 toList (self)
 
def toOrderedDict (self)
 

Detailed Description

Definition at line 346 of file propertyContainerContinued.py.

Member Function Documentation

◆ 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 436 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
------
lsst.pex.exceptions.NotFoundError
    If the item does not exist.

Definition at line 364 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
------
lsst.pex.exceptions.NotFoundError
    If the item does not exist.

Definition at line 386 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
------
lsst.pex.exceptions.NotFoundError
    If the item does not exist.

Definition at line 401 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 418 of file propertyContainerContinued.py.

◆ toList()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertyList.toList (   self)

Definition at line 469 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.

Definition at line 482 of file propertyContainerContinued.py.


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