lsst.afw g2603b601e3+f394777a51
Public Member Functions | Static Public Attributes | List of all members
lsst.afw.typehandling._GenericMap.GenericMap Class Reference
Inheritance diagram for lsst.afw.typehandling._GenericMap.GenericMap:
lsst.afw.typehandling._GenericMap.MutableGenericMap lsst.afw.typehandling._SimpleGenericMap.SimpleGenericMap

Public Member Functions

def __repr__ (self)
 
def __eq__ (self, other)
 

Static Public Attributes

 keys = Mapping.keys
 
 values = Mapping.values
 
 items = Mapping.items
 

Detailed Description

An abstract `~collections.abc.Mapping` for use when sharing a
map between C++ and Python.

For compatibility with C++, ``GenericMap`` has the following
restrictions:

    - all keys must be of the same type
    - values must be built-in types or subclasses of
      `lsst.afw.typehandling.Storable`. Almost any user-defined class in
      C++ or Python can have `~lsst.afw.typehandling.Storable` as a mixin.

As a safety precaution, `~lsst.afw.typehandling.Storable` objects that are
added from C++ may be copied when you retrieve them from Python, making it
impossible to modify them in-place. This issue does not affect objects that
are added from Python, or objects that are always passed by
:cpp:class:`shared_ptr` in C++.

Definition at line 30 of file _GenericMap.py.

Member Function Documentation

◆ __eq__()

def lsst.afw.typehandling._GenericMap.GenericMap.__eq__ (   self,
  other 
)

Definition at line 55 of file _GenericMap.py.

◆ __repr__()

def lsst.afw.typehandling._GenericMap.GenericMap.__repr__ (   self)

Definition at line 49 of file _GenericMap.py.

Member Data Documentation

◆ items

lsst.afw.typehandling._GenericMap.GenericMap.items = Mapping.items
static

Definition at line 70 of file _GenericMap.py.

◆ keys

lsst.afw.typehandling._GenericMap.GenericMap.keys = Mapping.keys
static

Definition at line 68 of file _GenericMap.py.

◆ values

lsst.afw.typehandling._GenericMap.GenericMap.values = Mapping.values
static

Definition at line 69 of file _GenericMap.py.


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