Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1# This file is part of daf_butler. 

2# 

3# Developed for the LSST Data Management System. 

4# This product includes software developed by the LSST Project 

5# (http://www.lsst.org). 

6# See the COPYRIGHT file at the top-level directory of this distribution 

7# for details of code ownership. 

8# 

9# This program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <http://www.gnu.org/licenses/>. 

21 

22__all__ = [ 

23 "CollectionType", 

24] 

25 

26import enum 

27 

28 

29class CollectionType(enum.IntEnum): 

30 """Enumeration used to label different types of collections. 

31 """ 

32 

33 RUN = 1 

34 """A ``RUN`` collection (also just called a 'run') is the initial 

35 collection a dataset is inserted into and the only one it can never be 

36 removed from. 

37 

38 Within a particular run, there may only be one dataset with a particular 

39 dataset type and data ID. 

40 """ 

41 

42 TAGGED = 2 

43 """Datasets can be associated with and removed from ``TAGGED`` collections 

44 arbitrarily. 

45 

46 Within a particular tagged collection, there may only be one dataset with 

47 a particular dataset type and data ID. 

48 """ 

49 

50 CHAINED = 3 

51 """A ``CHAINED`` collection is simply an ordered list of other collections 

52 to be searched. These may include other ``CHAINED`` collections. 

53 """