lsst.daf.base  16.0-9-g2f60796+2
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)
 
def __eq__ (self, other)
 
def __copy__ (self)
 
def __deepcopy__ (self, memo)
 
def __contains__ (self, name)
 
def __setitem__ (self, name, value)
 
def __delitem__ (self, name)
 
def __str__ (self)
 
def __len__ (self)
 
def __iter__ (self)
 
def keys (self)
 
def __reduce__ (self)
 

Detailed Description

Definition at line 327 of file propertyContainerContinued.py.

Member Function Documentation

◆ __contains__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__contains__ (   self,
  name 
)

Definition at line 486 of file propertyContainerContinued.py.

◆ __copy__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__copy__ (   self)

Definition at line 474 of file propertyContainerContinued.py.

◆ __deepcopy__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__deepcopy__ (   self,
  memo 
)

Definition at line 481 of file propertyContainerContinued.py.

◆ __delitem__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__delitem__ (   self,
  name 
)

Definition at line 499 of file propertyContainerContinued.py.

◆ __eq__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__eq__ (   self,
  other 
)

Definition at line 458 of file propertyContainerContinued.py.

◆ __iter__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__iter__ (   self)

Definition at line 511 of file propertyContainerContinued.py.

◆ __len__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__len__ (   self)

Definition at line 508 of file propertyContainerContinued.py.

◆ __reduce__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__reduce__ (   self)

Definition at line 518 of file propertyContainerContinued.py.

◆ __setitem__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__setitem__ (   self,
  name,
  value 
)

Definition at line 490 of file propertyContainerContinued.py.

◆ __str__()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.__str__ (   self)

Definition at line 505 of file propertyContainerContinued.py.

◆ 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 410 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
------
KeyError
    If the item does not exist.

Definition at line 338 of file propertyContainerContinued.py.

◆ getArray()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.getArray (   self,
  name 
)
Return an item as an array if the item is numeric or string

If the item is a `PropertySet`, `PropertyList` or
`lsst.daf.base.PersistablePtr` then return the item as a scalar.

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

Raises
------
KeyError
    If the item does not exist.

Definition at line 360 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
------
KeyError
    If the item does not exist.

Definition at line 378 of file propertyContainerContinued.py.

◆ keys()

def lsst.daf.base.propertyContainer.propertyContainerContinued.PropertySet.keys (   self)

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

◆ toDict()

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

Returns
-------
d : `dict`
    Dictionary with all names and values (no comments).

Definition at line 439 of file propertyContainerContinued.py.


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