lsst.daf.persistence
13.0-28-gf70af18
|
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 | |
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 160 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.__init__ | ( | self, | |
pythonType, | |||
cppType, | |||
storageName, | |||
locationList, | |||
dataId, | |||
mapper, | |||
storage, | |||
usedDataId = None , |
|||
datasetType = None |
|||
) |
Definition at line 214 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.__repr__ | ( | self | ) |
Definition at line 206 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.__str__ | ( | self | ) |
Definition at line 229 of file butlerLocation.py.
|
static |
Definition at line 248 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getAdditionalData | ( | self | ) |
Definition at line 273 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getCppType | ( | self | ) |
Definition at line 261 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getLocations | ( | self | ) |
Definition at line 267 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getLocationsWithRoot | ( | self | ) |
Definition at line 270 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getPythonType | ( | self | ) |
Definition at line 258 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getRepository | ( | self | ) |
Definition at line 255 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getStorage | ( | self | ) |
Definition at line 276 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.getStorageName | ( | self | ) |
Definition at line 264 of file butlerLocation.py.
def lsst.daf.persistence.butlerLocation.ButlerLocation.setRepository | ( | self, | |
repository | |||
) |
Definition at line 252 of file butlerLocation.py.
|
static |
Representer for dumping to YAML :param dumper: :param obj: :return:
Definition at line 235 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.additionalData |
Definition at line 222 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.cppType |
Definition at line 217 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.dataId |
Definition at line 225 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.datasetType |
Definition at line 227 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.locationList |
Definition at line 221 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.mapper |
Definition at line 219 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.pythonType |
Definition at line 216 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.repository |
Definition at line 253 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.storage |
Definition at line 220 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.storageName |
Definition at line 218 of file butlerLocation.py.
lsst.daf.persistence.butlerLocation.ButlerLocation.usedDataId |
Definition at line 226 of file butlerLocation.py.
|
static |
Definition at line 204 of file butlerLocation.py.
|
static |
Definition at line 203 of file butlerLocation.py.
|
static |
Definition at line 202 of file butlerLocation.py.