lsst.daf.base  15.0-3-g94bc79c+1
Public Member Functions | List of all members
lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet Class Reference

Public Member Functions

def get (self, name)
 
def getArray (self, name)
 
def getScalar (self, name)
 
def set (self, name, value)
 
def add (self, name, value)
 
def toDict (self)
 

Detailed Description

Definition at line 215 of file propertyContainerContinued.py.

Member Function Documentation

◆ add()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.add (   self,
  name,
  value 
)
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`` or
``lsst.daf.base.PropertyList`` then `value` replaces
the existing value. Also the item is added as a live
reference, so updating `value` will update this container
and vice-versa.

Raises
------
lsst::pex::exceptions::TypeError
    If the type of `value` is incompatible with the existing value
    of the item.

Definition at line 306 of file propertyContainerContinued.py.

◆ get()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.get (   self,
  name 
)
Return an item as a scalar or array

Return an array if the item is of numeric or string type and 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 233 of file propertyContainerContinued.py.

◆ getArray()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.getArray (   self,
  name 
)
Return an item as an array; the item type must be numeric or string

Parameters
----------
name : ``str``
    Name of item

Raises
------
lsst.pex.exceptions.NotFoundError
    If the item does not exist.
TypeError
    If item type is ``lsst.daf.base.PropertyList``,
    ``lsst.daf.base.PropertySet``
    or ``lsst.daf.base.PersistablePtr``.

Definition at line 255 of file propertyContainerContinued.py.

◆ getScalar()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.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 274 of file propertyContainerContinued.py.

◆ set()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.set (   self,
  name,
  value 
)
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 291 of file propertyContainerContinued.py.

◆ toDict()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.toDict (   self)
Returns a (possibly nested) dictionary with all properties.

Definition at line 335 of file propertyContainerContinued.py.


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