lsst.daf.persistence  13.0-17-gd5d205a+2
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.daf.persistence.butlerLocation.ButlerLocation Class Reference
Inheritance diagram for lsst.daf.persistence.butlerLocation.ButlerLocation:

Public Member Functions

def __repr__
 
def __init__
 
def __str__
 
def setRepository
 
def getRepository
 
def getPythonType
 
def getCppType
 
def getStorageName
 
def getLocations
 
def getLocationsWithRoot
 
def getAdditionalData
 
def getStorage
 

Static Public Member Functions

def to_yaml
 
def from_yaml
 

Public Attributes

 pythonType
 
 cppType
 
 storageName
 
 mapper
 
 storage
 
 locationList
 
 additionalData
 
 dataId
 
 usedDataId
 
 datasetType
 
 repository
 

Static Public Attributes

string yaml_tag = u"!ButlerLocation"
 
 yaml_loader = yaml.Loader
 
 yaml_dumper = yaml.Dumper
 

Detailed Description

ButlerLocation is a struct-like class that holds information needed to
persist and retrieve an object using the LSST Persistence Framework.

Mappers should create and return ButlerLocations from their
map_{datasetType} methods.

Parameters
----------
pythonType - string or class instance
    This is the type of python object that should be created when reading the location.

cppType - string or None
    The type of cpp object represented by the location (optional, may be None)

storageName - string
    The type of storage the object is in or should be place into.

locationList - list of string
    A list of URI to place the object or where the object might be found. (Typically when reading the
    length is expected to be exactly 1).

dataId - dict
    The dataId that was passed in when mapping the location. This may include keys that were not used for
    mapping this location.

mapper - mapper class instance
    The mapper object that mapped this location.

storage - storage class instance
    The storage interface that can be used to read or write this location.

usedDataId - dict
    The dataId components that were used to map this location. If the mapper had to look up keys those
    will be in this dict (even though they may not appear in the dataId parameter). If the dataId
    parameter contained keys that were not required to map this item then those keys will NOT be in this
    parameter.

datasetType - string
    The datasetType that this location represents.

Definition at line 157 of file butlerLocation.py.

Constructor & Destructor Documentation

def lsst.daf.persistence.butlerLocation.ButlerLocation.__init__ (   self,
  pythonType,
  cppType,
  storageName,
  locationList,
  dataId,
  mapper,
  storage,
  usedDataId = None,
  datasetType = None 
)

Definition at line 211 of file butlerLocation.py.

Member Function Documentation

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

Definition at line 203 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.__str__ (   self)

Definition at line 226 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.from_yaml (   loader,
  node 
)
static

Definition at line 245 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.getAdditionalData (   self)

Definition at line 270 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.getCppType (   self)

Definition at line 258 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.getLocations (   self)

Definition at line 264 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.getLocationsWithRoot (   self)

Definition at line 267 of file butlerLocation.py.

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

Definition at line 255 of file butlerLocation.py.

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

Definition at line 252 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.getStorage (   self)

Definition at line 273 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.getStorageName (   self)

Definition at line 261 of file butlerLocation.py.

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

Definition at line 249 of file butlerLocation.py.

def lsst.daf.persistence.butlerLocation.ButlerLocation.to_yaml (   dumper,
  obj 
)
static
Representer for dumping to YAML
:param dumper:
:param obj:
:return:

Definition at line 232 of file butlerLocation.py.

Member Data Documentation

lsst.daf.persistence.butlerLocation.ButlerLocation.additionalData

Definition at line 219 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.cppType

Definition at line 214 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.dataId

Definition at line 222 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.datasetType

Definition at line 224 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.locationList

Definition at line 218 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.mapper

Definition at line 216 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.pythonType

Definition at line 213 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.repository

Definition at line 250 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.storage

Definition at line 217 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.storageName

Definition at line 215 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.usedDataId

Definition at line 223 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.yaml_dumper = yaml.Dumper
static

Definition at line 201 of file butlerLocation.py.

lsst.daf.persistence.butlerLocation.ButlerLocation.yaml_loader = yaml.Loader
static

Definition at line 200 of file butlerLocation.py.

string lsst.daf.persistence.butlerLocation.ButlerLocation.yaml_tag = u"!ButlerLocation"
static

Definition at line 199 of file butlerLocation.py.


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