lsst.daf.persistence  13.0-32-g7b14ddd
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Classes | Public Member Functions | Public Attributes | List of all members
lsst.daf.persistence.butlerLocation.ButlerComposite Class Reference
Inheritance diagram for lsst.daf.persistence.butlerLocation.ButlerComposite:

Classes

class  ComponentInfo
 

Public Member Functions

def __repr__
 
def __init__
 
def add
 
def setRepository
 
def getRepository
 
def getPythonType
 

Public Attributes

 assembler
 
 disassembler
 
 python
 
 dataId
 
 mapper
 
 componentInfo
 
 repository
 

Detailed Description

Initializer

Parameters
----------
assembler : function object
    Function object or importable string to a function object that can be called with the assembler
    signature: (dataId, componentDict, cls).
disassembler : function object
    Function object or importable string to a function object that can be called with the disassembler
    signature: (object, dataId, componentDict).
python : class object
    A python class object or importable string to a class object that can be used by the assembler to
    instantiate an object to be returned.
dataId : dict or DataId
    The dataId that is used to look up components.
mapper : Mapper instance
    A reference to the mapper that created this ButlerComposite object.

Definition at line 37 of file butlerLocation.py.

Constructor & Destructor Documentation

def lsst.daf.persistence.butlerLocation.ButlerComposite.__init__ (   self,
  assembler,
  disassembler,
  python,
  dataId,
  mapper 
)

Definition at line 103 of file butlerLocation.py.

Member Function Documentation

def lsst.daf.persistence.butlerLocation.ButlerComposite.__repr__ (   self)

Definition at line 92 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerComposite.add (   self,
  id,
  datasetType,
  setter,
  getter,
  subset,
  inputOnly 
)
Add a description of a component needed to fetch the composite dataset.

Parameters
----------
id : string
    The name of the component in the policy definition.
datasetType : string
    The name of the datasetType of the component.
setter : string or None
    The name of the function used to set this component into the python type that contains it.
    Specifying a setter is optional, use None if the setter won't be specified or used.
getter : string or None
    The name of the function used to get this component from the python type that contains it.
    Specifying a setter is optional, use None if the setter won't be specified or used.
subset : bool
    If true, indicates that the obj should be a list of objects found via butlerSubset.
inputOnly : bool
    If true, indicates that the obj should not be serialized when performing a butler.put.

Definition at line 112 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerComposite.getPythonType (   self)

Definition at line 145 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerComposite.getRepository (   self)

Definition at line 142 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerComposite.setRepository (   self,
  repository 
)

Definition at line 139 of file butlerLocation.py.

Member Data Documentation

lsst.daf.persistence.butlerLocation.ButlerComposite.assembler

Definition at line 104 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerComposite.componentInfo

Definition at line 109 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerComposite.dataId

Definition at line 107 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerComposite.disassembler

Definition at line 105 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerComposite.mapper

Definition at line 108 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerComposite.python

Definition at line 106 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerComposite.repository

Definition at line 110 of file butlerLocation.py.


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