LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
butlerLocation.py
Go to the documentation of this file.
1 #!/usr/bin/env python
2 
3 #
4 # LSST Data Management System
5 # Copyright 2008, 2009, 2010 LSST Corporation.
6 #
7 # This product includes software developed by the
8 # LSST Project (http://www.lsst.org/).
9 #
10 # This program is free software: you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation, either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the LSST License Statement and
21 # the GNU General Public License along with this program. If not,
22 # see <http://www.lsstcorp.org/LegalNotices/>.
23 #
24 
25 
26 """This module defines the ButlerLocation class."""
27 
28 import lsst.daf.base as dafBase
29 
30 class ButlerLocation(object):
31  """ButlerLocation is a struct-like class that holds information needed to
32  persist and retrieve an object using the LSST Persistence Framework.
33 
34  Mappers should create and return ButlerLocations from their
35  map_{datasetType} methods."""
36 
37  def __init__(self, pythonType, cppType, storageName, locationList, dataId):
38  self.pythonType = pythonType
39  self.cppType = cppType
40  self.storageName = storageName
41  if hasattr(locationList, '__iter__'):
42  self.locationList = locationList
43  else:
44  self.locationList = [locationList]
46  for k, v in dataId.iteritems():
47  self.additionalData.set(k, v)
48 
49  def __str__(self):
50  s = "%s at %s(%s)" % (self.pythonType, self.storageName,
51  ", ".join(self.locationList))
52  return s
53 
54  def getPythonType(self):
55  return self.pythonType
56 
57  def getCppType(self):
58  return self.cppType
59 
60  def getStorageName(self):
61  return self.storageName
62 
63  def getLocations(self):
64  return self.locationList
65 
66  def getAdditionalData(self):
67  return self.additionalData
Class for storing generic metadata.
Definition: PropertySet.h:82